-
-
Notifications
You must be signed in to change notification settings - Fork 84
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
112 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <!--- @@inject: ../../../README.md ---> | ||
|
|
||
| # CSpell | ||
|
|
||
| [](https://github.com/streetsidesoftware/cspell/actions) | ||
| [](https://github.com/streetsidesoftware/cspell/actions) | ||
| [](https://github.com/streetsidesoftware/cspell/actions) | ||
| [](https://github.com/streetsidesoftware/cspell/actions) | ||
|
|
||
| [](https://codecov.io/gh/streetsidesoftware/cspell) | ||
| [](https://coveralls.io/github/streetsidesoftware/cspell) | ||
|
|
||
| The CSpell mono-repo, a spell checker for code. | ||
|
|
||
| ## Support Future Development | ||
|
|
||
| - [](https://github.com/sponsors/streetsidesoftware) | ||
| - [](https://patreon.com/streetsidesoftware) | ||
| - [](https://www.paypal.com/donate/?hosted_button_id=26LNBP2Q6MKCY) | ||
| - [](https://opencollective.com/cspell) | ||
|
|
||
| ## Documentation | ||
|
|
||
| [Documentation - CSpell](https://streetsidesoftware.github.io/cspell/) | ||
|
|
||
| ## Third-Party Video Presentations | ||
|
|
||
| Some videos related to CSpell and the [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) for VS Code. | ||
|
|
||
| - [Spell Checking Documentation in DevOps Pipelines](https://www.youtube.com/watch?v=w8gGi3aeVpc) by Houssem Dellai | ||
| - [Don't Worry About Spelling...VS Code Can Do It For You!!](https://www.youtube.com/watch?v=MfxFMFMsBP4) by [James Q Quick](https://www.youtube.com/@JamesQQuick) | ||
| - [Spell Checking In VSCode - VSCode Pro Tips](https://www.youtube.com/watch?v=_GwpPJgH1Gw) | ||
| - [Spell Check in VS Code with Code Spell Checker | Extension Highlight](https://www.youtube.com/watch?v=ZxNnOjWetH4) | ||
| - [Spell check your code from the command line with Cspell](https://www.youtube.com/watch?v=nwmJ9h_zPJc) | ||
| - [How to Use VS Code Spell Checker](https://www.youtube.com/watch?v=Ix5bMd0kZeY) - Detailed walkthrough to setup and use multiple languages | ||
| - [Code Spell Checker Extension for Visual Studio Code](https://www.youtube.com/watch?v=dUn1mrJYMrM) | ||
|
|
||
| ## Packages | ||
|
|
||
| - [cspell](packages/cspell) [](https://openbase.com/js/cspell?utm_source=embedded&utm_medium=badge&utm_campaign=verified-badge&utm_term=js/cspell) -- cspell command-line application | ||
| - [@cspell/eslint-plugin](packages/cspell-eslint-plugin) [](https://openbase.com/js/@cspell/eslint-plugin?utm_source=embedded&utm_medium=badge&utm_campaign=rate-badge) -- CSpell ESLint Plugin | ||
| - [cspell-bundled-dicts](packages/cspell-bundled-dicts) -- collection of dictionaries bundled with cspell. | ||
| - [cspell-glob](packages/cspell-glob) -- glob library. | ||
| - [cspell-io](packages/cspell-io) -- i/o library. | ||
| - [cspell-lib](packages/cspell-lib) -- cspell library used for code driven spelling checking (used by the application). | ||
| - [cspell-types](packages/cspell-types) -- cspell types and JSON schema for cspell configuration files. | ||
| - [cspell-tools](packages/cspell-tools) -- tool used to compile dictionaries. | ||
| - [cspell-trie-lib](packages/cspell-trie-lib) -- trie data structure used to store words. | ||
| - [cspell-trie](packages/cspell-trie) -- trie data tool used to store words. | ||
| - [hunspell-reader](packages/hunspell-reader) -- reads Hunspell files and outputs words. | ||
|
|
||
| ## Related Packages | ||
|
|
||
| - [cspell-cli](https://github.com/streetsidesoftware/cspell-cli) -- `cspell-cli` is useful for including `cspell` directly from GitHub. | ||
|
|
||
| Example install: `npm install -g git+https://github.com/streetsidesoftware/cspell-cli`. | ||
|
|
||
| This will add the `cspell-cli` command, which is an alias of the `cspell` command. | ||
|
|
||
| ## RFCs | ||
|
|
||
| | Link | Description | Status | | ||
| | -------------------------------------------------------------- | ------------------------------- | ----------- | | ||
| | [rfc-0001](rfc/rfc-0001%20suggestions/) | Fixing common misspellings | Not started | | ||
| | [rfc-0002](rfc/rfc-0002%20improve%20dictionary%20suggestions/) | Improving Generated Suggestions | Done | | ||
| | [rfc-0003](rfc/rfc-0003%20parsing%20files/) | Plug-ins: Adding file parsers | In Progress | | ||
| | [rfc-0004](rfc/rfc-0004%20known%20issues/) | Support Marking Issues as Known | Not started | | ||
|
|
||
| ## CSpell for enterprise | ||
|
|
||
| Available as part of the Tidelift Subscription. | ||
|
|
||
| The maintainers of CSpell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) | ||
|
|
||
| ## Security contact information | ||
|
|
||
| To report a security vulnerability, please use the | ||
| [Tidelift security contact](https://tidelift.com/security). | ||
| Tidelift will coordinate the fix and disclosure. | ||
|
|
||
| ## Versions | ||
|
|
||
| | | version | Node | Status | Maintenance | End of Free Support | | ||
| | :----- | :------ | :------ | :--------------------------- | :---------- | :------------------ | | ||
| | cspell | 8.x | 18.x | In Active Development | TBD | TBD | | ||
| | cspell | 7.x | 16.x | Transitioning to Maintenance | 2023-10-01 | 2023-11-01 | | ||
| | cspell | 6.x | 14.14.x | Paid support only[^1] | 2023-04-01 | 2023-05-01 | | ||
| | cspell | 5.x | 12.x | Paid support only[^1] | - | 2022-10-01 | | ||
| | cspell | 4.x | 10.x | Paid support only[^1] | - | 2022-05-01 | | ||
|
|
||
| [^1]: [Support - Street Side Software](https://streetsidesoftware.com/support/#maintenance-agreements) | ||
|
|
||
| <br/> | ||
|
|
||
| --- | ||
|
|
||
| <p align="center"> | ||
| Brought to you by <a href="https://streetsidesoftware.com" title="Street Side Software"> | ||
| <img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software | ||
| </a> | ||
| </p> | ||
|
|
||
| <!--- | ||
| cspell:ignore Houssem Dellai | ||
| ---> | ||
|
|
||
| <!--- @@inject-end: ../../../README.md ---> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -155,4 +155,4 @@ cspell lint --help | |
|
|
||
| ### Options | ||
|
|
||
| {% include_relative help-lint.md %} | ||
| {% include generated-docs/help-lint.md %} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters