Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(): add cspell and fix spelling errors #3069

Merged
merged 33 commits into from
Sep 25, 2023
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
da7593c
chore: add cspell with custom allowed words
brandyscarney Aug 4, 2023
148d8f0
docs(content): update to pass spellcheck
brandyscarney Aug 4, 2023
d8afc6b
Merge branch 'main' into style-add-spellcheck
brandyscarney Sep 21, 2023
32963ce
chore(cspell): include more markdown files to lint while excluding na…
brandyscarney Sep 21, 2023
4c0fc7b
syle: spellcheck lint
brandyscarney Sep 21, 2023
3664357
style: fix broken link
brandyscarney Sep 21, 2023
5ccc1ae
style: more broken links
brandyscarney Sep 21, 2023
ad015f5
style: undo api name change
brandyscarney Sep 21, 2023
a88f0e3
chore: bump cspell
brandyscarney Sep 21, 2023
c12ff85
style: lint
brandyscarney Sep 21, 2023
5565391
chore: add spellcheck to CI
brandyscarney Sep 21, 2023
3f2b546
style: fix improper comment styles for cspell
brandyscarney Sep 21, 2023
0bd13f0
style: lint
brandyscarney Sep 21, 2023
f5d6a91
make it fail
brandyscarney Sep 21, 2023
dbb4d5d
Revert "make it fail"
brandyscarney Sep 21, 2023
5cbbd19
Merge branch 'main' into style-add-spellcheck
brandyscarney Sep 22, 2023
fb322f3
style: add interactives to wordlist
brandyscarney Sep 22, 2023
d220efb
Merge branch 'main' into style-add-spellcheck
brandyscarney Sep 22, 2023
a58bc90
chore(cspell): remove words that are in filenames and improve regex f…
brandyscarney Sep 22, 2023
4875771
Merge branch 'main' into style-add-spellcheck
brandyscarney Sep 22, 2023
1e0f260
chore(cspell): wrap datetime formats in code ticks
brandyscarney Sep 22, 2023
14fae4e
chore(cspell): group and alphabetize product names
brandyscarney Sep 22, 2023
bf865f2
docs(slides): update tables to format code
brandyscarney Sep 22, 2023
3216673
docs(input): wrap keyboard events in code formatting
brandyscarney Sep 22, 2023
c31477b
docs(theming): wrap "rgba" in code formatting
brandyscarney Sep 22, 2023
9163514
chore(cspell): improve regex to match anything in code ticks
brandyscarney Sep 22, 2023
8fef62a
chore(cspell): add flagged words for the since cspell doesn't run aga…
brandyscarney Sep 22, 2023
db37889
docs(contributing): add notes on running spellcheck
brandyscarney Sep 22, 2023
cfda51f
chore(CI): update spell check to two words
brandyscarney Sep 22, 2023
ace2caf
style: formatting
brandyscarney Sep 22, 2023
c5e258f
style: formatting
brandyscarney Sep 22, 2023
b5d9054
style: lint
brandyscarney Sep 22, 2023
54480ff
style: remove comments
brandyscarney Sep 25, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ jobs:
run: npm ci --legacy-peer-deps
- name: Lint
run: npm run lint
# Lint changes should be pushed
# to the branch before the branch
# is merge eligible.
- name: Spellcheck
run: npm run spellcheck
averyjohnston marked this conversation as resolved.
Show resolved Hide resolved
# Lint and spellcheck changes should be pushed
# to the branch before the branch is merge eligible.
- name: Check Diff
run: git diff --exit-code
shell: bash
16 changes: 2 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ We use Crowdin for our translation service. You can participate in the translati

_Please submit translation issues to the Crowdin page and not the Ionic Docs GitHub repo._

<!-- cspell:disable-next-line -->

