fix: Fix type for some older TypeScript parsers. (#2191)

* fix: Fix type for some older TypeScript parsers. * fix schema
streetsidesoftware · Jan 7, 2022 · b195499 · b195499
1 parent aa38828
commit b195499
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 4 deletions.
diff --git a/cspell.schema.json b/cspell.schema.json
@@ -7,7 +7,7 @@
       "properties": {
         "cacheLocation": {
           "$ref": "#/definitions/FSPathResolvable",
-          "description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which"
+          "description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."
         },
         "cacheStrategy": {
           "$ref": "#/definitions/CacheStrategy",

diff --git a/packages/cspell-types/cspell.schema.json b/packages/cspell-types/cspell.schema.json
@@ -7,7 +7,7 @@
       "properties": {
         "cacheLocation": {
           "$ref": "#/definitions/FSPathResolvable",
-          "description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which"
+          "description": "Path to the cache location. Can be a file or a directory. If none specified `.cspellcache` will be used. Relative paths are relative to the config file in which it is defined.\n\nA prefix of `${cwd}` is replaced with the current working directory."
         },
         "cacheStrategy": {
           "$ref": "#/definitions/CacheStrategy",

diff --git a/packages/cspell-types/src/CSpellSettingsDef.ts b/packages/cspell-types/src/CSpellSettingsDef.ts
@@ -234,7 +234,10 @@ export interface CacheSettings {
     /**
      * Path to the cache location. Can be a file or a directory.
      * If none specified `.cspellcache` will be used.
-     * Relative paths are relative to the config file in which
+     * Relative paths are relative to the config file in which it
+     * is defined.
+     *
+     * A prefix of `${cwd}` is replaced with the current working directory.
      */
     cacheLocation?: FSPathResolvable;
 

diff --git a/packages/cspell-types/src/index.ts b/packages/cspell-types/src/index.ts
@@ -1,4 +1,6 @@
-export { ConfigFields, type CSpellUserSettingsFields } from './configFields';
+// Using old-style of `type` exports because the new style breaks some integrations.
+export { ConfigFields } from './configFields';
+export type { CSpellUserSettingsFields } from './configFields';
 export * from './CSpellReporter';
 export * from './CSpellSettingsDef';
 export type { TextDocumentOffset, TextOffset } from './TextOffset';