@cspell/cspell-types 5.15.0 → 5.15.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,7 +7,7 @@
7
7
  "properties": {
8
8
  "cacheLocation": {
9
9
  "$ref": "#/definitions/FSPathResolvable",
10
- "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"
10
+ "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."
11
11
  },
12
12
  "cacheStrategy": {
13
13
  "$ref": "#/definitions/CacheStrategy",
@@ -199,7 +199,10 @@ export interface CacheSettings {
199
199
  /**
200
200
  * Path to the cache location. Can be a file or a directory.
201
201
  * If none specified `.cspellcache` will be used.
202
- * Relative paths are relative to the config file in which
202
+ * Relative paths are relative to the config file in which it
203
+ * is defined.
204
+ *
205
+ * A prefix of `${cwd}` is replaced with the current working directory.
203
206
  */
204
207
  cacheLocation?: FSPathResolvable;
205
208
  /**
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
- export { ConfigFields, type CSpellUserSettingsFields } from './configFields';
1
+ export { ConfigFields } from './configFields';
2
+ export type { CSpellUserSettingsFields } from './configFields';
2
3
  export * from './CSpellReporter';
3
4
  export * from './CSpellSettingsDef';
4
5
  export type { TextDocumentOffset, TextOffset } from './TextOffset';
package/dist/index.js CHANGED
@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
11
11
  };
12
12
  Object.defineProperty(exports, "__esModule", { value: true });
13
13
  exports.ConfigFields = void 0;
14
+ // Using old-style of `type` exports because the new style breaks some integrations.
14
15
  var configFields_1 = require("./configFields");
15
16
  Object.defineProperty(exports, "ConfigFields", { enumerable: true, get: function () { return configFields_1.ConfigFields; } });
16
17
  __exportStar(require("./CSpellReporter"), exports);
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "publishConfig": {
4
4
  "access": "public"
5
5
  },
6
- "version": "5.15.0",
6
+ "version": "5.15.1",
7
7
  "description": "Types for cspell and cspell-lib",
8
8
  "main": "dist/index.js",
9
9
  "typings": "dist/index.d.ts",
@@ -49,12 +49,12 @@
49
49
  },
50
50
  "devDependencies": {
51
51
  "ajv-cli": "^5.0.0",
52
- "jest": "^27.4.6",
52
+ "jest": "^27.4.7",
53
53
  "rimraf": "^3.0.2",
54
54
  "ts-json-schema-generator": "^0.97.0",
55
55
  "typedoc": "^0.22.10",
56
56
  "typedoc-plugin-markdown": "^3.11.9",
57
57
  "typescript": "^4.5.4"
58
58
  },
59
- "gitHead": "04d61378054cbecd28df100ca704c7322abab8ba"
59
+ "gitHead": "b0461bc45386484e14ac7ad97a68d7d860d2309a"
60
60
  }