@cspell/cspell-types
Advanced tools
@cspell/cspell-types - npm Package Compare versions
Comparing version 5.3.0-alpha.2 to 5.3.0-alpha.3
@@ -6,2 +6,13 @@ # Change Log | ||
| # [5.3.0-alpha.3](https://github.com/streetsidesoftware/cspell/compare/v5.3.0-alpha.2...v5.3.0-alpha.3) (2021-02-23) | ||
| ### Bug Fixes | ||
| * Improve reporting on files matching glob patterns. ([#994](https://github.com/streetsidesoftware/cspell/issues/994)) ([da991f9](https://github.com/streetsidesoftware/cspell/commit/da991f93a061c5b64ce437332c7107ef2ef89472)) | ||
| # [5.3.0-alpha.2](https://github.com/streetsidesoftware/cspell/compare/v5.3.0-alpha.1...v5.3.0-alpha.2) (2021-02-22) | ||
@@ -8,0 +19,0 @@ |
@@ -6,3 +6,3 @@ { | ||
| }, | ||
| "version": "5.3.0-alpha.2", | ||
| "version": "5.3.0-alpha.3", | ||
| "description": "Types for cspell and cspell-lib", | ||
@@ -13,3 +13,5 @@ "main": "dist/index.js", | ||
| ".": "./dist/index.js", | ||
| "./cspell.schema.json": "./cspell.schema.json" | ||
| "./cspell.schema.json": "./cspell.schema.json", | ||
| "./ajv.config": "./ajv.config.js", | ||
| "./ajv.config.js": "./ajv.config.js" | ||
| }, | ||
@@ -50,3 +52,3 @@ "scripts": { | ||
| }, | ||
| "gitHead": "31d54344356d2e6736c889b1d44bb35ddd9a107c" | ||
| "gitHead": "4ab3c426b21963fd03e4f558fc8b378c415a6650" | ||
| } |
@@ -6,1 +6,56 @@ # Cspell Types | ||
| This package contains no dependencies to avoid any security issues. | ||
| ## Support Future Development | ||
| [](https://www.patreon.com/streetsidesoftware) | ||
| ## 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) | ||
| ## Installation | ||
| ``` | ||
| npm i -SD @cspell/cspell-types | ||
| ``` | ||
| ## Usage | ||
| Can be use to make writing `cspell.config.js` files easier. | ||
| ```js | ||
| 'use strict'; | ||
| /** @type { import("@cspell/cspell-types").CSpellUserSettings } */ | ||
| const cspell = { | ||
| description: 'cspell.config.js file in samples/js-config', | ||
| languageSettings: [ | ||
| { | ||
| languageId: 'cpp', | ||
| allowCompoundWords: false, | ||
| patterns: [ | ||
| { | ||
| name: 'pound-includes', | ||
| pattern: /^\s*#include.*/g, | ||
| }, | ||
| ], | ||
| ignoreRegExpList: ['pound-includes'], | ||
| }, | ||
| ], | ||
| dictionaryDefinitions: [ | ||
| { | ||
| name: 'custom-words', | ||
| path: './custom-words.txt', | ||
| }, | ||
| ], | ||
| dictionaries: ['custom-words'], | ||
| }; | ||
| module.exports = cspell; | ||
| ``` | ||
| ## API | ||
| `CSpellSettings` alias `CSpellUserSettings` is the formal definition of the configuration that controls the spell checker. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by4.52%
46850
- Number of lines in readme file
- increased by916.67%
61
- Number of medium supply chain risk alerts
- decreased by-100%
0