@cspell/cspell-types - npm Package Compare versions

Comparing version 7.3.3 to 7.3.4

dist/CSpellSettingsDef.d.ts

@@ -43,8 +43,16 @@ import type { ReporterConfigurationBase } from './CSpellReporter.js';
     /**
+     * @markdownDescription
      * Allows this configuration to inherit configuration for one or more other files.
      *
      * See [Importing / Extending Configuration](https://cspell.org/configuration/imports/) for more details.
+     *
+     * @description
+     * Allows this configuration to inherit configuration for one or more other files.
+     *
+     * See https://cspell.org/configuration/imports/ for more details.
+     *
      */
     import?: FsPath | FsPath[];
     /**
+     * @markdownDescription
      * The root to use for glob patterns found in this configuration.
@@ -63,8 +71,16 @@ * Default: location of the configuration file.
      *
+     * @description
+     * The root to use for glob patterns found in this configuration.
      */
     globRoot?: FSPathResolvable;
     /**
+     * @markdownDescription
      * Glob patterns of files to be checked.
      *
      * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
+     *
+     * @description
+     * Glob patterns of files to be checked.
+     *
+     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
      */
@@ -101,2 +117,3 @@ files?: Glob[];
     /**
+     * @markdownDescription
      * Define which reports to use.
@@ -111,2 +128,12 @@ * `default` - is a special name for the default cli reporter.
      *
+     * @description
+     * Define which reports to use.
+     * `default` - is a special name for the default cli reporter.
+     *
+     * Examples:
+     * - `["default"]` - to use the default reporter
+     * - `["@cspell/cspell-json-reporter"]` - use the cspell JSON reporter.
+     * - `[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]`
+     * - `[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]` - Use both the default reporter and the cspell-json-reporter.
+     *
      * @default ["default"]
@@ -145,2 +172,3 @@ */
     /**
+     * @markdownDescription
      * Overrides are used to apply settings for specific files in your project.
@@ -164,2 +192,4 @@ *
      * ```
+     * @description
+     * Overrides are used to apply settings for specific files in your project.
      */
@@ -189,3 +219,5 @@ overrides?: OverrideSettings[];
      * Enable / Disable checking file types (languageIds).
+     *
      * These are in additional to the file types specified by `cSpell.enabledLanguageIds`.
+     *
      * To disable a language, prefix with `!` as in `!json`,
@@ -202,5 +234,9 @@ *
     /**
+     * @markdownDescription
      * Additional settings for individual languages.
      *
      * See [Language Settings](https://cspell.org/configuration/language-settings/) for more details.
+     *
+     * @description
+     * Additional settings for individual languages.
      */
@@ -234,2 +270,3 @@ languageSettings?: LanguageSetting[];
     /**
+     * @markdownDescription
      * The maximum number of changes allowed on a word to be considered a suggestions.
@@ -241,2 +278,5 @@ *
      *
+     * @description
+     * The maximum number of changes allowed on a word to be considered a suggestions.
+     *
      * @default 3
@@ -380,5 +420,9 @@ */
     /**
+     * @markdownDescription
      * True to enable compound word checking. See [Case Sensitivity](https://cspell.org/docs/case-sensitive/) for more details.
      *
-     * @default false
+     * @description
+     * True to enable compound word checking. See https://cspell.org/docs/case-sensitive/ for more details.
+
+    * @default false
      */
@@ -410,2 +454,3 @@ allowCompoundWords?: boolean;
     /**
+     * @markdownDescription
      * Optional list of dictionaries to use. Each entry should match the name of the dictionary.
@@ -419,2 +464,5 @@ *
      * and [Custom Dictionaries](https://cspell.org/docs/dictionaries-custom/) for more details.
+     *
+     * @description
+     * Optional list of dictionaries to use. Each entry should match the name of the dictionary.
      */
@@ -433,2 +481,3 @@ dictionaries?: DictionaryReference[];
     /**
+     * @markdownDescription
      * List of regular expression patterns or pattern names to exclude from spell checking.
@@ -459,5 +508,8 @@ *
      * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
+     * @description
+     * List of regular expression patterns or pattern names to exclude from spell checking.
      */
     ignoreRegExpList?: RegExpPatternList;
     /**
+     * @markdownDescription
      * List of regular expression patterns or defined pattern names to match for spell checking.
@@ -469,5 +521,8 @@ *
      * [built-in to CSpell](https://cspell.org/types/cspell-types/types/PredefinedPatterns.html).
+     * @description
+     * List of regular expression patterns or defined pattern names to match for spell checking.
      */
     includeRegExpList?: RegExpPatternList;
     /**
+     * @markdownDescription
      * Defines a list of patterns that can be used with the `ignoreRegExpList` and
@@ -496,2 +551,5 @@ * `includeRegExpList` options.
      * ```
+     * @description
+     * Defines a list of patterns that can be used with the `ignoreRegExpList` and
+     * `includeRegExpList` options.
      */
