can we spellcheck?

ionic-team · Jul 31, 2023 · 660cbf7 · 660cbf7
1 parent 6c1304c
commit 660cbf7
Show file tree

Hide file tree

Showing 15 changed files with 170 additions and 17 deletions.
diff --git a/.github/workflows/check-spelling.yml b/.github/workflows/check-spelling.yml
@@ -0,0 +1,15 @@
+name: Check Spelling
+
+on:
+  pull_request:
+    branches:
+      - '**'
+
+jobs:
+  check-spelling:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+
+    - name: Spellcheck
+      uses: rojopolis/[email protected]
diff --git a/.pyspelling.yaml b/.pyspelling.yaml
@@ -0,0 +1,20 @@
+matrix:
+- name: Markdown
+  aspell:
+    lang: en
+  dictionary:
+    wordlists:
+    - .wordlist.txt
+    encoding: utf-8
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - pymdownx.superfences:
+  - pyspelling.filters.html:
+      comments: false
+      ignores:
+      - code
+      - pre
+  sources:
+  - '**/*.md'
+  default_encoding: utf-8
diff --git a/.wordlist.txt b/.wordlist.txt
@@ -0,0 +1,117 @@
+API
+APIs
+CLI
+CPU
+CPUs
+CSS
+DOM
+ESLint
+GitHub
+IDE
+IDEs
+Ionicons
+JSON
+JSX
+LCP
+LTS
+MDN
+Minify
+NodeJS
+PWA
+PWAs
+Prerender
+README
+SEO
+SPA
+SPAs
+SSG
+SSR
+SourceMaps
+Sourcemaps
+TSX
+serializable
+TypeScript
+minifying
+transpile
+transpiles
+transpiling
+CDN
+TypeScript's
+proxied
+UI
+UX
+TSLint
+minimalistic
+CommonJS
+autocompletion
+VCS
+VDom
+Vite
+api
+api
+apis
+async
+backend
+boolean
+bundler
+bundlers
+cli
+codebase
+config
+contentful
+css
+dev
+dir
+expressjs
+focusable
+frontend
+getter
+getters
+html
+https
+inlined
+js
+lifecycle
+lifecycles
+minified
+minify
+monorepo
+namespace
+natively
+npm
+param
+params
+polyfill
+polyfilled
+polyfills
+preload
+prerender
+prerendered
+prerendering
+prerenders
+programmatically
+reflows
+renderer
+repo
+rerender
+roadmap
+rollup
+runtime
+setter
+sourcemaps
+stylesheet
+stylesheets
+subdirectory
+tada
+tradeoff
+tradeoffs
+triaged
+typings
+url
+url's
+usingtheplatform
+utils
+volta
+vue
+webpage
+whitespace
diff --git a/docs/config/extras.md b/docs/config/extras.md
@@ -13,11 +13,11 @@ polyfills, etc. For example, not all DOM APIs are fully polyfilled when using
 the Slot polyfill. Most of these are opt-in, since not all users require the
 additional runtime.
 
-### appendChildSlotFix
+### `appendChildSlotFix`
 
 By default, the slot polyfill does not update `appendChild()` so that it appends new child nodes into the correct child slot like how shadow dom works. This is an opt-in polyfill for those who need it.
 
-### cloneNodeFix
+### `cloneNodeFix`
 
 By default, the runtime does not polyfill `cloneNode()` when cloning a component that uses the slot polyfill. This is an opt-in polyfill for those who need it.
 
@@ -63,7 +63,7 @@ Users of this flag should note that they may see an increase in their bundle siz
 
 Defaults to `false`.
 
-### lifecycleDOMEvents
+### `lifecycleDOMEvents`
 
 Dispatches component lifecycle events. By default these events are not dispatched, but by enabling this to `true` these events can be listened for on `window`. Mainly used for testing.
 
@@ -86,4 +86,4 @@ It is possible to assign data to the actual `<script>` element's `data-opts` pro
 
 ### slotChildNodesFix
 