The Japanese translation of the docs were built by an independent team, lead by [rdlabo](https://github.com/rdlabo) and can be found and contributed to on the [ionic-jp group's `ionic-docs` project page](https://github.com/ionic-jp/ionic-docs).

## Reporting Issues
Expand All @@ -110,20 +112,6 @@ When submitting pull requests, please keep the scope of your change contained to

---

<!-- ## Project Management

Internally, the Ionic documentation team uses a [project board](https://github.com/ionic-team/ionic-docs/projects/3) to plan work on the docs. The lanes on the board are:

- **Backlog** :file_cabinet: - Issues we plan to address, generally sorted by urgency
- **On Deck** :baseball: - Issues to be addressed during the current sprint, pulled from backlog during sprint planning
- **In Progress** :hammer: - Assigned issues that are currently being addressed
- **Needs Review** :mag: - Pull requests and issues that have a pending review
- **Done** :tada: - Issues that have been resolved

If you're looking for issues to help out with, we'd recommend either asking about an issue in the backlog or checking for issues labeled [`help-wanted`](https://github.com/ionic-team/ionic-docs/labels/help%20wanted).

--- -->

## Deploying

The Ionic documentation's `main` branch is deployed automatically and separately from the [Ionic site](https://github.com/ionic-team/ionic-site) itself. The Ionic site then uses a proxy for paths under `/docs` to request the deployed documentation.
Expand Down
103 changes: 103 additions & 0 deletions cspell-wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
Appflow
Ionicon
Ionicons

actionsheet
fabs
datetime
datetimes
datetimepicker
infinitescroll
searchbar
searchbars
sidemenu
textarea
textareas

Codepen
Firestore
Genymotion
Hygen
Logcat
Maskito
Pluralsight
Swiper
Udemy
Vetur
Wistia

appstore
authed
autocrlf
autogrow
automations
autoplay
comparewith
composables
engageable
flexbox
frontmatter
fullscreen
geolocation
interactives
isopen
jank
janky
jarsigner
jsdelivr
keytool
lifecycles
localstorage
mobileweb
phablet
playstore
preconfigured
preflighted
proxying
quickstart
retargeted
runtimes
scroller
subcomponent
subcomponents
swipeable
templating
transpiling
treeshaking
triaging
typeahead
unminified
unsanitized
viewports
webapps
webviews
xlarge
xsmall
zipalign

allowtransparency
mozallowfullscreen
msallowfullscreen
oallowfullscreen
webkitallowfullscreen

doubletap
keydown
keyframes
keypress
keyup
reachbeginning
reachend
slidechangetransitionend
slidechangetransitionstart
slidenexttransitionend
slidenexttransitionstart
slideprevtransitionend
slideprevtransitionstart
slidermove
touchend
touchstart
transitionend
transitionstart

rgba
22 changes: 22 additions & 0 deletions cspell.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"dictionaries": ["custom-words"],
"dictionaryDefinitions": [
{
"name": "custom-words",
"path": "./cspell-wordlist.txt",
"addWords": true
}
],
"ignoreRegExpList": [
"/(```+)[\\s\\S]+?\\1/g", // Ignore all words inside of code blocks
brandyscarney marked this conversation as resolved.
Show resolved Hide resolved
"/`[a-zA-Z-_.@:\/]+`/g", // Ignore all words inside of code ticks, including file names
"/:[a-zA-Z0-9-_\\+]+:/g" // Ignore all emojis e.g. :tada:
],
"ignorePaths": [
"docs/cli",
"docs/native",
"versioned_docs/**/api",
"versioned_docs/**/cli",
"versioned_docs/**/native"
]
}
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The `/docs` folder houses all markdown files. The page structure loosely maps to

## Versioning

This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/verion-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files.
This folder can also contain components, assets, and whatever else is meant to be versioned when the docusaurus versioning script is run. For example, if there is a page component that is only relevant to the `layout` section in the current version of Ionic, it could be added to a `_components/` folder in `docs/layout/`. When the versioning script is run, the component will be copied to `versioned_docs/version-{X}/layout/_components/` and there will now be a separate component in `docs/layout/_components/` that can be deleted or updated to the latest version. The same concept applies to images and other files.

If components are meant to be shared across versions, they can be put in `src/components/`. If images and other served files are meant to be shared across versions they can be put in `static/`.

Expand Down
4 changes: 4 additions & 0 deletions docs/angular/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ For more information on how Angular manages change propagation with `ngFor` see

## From the Community

<!-- cspell:disable -->

[High Performance Animations in Ionic](https://www.joshmorony.com/high-performance-animations-in-ionic/) - Josh Morony

[High Performance List Filtering in Ionic](https://www.joshmorony.com/high-performance-list-filtering-in-ionic-2/) - Josh Morony
Expand All @@ -64,6 +66,8 @@ For more information on how Angular manages change propagation with `ngFor` see

[Ionic Framework is Fast (But Your Code Might Not Be)](https://www.joshmorony.com/ionic-framework-is-fast-but-your-code-might-not-be/) - Josh Morony

<!-- cspell:enable -->

:::note
Do you have a guide you'd like to share? Click the _Edit this page_ button below.
:::
2 changes: 1 addition & 1 deletion docs/angular/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -293,7 +293,7 @@ When an `@ionic/angular` application is generated, a default end-to-end test app

- `protractor.conf.js` - the Protractor configuration file
- `tsconfig.e2e.json` - specific TypeScript configuration for the testing application
- `src/app.po.ts` - a page object containing methods that navigate the application, query elements in the DOM, and maninpulate elements on the page
- `src/app.po.ts` - a page object containing methods that navigate the application, query elements in the DOM, and manipulate elements on the page
- `src/app.e2e-spec.ts` - a testing script

#### Page Objects
Expand Down
4 changes: 2 additions & 2 deletions docs/angular/your-first-app/8-distribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For more on connecting your code repository to Appflow, checkout the [Connect yo

The Appflow SDK (also known as Ionic Deploy plugin) will allow you to take advantage of arguably two of the best Appflow features: deploying live updates to your app and bypassing the app stores. Ionic Appflow's Live Update feature is shipped with Appflow SDK and features the capabilities of detecting and syncing the updates for your app that you have pushed to your identified channels within the dashboard.

To get the Appflow SDK plugin added to your project, you can follow the install instructions within the Appflow Dashboard by clicking on "Install Instructions" inside of the `Deploy > Destinations` section. Alternatively, you can install the plugin manually by excuting the following command in your app's root directory:
To get the Appflow SDK plugin added to your project, you can follow the install instructions within the Appflow Dashboard by clicking on "Install Instructions" inside of the `Deploy > Destinations` section. Alternatively, you can install the plugin manually by executing the following command in your app's root directory:

```shell
ionic deploy add \
Expand Down Expand Up @@ -75,7 +75,7 @@ For more information, visit the [Create an Automation](https://ionic.io/docs/app

## Create an Environment

[Package builds](https://ionic.io/docs/appflow/package/builds) and [Deploy builds](https://ionic.io/docs/appflow/deploy/builds) can be futher customized via [Environments](https://ionic.io/docs/appflow/automation/environments). This powerful feature allows you to create different configurations based on the environment variables passed in at build time. When combined with the [Automation](https://ionic.io/docs/appflow/automation/intro) feature, development teams can easily configure development, staging, and production build configurations, allowing them to embrace DevOps best practices and ship better quality updates faster than ever.
[Package builds](https://ionic.io/docs/appflow/package/builds) and [Deploy builds](https://ionic.io/docs/appflow/deploy/builds) can be further customized via [Environments](https://ionic.io/docs/appflow/automation/environments). This powerful feature allows you to create different configurations based on the environment variables passed in at build time. When combined with the [Automation](https://ionic.io/docs/appflow/automation/intro) feature, development teams can easily configure development, staging, and production build configurations, allowing them to embrace DevOps best practices and ship better quality updates faster than ever.

Creating an Environment is available for those on our [Basic plans](https://ionic.io/pricing) and above. More information on this can be found in the [Create an Environment](https://ionic.io/docs/appflow/quickstart/environment) section within the Appflow docs.

Expand Down
20 changes: 10 additions & 10 deletions docs/api/datetime.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ parse various datetime strings differently, especially per locale.
Fortunately, Ionic Framework's datetime input has been designed so developers can avoid
the common pitfalls, allowing developers to easily manipulate datetime values and give the user a simple datetime picker for a great user experience.

### ISO 8601 Datetime Format: YYYY-MM-DDTHH:mmZ
### ISO 8601 Datetime Format: `YYYY-MM-DDTHH:mmZ`

Ionic Framework uses the [ISO 8601 datetime format](https://www.w3.org/TR/NOTE-datetime)
for its value. The value is simply a string, rather than using JavaScript's
Expand All @@ -71,15 +71,15 @@ and parse within JSON objects and databases.

Below are some examples of ISO 8601 formats that can be used with `ion-datetime`:

| Description | Format | Datetime Value Example |
| -------------------- | ---------------------- | ---------------------------- |
| Year | YYYY | 1994 |
| Year and Month | YYYY-MM | 1994-12 |
| Complete Date | YYYY-MM-DD | 1994-12-15 |
| Date and Time | YYYY-MM-DDTHH:mm | 1994-12-15T13:47 |
| UTC Timezone | YYYY-MM-DDTHH:mm:ssZ | 1994-12-15T13:47:20Z |
| Timezone Offset | YYYY-MM-DDTHH:mm:ssTZD | 1994-12-15T13:47:20+05:00 |
| Hour and Minute | HH:mm | 13:47 |
| Description | Format | Datetime Value Example |
| -------------------- | ------------------------ | ------------------------------ |
| Year | `YYYY` | `1994` |
| Year and Month | `YYYY-MM` | `1994-12` |
| Complete Date | `YYYY-MM-DD` | `1994-12-15` |
| Date and Time | `YYYY-MM-DDTHH:mm` | `1994-12-15T13:47` |
| UTC Timezone | `YYYY-MM-DDTHH:mm:ssZ` | `1994-12-15T13:47:20Z` |
| Timezone Offset | `YYYY-MM-DDTHH:mm:ssTZD` | `1994-12-15T13:47:20+05:00` |
| Hour and Minute | `HH:mm` | `13:47` |

Note that the year is always four-digits, milliseconds (if it's added) is always
three-digits, and all others are always two-digits. So the number representing
Expand Down
2 changes: 1 addition & 1 deletion docs/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ Ionic apps are made of high-level building blocks called Components, which allow
</DocsCard>

<DocsCard header="Toast" href="api/toast" icon="/icons/component-toast-icon.png">
<p>Toast is used to show a notification over the top of an app's content. It can be temporary or dismissable.</p>
<p>Toast is used to show a notification over the top of an app's content. It can be temporary or dismissible.</p>
</DocsCard>

<DocsCard header="Toggle" href="api/toggle" icon="/icons/component-toggle-icon.png">
Expand Down
4 changes: 4 additions & 0 deletions docs/core-concepts/what-are-progressive-web-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,16 @@ To be considered a Progressive Web App, your app must be:

- Linkable - Easily share via URL and not require complex installation.

<!-- cspell:disable -->

<em>
<a href="https://addyosmani.com/blog/getting-started-with-progressive-web-apps/" target="_blank">
Addy Osmani: Progressive web apps
</a>
</em>

<!-- cspell:enable -->

There is a lot here, but it boils down to a few points for Ionic apps.

#### Offline Support
Expand Down
22 changes: 22 additions & 0 deletions docs/developer-resources/books.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,50 +4,72 @@

Angular. Vue. React. Vanilla JavaScript. All of these tools can be used to create awesome applications with Ionic, thanks to the new Stencil compiler. This book is aimed at beginners that are looking to create amazing web, mobile and desktop applications using Ionic with examples across all of the popular frameworks.

<!-- cspell:disable-next-line -->

by [Paul Halliday](https:://developer.school)

### [Creating Ionic Applications with StencilJS](https://www.joshmorony.com/creating-ionic-applications-with-stencil-js/) - [Free Preview](https://cdn2.hubspot.net/hubfs/3776657/PREVIEW-Creating-Ionic-Apps-with-StencilJS.pdf)

As well as being a powerful tool for generating reuseable web components, StencilJS provides the tools needed to build an entire application out of web components. Combined with the Ionic web components, StencilJS gives us everything we need to build high-quality production mobile applications - no framework required.

<!-- cspell:disable-next-line -->

by [Joshua Morony](https://www.joshmorony.com/blog)

### [Mobile App Development with Ionic: Cross-Platform Apps with Ionic 2, Angular 2, and Cordova](https://www.amazon.com/Mobile-App-Development-Ionic-Cross-Platform/dp/1491937785/ref=sr_1_2?ie=UTF8&qid=1464183332&sr=8-2&keywords=ionic+2)

<!-- cspell:disable-next-line -->

by Chris Griffith

### [Building Mobile Apps with Ionic & Angular](https://www.joshmorony.com/building-mobile-apps-with-ionic-2/)

<!-- cspell:disable-next-line -->

by [Joshua Morony](https://www.joshmorony.com/blog)

Building Mobile Apps with Ionic & Angular is an all-in-one resource for learning the latest and greatest version of Ionic. It is targeted at beginners and works its way through the basics of Ionic, to example applications of varying complexity, and then to the steps required to build and publish your application (on the app stores or as a PWA). It has been updated for every major release, so you can rest easy knowing that you're not learning outdated tech.

### [Ionic 2 From Zero to App Store](https://devdactic.com/zero-to-app)

<!-- cspell:disable-next-line -->

by Simon Reimler

### [Ionic Framework By Example](https://www.packtpub.com/application-development/ionic-framework-example)

<!-- cspell:disable-next-line -->

by Sani Yusuf

### [Building Firestore Powered Ionic Apps](https://javebratt.com/ionic-firebase-book/)

<!-- cspell:disable-next-line -->

by Jorge Vergara

This book will help you go from not knowing what Firebase is to be able to use the different APIs for your Ionic Applications. It will take you from “_What’s Firebase?_” to building scalable, production-ready apps and it’s always up-to-date with latest Ionic and Firebase versions.

### [Ionic 2 Cookbook - Second Edition](https://www.amazon.com/Ionic-Cookbook-Second-Hoc-Phan-ebook/dp/B01C4D9VWS?ie=UTF8&keywords=ionic%202&qid=1464183332&ref_=sr_1_3&sr=8-3)

<!-- cspell:disable-next-line -->

by Hoc Phan

### [Mastering Ionic 2](https://www.leanpub.com/masteringionic2)

<!-- cspell:disable-next-line -->

by James Griffiths

### [Learning Ionic](https://www.packtpub.com/in/application-development/learning-ionic) (Ionic 1)

<!-- cspell:disable-next-line -->

by Arvind Ravulavaru

### [Learning Ionic - Second Edition](https://www.packtpub.com/in/web-development/learning-ionic-second-edition) (Ionic 2/3)

<!-- cspell:disable-next-line -->

by Arvind Ravulavaru
Loading
Loading