@cspell/cspell-types - npm Package Compare versions

Comparing version 5.2.4 to 5.3.0-alpha.0

CHANGELOG.md

@@ -6,4 +6,17 @@ # Change Log
 
+# [5.3.0-alpha.0](https://github.com/streetsidesoftware/cspell/compare/v5.2.4...v5.3.0-alpha.0) (2021-02-18)
+
+
+### Features
+
+* Be able to specify files to spell check within the config. ([#948](https://github.com/streetsidesoftware/cspell/issues/948)) ([23f7a48](https://github.com/streetsidesoftware/cspell/commit/23f7a488ef500fb1df5cd234c7d3c2ab4ec02961)), closes [#571](https://github.com/streetsidesoftware/cspell/issues/571)
+* Part 1 - glob patterns are relative to the config file. ([#921](https://github.com/streetsidesoftware/cspell/issues/921)) ([a250448](https://github.com/streetsidesoftware/cspell/commit/a2504484ec38f15804cc0a203317266f83566b7c))
+* Support local configuration files ([#966](https://github.com/streetsidesoftware/cspell/issues/966)) ([0ccc5fe](https://github.com/streetsidesoftware/cspell/commit/0ccc5fe9eb70ca3a4c6e5a3fc0b653465e76983c))
+
+
+
+
+
 ## [5.2.4](https://github.com/streetsidesoftware/cspell/compare/v5.2.3...v5.2.4) (2021-01-28)
 
 **Note:** Version bump only for package @cspell/cspell-types

dist/settings/CSpellSettingsDef.d.ts

@@ -24,5 +24,5 @@ export declare type ReplaceEntry = [string, string];
      * Configuration format version of the setting file.
-     * @default "0.1"
+     * @default "0.2"
      */
-    version?: string | '0.1';
+    version?: '0.2' | '0.1';
     /** Words to add to dictionary -- should only be in the user config file. */
@@ -32,2 +32,33 @@ userWords?: string[];
     import?: FsPath | FsPath[];
+    /**
+     * The root to use for glop patterns found in this configuration.
+     * Default: location of the configuration file.
+     *   For compatibility reasons, config files with version 0.1, the glob root will
+     *   default to be `${cwd}`.
+     *
+     * Use `globRoot` to define a different location.
+     * `globRoot` can be relative to the location of this configuration file.
+     * Defining globRoot, does not impact imported configurations.
+     *
+     * Special Values:
+     * - `${cwd}` - will be replaced with the current working directory.
+     * - `.` - will be the location of the containing configuration file.
+     *
+     */
+    globRoot?: FsPath;
+    /**
+     * Glob patterns of files to be checked.
+     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
+     */
+    files?: Glob[];
+    /**
+     * Glob patterns of files to be ignored
+     * Glob patterns are relative to the `globRoot` of the configuration file that defines them.
+     */
+    ignorePaths?: Glob[];
+    /**
+     * Prevents searching for local configuration when checking individual documents.
+     * @default false
+     */
+    noConfigSearch?: boolean;
 }
@@ -50,4 +81,2 @@ export interface ExtendableSettings extends Settings {
     ignoreWords?: string[];
-    /** Glob file patterns to be ignored */
-    ignorePaths?: Glob[];
     /** languageIds for the files to spell check. */
@@ -142,3 +171,3 @@ enabledLanguageIds?: LanguageId[];
      */
-    ignoreRegExpList?: RegExpList;
+    ignoreRegExpList?: RegExpPatternList;
     /**
@@ -148,3 +177,3 @@ * List of RegExp patterns or defined Pattern names to define the text to be included for spell checking.
      */
-    includeRegExpList?: RegExpList;
+    includeRegExpList?: RegExpPatternList;
     /** Defines a list of patterns that can be used in ignoreRegExpList and includeRegExpList */
@@ -199,6 +228,17 @@ patterns?: RegExpPatternDefinition[];
 }
-export interface LanguageSettingFilterFields {
+export interface LanguageSettingFilterFields extends LanguageSettingFilterFieldsPreferred, LanguageSettingFilterFieldsDeprecated {
+}
+export interface LanguageSettingFilterFieldsPreferred {
     /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages */
     languageId: LanguageId | LanguageId[];
     /** The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales. */
+    locale?: LocaleId | LocaleId[];
+}
+export interface LanguageSettingFilterFieldsDeprecated {
+    /** The language id.  Ex: "typescript", "html", or "php".  "*" -- will match all languages */
+    languageId: LanguageId | LanguageId[];
+    /**
+     * The locale filter, matches against the language. This can be a comma separated list. "*" will match all locales.
+     * @deprecated use `locale`
+     */
     local?: LocaleId | LocaleId[];
@@ -214,3 +254,4 @@ }
 export declare type PatternRef = Pattern | PatternId | PredefinedPatterns;
-export declare type RegExpList = PatternRef[];
+/** A list of pattern names or regular expressions */
+export declare type RegExpPatternList = PatternRef[];
 /** This matches the name in a dictionary definition */
@@ -225,3 +266,17 @@ export declare type DictionaryId = string;
 /** These are glob expressions */
-export declare type Glob = string;
+export declare type Glob = SimpleGlob | GlobDef;
+/** Simple Glob string, the root will be globRoot */
+export declare type SimpleGlob = string;
+/**
+ * Used to define fully qualified glob patterns.
+ * It is currently hidden to make the json-schema a bit easier to use
+ * when crafting cspell.json files by hand.
+ * @hidden
+ */
+export interface GlobDef {
+    /** Glob pattern to match */
+    glob: string;
+    /** Optional root to use when matching the glob. Defaults to current working dir. */
+    root?: string;
+}
 /** This can be '*', 'typescript', 'cpp', 'json', etc. */
@@ -228,0 +283,0 @@ export declare type LanguageId = string;

package.json

@@ -6,3 +6,3 @@ {
   },
-  "version": "5.2.4",
+  "version": "5.3.0-alpha.0",
   "description": "Types for cspell and cspell-lib",
@@ -42,6 +42,6 @@ "main": "dist/index.js",
     "rimraf": "^3.0.2",
-    "ts-json-schema-generator": "^0.83.2",
-    "typescript": "^4.1.3"
+    "ts-json-schema-generator": "^0.84.0",
+    "typescript": "^4.1.5"
   },
-  "gitHead": "a8bb9a921b459929a340ac26d025dc01a9fdb008"
+  "gitHead": "30d2b0311d86f4eef060245c885207a6c715c3d9"
 }

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

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

Major refactor

Supply chain risk

Package 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

15885

increased by24.19%

Lines of code

330

increased by20%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Number of low quality alerts

2

increased by100%

No dependency changes