-For browsers that do not support shadow dom (IE11 and Edge 18 and below), slot is polyfilled to simulate the same behavior. However, the host element's `childNodes` and `children` getters are not patched to only show the child nodes and elements of the default slot. Defaults to `false`.
+For browsers that do not support shadow DOM (IE11 and Edge 18 and below), slot is polyfilled to simulate the same behavior. However, the host element's `childNodes` and `children` getters are not patched to only show the child nodes and elements of the default slot. Defaults to `false`.
diff --git a/docs/output-targets/dist.md b/docs/output-targets/dist.md
@@ -7,7 +7,7 @@ slug: /distribution
 
 # Distribution Output Target
 
-The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is treeshakable, ensuring that only imported components will end up in the build.
+The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is tree shakable, ensuring that only imported components will end up in the build.
 
 ```tsx
 outputTargets: [

diff --git a/docs/static-site-generation/prerender-config.md b/docs/static-site-generation/prerender-config.md
@@ -52,7 +52,7 @@ export const config: PrerenderConfig = {
 | `loadTemplate(filePath)` | Returns the template file's content. The template is the base HTML used for all prerendered pages. |  |
 | `normalizeUrl(href, base)` | Used to normalize the page's URL from a given a string and the current page's base URL. Largely used when reading an anchor's `href` attribute value and normalizing it into a `URL`. |  |
 | `staticSite` | Static Site Generated (SSG). Does not include Stencil's client-side JavaScript, custom elements or preload modules. | `false` |
-| `trailingSlash` | If the prerenndered URLs should have a trailing "/"" or not | `false` |
+| `trailingSlash` | If the prerendered URLs should have a trailing "/"" or not | `false` |
 
 
 ## Individual Page Hydrate Options

diff --git a/docs/telemetry.md b/docs/telemetry.md
@@ -17,7 +17,7 @@ However, qualitative conversations are only half the picture. To fully understan
 
 We track command line usage including commands and options. Specifically, we track the following anonymously:
 
-- Command invoked (eg: stencil generate, stencil build, etc) with arguments
+- Command invoked (e.g. `stencil generate`, `stencil build`, etc) with arguments
 - Versions of Stencil and other dependencies like TypeScript
 - Output targets
 - Stencil packages

diff --git a/versioned_docs/version-v2/introduction/upgrading-to-stencil-three.md b/versioned_docs/version-v2/introduction/upgrading-to-stencil-three.md
@@ -309,7 +309,7 @@ The `dist-custom-elements-bundle` has been removed starting with Stencil v3.0.0,
 Users of this output target should migrate to the `dist-custom-elements` output target.
 
 By default, `dist-custom-elements` does not automatically define all a project's component's with the CustomElementsRegistry.
-This allows for better treeshaking and smaller bundle sizes.
+This allows for better tree shaking and smaller bundle sizes.
 
 For teams that need to migrate quickly to `dist-custom-elements`, the following configuration should be close to a drop-in replacement for `dist-custom-elements-bundle`:
 ```diff