@@ -498,0 +556,0 @@ patterns?: RegExpPatternDefinition[];

dist/DictionaryDefinition.d.ts

@@ -35,6 +35,8 @@ import type { DictionaryInformation } from './DictionaryInformation.js';
      * Type of file:
-     * S - single word per line,
-     * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed).
+     * - S - single word per line,
+     * - W - each line can contain one or more words separated by space,
+     * - C - each line is treated like code (Camel Case is allowed).
+     *
      * Default is S.
+     *
      * C is the slowest to load due to the need to split each line based upon code splitting rules.
@@ -127,6 +129,8 @@ * @default "S"
      * Type of file:
-     * S - single word per line,
-     * W - each line can contain one or more words separated by space,
-     * C - each line is treated like code (Camel Case is allowed).
+     * - S - single word per line,
+     * - W - each line can contain one or more words separated by space,
+     * - C - each line is treated like code (Camel Case is allowed).
+     *
      * Default is S.
+     *
      * C is the slowest to load due to the need to split each line based upon code splitting rules.
@@ -150,2 +154,3 @@ * @default "S"
  * to the file.
+ *
  * Note: only plain text files with one word per line are supported at this moment.
@@ -158,2 +163,3 @@ */
      * Defines the scope for when words will be added to the dictionary.
+     *
      * Scope values: `user`, `workspace`, `folder`.
@@ -160,0 +166,0 @@ */

dist/DictionaryInformation.d.ts

@@ -21,2 +21,4 @@ import type { SuggestionCostsDefs } from './suggestionCostsDef.js';
      * The accent characters.
+     * @markdownDescription
+     * The accent characters.
      *
@@ -56,2 +58,3 @@ * Default: `"\u0300-\u0341"`
     /**
+     * @markdownDescription
      * Selected Hunspell AFF content.
@@ -78,2 +81,14 @@ * The content must be UTF-8
      * ```
+     *
+     * @description
+     * Selected Hunspell AFF content.
+     * The content must be UTF-8
+     *
+     * Sections:
+     * - TRY
+     * - MAP
+     * - REP
+     * - KEY
+     * - ICONV
+     * - OCONV
      */
@@ -80,0 +95,0 @@ aff: HunspellAffContent;

dist/InlineDictionary.d.ts

@@ -8,2 +8,4 @@ export interface InlineDictionary {
      * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
+     * @markdownDescription
+     * List of words to always be considered incorrect. Words found in `flagWords` override `words`.
      *
@@ -35,2 +37,7 @@ * Format of `flagWords`
      *
+     * @markdownDescription
+     * A list of suggested replacements for words.
+     * Suggested words provide a way to make preferred suggestions on word replacements.
+     * To hint at a preferred change, but not to require it.
+     *
      * Format of `suggestWords`
@@ -37,0 +44,0 @@ * - Single suggestion (possible auto fix)

package.json

@@ -6,3 +6,3 @@ {
   },
-  "version": "7.3.3",
+  "version": "7.3.4",
   "description": "Types for cspell and cspell-lib",
@@ -56,9 +56,7 @@ "type": "commonjs",
     "build": "pnpm build:tsc && pnpm run build-schema",
-    "build:tsc": "tsc -b tsconfig.json",
-    "build-schema": "ts-json-schema-generator --no-top-ref --path src/CSpellSettingsDef.ts --type CSpellSettings --validation-keywords markdownDescription  --validation-keywords scope --validation-keywords deprecated --validation-keywords deprecationMessage -o  ./cspell.schema.json && shx cp ./cspell.schema.json ../..",
+    "build:tsc": "tsc -p tsconfig.json",
+    "build-schema": "pnpm build-cspell-schema",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage",
-    "test": "pnpm test:unit && pnpm test:schema",
-    "test:unit": "vitest run",
-    "test:schema": "ajv -s ./cspell.schema.json -d \"cspell.test.{json,yaml}\" -c ./ajv.config.js",
+    "test": "vitest run",
     "prepare": "echo Skip Building Types"
@@ -91,7 +89,3 @@ },
   },
-  "devDependencies": {
-    "ajv-cli": "^5.0.0",
-    "ts-json-schema-generator": "^1.3.0"
-  },
-  "gitHead": "da65ffafaa6a039cedc52d9e029c53ddd273a1fb"
+  "gitHead": "7849a4ff2561453653fae9b9067b39252aeb773f"
 }

New alerts

License Policy Violation

License

This 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

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

153521

increased by5.3%

Dev dependency count

0

decreased by-100%

Lines of code

3684

increased by3.28%

Worsened metrics

Number of package files

34

decreased by-2.86%

No dependency changes