@cspell/cspell-types 6.2.0-alpha.1 → 6.2.0

package/cspell.schema.json

@@ -1103,7 +1103,9 @@
             {
               "type": "string"
             },
-            {}
+            {
+              "$ref": "#/definitions/Serializable"
+            }
           ],
           "maxItems": 2,
           "minItems": 2,
@@ -1112,6 +1114,25 @@
       ],
       "description": "Reporter name or reporter name + reporter config."
     },
+    "Serializable": {
+      "anyOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "null"
+        },
+        {
+          "type": "object"
+        }
+      ]
+    },
     "SimpleGlob": {
       "description": "Simple Glob string, the root will be globRoot.",
       "type": "string"

package/dist/CSpellSettingsDef.d.ts

@@ -1,6 +1,7 @@
 import type { DictionaryInformation } from './DictionaryInformation';
 import type { Features } from './features';
 import { Parser, ParserName } from './Parser';
+import { Serializable } from './types';
 export declare type ReplaceEntry = [string, string];
 export declare type ReplaceMap = ReplaceEntry[];
 /**
@@ -9,11 +10,6 @@ export declare type ReplaceMap = ReplaceEntry[];
 export declare type CSpellPackageSettings = CSpellUserSettings;
 export declare type CSpellUserSettings = CSpellSettings;
 export interface CSpellSettings extends FileSettings, LegacySettings {
-    /**
-     * Url to JSON Schema
-     * @default "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json"
-     */
-    $schema?: string;
 }
 export interface ImportFileRef {
     filename: string;
@@ -25,7 +21,14 @@ export interface CSpellSettingsWithSourceTrace extends CSpellSettings {
     __importRef?: ImportFileRef;
     __imports?: Map<string, ImportFileRef>;
 }
-export interface FileSettings extends ExtendableSettings, CommandLineSettings, ExperimentalFileSettings {
+export interface AdvancedCSpellSettingsWithSourceTrace extends CSpellSettingsWithSourceTrace, ExperimentalFileSettings {
+}
+export interface FileSettings extends ExtendableSettings, CommandLineSettings {
+    /**
+     * Url to JSON Schema
+     * @default "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json"
+     */
+    $schema?: string;
     /**
      * Configuration format version of the settings file.
      *
@@ -802,7 +805,7 @@ interface BaseSource {
 /**
  * Reporter name or reporter name + reporter config.
  */
-export declare type ReporterSettings = string | [string] | [string, unknown];
+export declare type ReporterSettings = string | [string] | [string, Serializable];
 /**
  * Experimental Configuration / Options
  *
@@ -816,7 +819,14 @@ export interface ExperimentalFileSettings {
      * @experimental
      * @version 6.2.0
      */
-    plugins?: Plugin[] | undefined;
+    plugins?: Plugin[];
+}
+/**
+ * Extends CSpellSettings with ExperimentalFileSettings
+ * @experimental
+ * @hidden
+ */
+export interface AdvancedCSpellSettings extends CSpellSettings, ExperimentalFileSettings {
 }
 /**
  * Experimental Configuration / Options
@@ -831,7 +841,7 @@ export interface ExperimentalBaseSettings {
      * @experimental
      * @version 6.2.0
      */
-    parser?: ParserName | undefined;
+    parser?: ParserName;
 }
 /**
  * Plugin API
@@ -839,7 +849,7 @@ export interface ExperimentalBaseSettings {
  * @version 6.2.0
  */
 export interface Plugin {
-    parsers?: Parser[] | undefined;
+    parsers?: Parser[];
 }
 export {};
 //# sourceMappingURL=CSpellSettingsDef.d.ts.map

package/dist/configFields.js

@@ -49,7 +49,6 @@ exports.ConfigFields = {
     words: 'words',
     // Experimental
     parser: 'parser',
-    plugins: 'plugins',
 };
 // export const ConfigKeysNames = Object.values(ConfigKeysByField);
 //# sourceMappingURL=configFields.js.map

package/dist/types.d.ts

@@ -0,0 +1,9 @@
+export declare type Serialize<T> = T extends Function ? never : T extends null ? null : T extends any[] ? SerializeArray<T> : T extends object ? SerializeObj<T> : Primitives<T>;
+declare type SerializeObj<T extends object> = {
+    [K in keyof T]: K extends string | number ? Serialize<T[K]> : never;
+};
+declare type SerializeArray<T extends Array<any>> = T extends [infer R] ? [Serialize<R>] : T extends [infer R0, infer R1] ? [Serialize<R0>, Serialize<R1>] : T extends [infer R0, infer R1, infer R2] ? [Serialize<R0>, Serialize<R1>, Serialize<R2>] : T extends Array<infer R> ? Serialize<R>[] : never;
+declare type Primitives<T> = Extract<T, number | string | null | boolean>;
+export declare type Serializable = number | string | boolean | null | object;
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,5 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/ban-types */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "6.2.0-alpha.1",
+  "version": "6.2.0",
   "description": "Types for cspell and cspell-lib",
   "type": "commonjs",
   "main": "dist/index.js",
@@ -69,5 +69,5 @@
     "ts-json-schema-generator": "^1.0.0",
     "typescript": "^4.7.4"
   },
-  "gitHead": "bb1862e9d5116b64451e625eb002f835e2873f9b"
+  "gitHead": "ef9bf8e390692145b067843dbcc44a6dc2d9aa31"
 }