@@ -331,7 +331,7 @@ export const config: Config = {
   // ...
 };
 ```
-However, it does not necessarily improve treeshaking/bundle size.
+However, it does not necessarily improve tree shaking/bundle size.
 For more information on configuring this output target, please see the [`dist-custom-elements` documentation](../output-targets/custom-elements.md)
 
 ## Framework Integration Output Targets

diff --git a/versioned_docs/version-v2/output-targets/dist.md b/versioned_docs/version-v2/output-targets/dist.md
@@ -7,7 +7,7 @@ slug: /distribution
 
 # Distribution Output Target
 
-The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is treeshakable, ensuring that only imported components will end up in the build.
+The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is tree shakable, ensuring that only imported components will end up in the build.
 
 ```tsx
 outputTargets: [

diff --git a/versioned_docs/version-v2/static-site-generation/meta.md b/versioned_docs/version-v2/static-site-generation/meta.md
@@ -18,7 +18,8 @@ That said, the Prerender Config also includes options that allow individual page
 For example, the `afterHydrate(document, url)` hook can be used to update the parsed `document` before it is serialized into an HTML string.
 The `document` argument is a [standard `Document`](https://developer.mozilla.org/en-US/docs/Web/API/Document), while the `url` argument is a [`URL`](https://developer.mozilla.org/en-US/docs/Web/API/URL) for the location of the page being rendered.
 
-In the example below, the `afterHydrate(document, url)` hook is setting the document title from url's pathname.
+In the example below, the `afterHydrate(document, url)` hook is setting the
+document title from the url's `pathname`.
 
 ```tsx
 import { PrerenderConfig } from '@stencil/core';

diff --git a/versioned_docs/version-v2/static-site-generation/prerender-config.md b/versioned_docs/version-v2/static-site-generation/prerender-config.md
@@ -52,7 +52,7 @@ export const config: PrerenderConfig = {
 | `loadTemplate(filePath)` | Returns the template file's content. The template is the base HTML used for all prerendered pages. |  |
 | `normalizeUrl(href, base)` | Used to normalize the page's URL from a given a string and the current page's base URL. Largely used when reading an anchor's `href` attribute value and normalizing it into a `URL`. |  |
 | `staticSite` | Static Site Generated (SSG). Does not include Stencil's client-side JavaScript, custom elements or preload modules. | `false` |
-| `trailingSlash` | If the prerenndered URLs should have a trailing "/"" or not | `false` |
+| `trailingSlash` | If the prerendered URLs should have a trailing "/"" or not | `false` |
 
 
 ## Individual Page Hydrate Options

diff --git a/versioned_docs/version-v3/introduction/upgrading-to-stencil-three.md b/versioned_docs/version-v3/introduction/upgrading-to-stencil-three.md
@@ -309,7 +309,7 @@ The `dist-custom-elements-bundle` has been removed starting with Stencil v3.0.0,
 Users of this output target should migrate to the `dist-custom-elements` output target.
 
 By default, `dist-custom-elements` does not automatically define all a project's component's with the CustomElementsRegistry.
-This allows for better treeshaking and smaller bundle sizes.
+This allows for better tree shaking and smaller bundle sizes.
 
 For teams that need to migrate quickly to `dist-custom-elements`, the following configuration should be close to a drop-in replacement for `dist-custom-elements-bundle`:
 ```diff
@@ -331,7 +331,7 @@ export const config: Config = {
   // ...
 };
 ```
-However, it does not necessarily improve treeshaking/bundle size.
+However, it does not necessarily improve tree shaking/bundle size.
 For more information on configuring this output target, please see the [`dist-custom-elements` documentation](../output-targets/custom-elements.md)
 
 ## Framework Integration Output Targets

diff --git a/versioned_docs/version-v3/output-targets/dist.md b/versioned_docs/version-v3/output-targets/dist.md
@@ -7,7 +7,7 @@ slug: /distribution
 
 # Distribution Output Target
 
-The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is treeshakable, ensuring that only imported components will end up in the build.
+The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is tree shakable, ensuring that only imported components will end up in the build.
 
 ```tsx
 outputTargets: [

diff --git a/versioned_docs/version-v4.0/output-targets/dist.md b/versioned_docs/version-v4.0/output-targets/dist.md
@@ -7,7 +7,7 @@ slug: /distribution
 
 # Distribution Output Target
 
-The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is treeshakable, ensuring that only imported components will end up in the build.
+The `dist` type is to generate the component(s) as a reusable library that can be self-lazy loading, such as [Ionic](https://www.npmjs.com/package/@ionic/core). When creating a distribution, the project's `package.json` will also have to be updated. However, the generated bundle is tree shakable, ensuring that only imported components will end up in the build.
 
 ```tsx
 outputTargets: [

diff --git a/versioned_docs/version-v4.0/static-site-generation/prerender-config.md b/versioned_docs/version-v4.0/static-site-generation/prerender-config.md
@@ -52,7 +52,7 @@ export const config: PrerenderConfig = {
 | `loadTemplate(filePath)` | Returns the template file's content. The template is the base HTML used for all prerendered pages. |  |
 | `normalizeUrl(href, base)` | Used to normalize the page's URL from a given a string and the current page's base URL. Largely used when reading an anchor's `href` attribute value and normalizing it into a `URL`. |  |
 | `staticSite` | Static Site Generated (SSG). Does not include Stencil's client-side JavaScript, custom elements or preload modules. | `false` |
-| `trailingSlash` | If the prerenndered URLs should have a trailing "/"" or not | `false` |
+| `trailingSlash` | If the prerendered URLs should have a trailing "/"" or not | `false` |
 
 
 ## Individual Page Hydrate Options