@cspell/cspell-json-reporter 6.28.0 → 6.29.0

package/dist/{index.d.ts → cjs/index.d.ts}

@@ -1,4 +1,4 @@
 import type { CSpellReporter, ReporterConfiguration } from '@cspell/cspell-types';
-import type { CSpellJSONReporterSettings } from './CSpellJSONReporterSettings';
+import type { CSpellJSONReporterSettings } from './CSpellJSONReporterSettings.js';
 export declare function getReporter(settings: unknown | CSpellJSONReporterSettings, cliOptions?: ReporterConfiguration): Required<CSpellReporter>;
 //# sourceMappingURL=index.d.ts.map

package/dist/{index.js → cjs/index.js}

@@ -27,8 +27,8 @@ exports.getReporter = void 0;
 const cspell_types_1 = require("@cspell/cspell-types");
 const fs_1 = require("fs");
 const path = __importStar(require("path"));
-const setToJSONReplacer_1 = require("./utils/setToJSONReplacer");
-const validateSettings_1 = require("./utils/validateSettings");
+const setToJSONReplacer_js_1 = require("./utils/setToJSONReplacer.js");
+const validateSettings_js_1 = require("./utils/validateSettings.js");
 function mkdirp(p) {
     return fs_1.promises.mkdir(p, { recursive: true });
 }
@@ -70,7 +70,7 @@ function getReporter(settings, cliOptions) {
                 ...reportData,
                 result,
             };
-            const jsonData = JSON.stringify(output, setToJSONReplacer_1.setToJSONReplacer, 4);
+            const jsonData = JSON.stringify(output, setToJSONReplacer_js_1.setToJSONReplacer, 4);
             if (outFile === STDOUT) {
                 console.log(jsonData);
                 return;
@@ -89,7 +89,7 @@ exports.getReporter = getReporter;
 function normalizeSettings(settings) {
     if (settings === undefined)
         return { outFile: STDOUT };
-    (0, validateSettings_1.validateSettings)(settings);
+    (0, validateSettings_js_1.validateSettings)(settings);
     return settings;
 }
 function push(src, value) {

package/dist/{utils → cjs/utils}/validateSettings.d.ts

@@ -1,4 +1,4 @@
-import type { CSpellJSONReporterSettings } from '../CSpellJSONReporterSettings';
+import type { CSpellJSONReporterSettings } from '../CSpellJSONReporterSettings.js';
 /**
  * Throws an error if passed cspell-json-reporter settings are invalid
  */

package/dist/esm/CSpellJSONReporterOutput.d.mts

@@ -0,0 +1,36 @@
+import type { ErrorLike, Issue, MessageType, ProgressFileComplete, ProgressItem, RunResult } from '@cspell/cspell-types';
+export type CSpellJSONReporterOutput = {
+    /**
+     * Found spelling issues
+     */
+    issues: Array<Issue>;
+    /**
+     * CSpell execution logs
+     */
+    info?: Array<{
+        message: string;
+        msgType: MessageType;
+    }>;
+    /**
+     * CSpell debug logs
+     */
+    debug?: Array<{
+        message: string;
+    }>;
+    /**
+     * CSpell error logs
+     */
+    error?: Array<{
+        message: string;
+        error: ErrorLike;
+    }>;
+    /**
+     * CSpell file progress logs
+     */
+    progress?: Array<ProgressItem | ProgressFileComplete>;
+    /**
+     * Execution result
+     */
+    result: RunResult;
+};
+//# sourceMappingURL=CSpellJSONReporterOutput.d.mts.map

package/dist/esm/CSpellJSONReporterOutput.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/CSpellJSONReporterSettings.d.mts

@@ -0,0 +1,33 @@
+/**
+ * CSpell-json-reporter settings type definition
+ */
+export type CSpellJSONReporterSettings = {
+    /**
+     * Path to the output file.
+     *
+     * Relative paths are relative to the current working directory.
+     *
+     * Special values:
+     * - `stdout` - write the JSON to `stdout`.
+     * - `stderr` - write the JSON to `stderr`.
+     *
+     * @default stdout
+     */
+    outFile?: string;
+    /**
+     * Add more information about the files being checked and the configuration
+     * @default false
+     */
+    verbose?: boolean;
+    /**
+     * Add information useful for debugging cspell.json files
+     * @default false
+     */
+    debug?: boolean;
+    /**
+     * Add progress messages
+     * @default false
+     */
+    progress?: boolean;
+};
+//# sourceMappingURL=CSpellJSONReporterSettings.d.mts.map

package/dist/esm/CSpellJSONReporterSettings.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.d.mts

@@ -0,0 +1,4 @@
+import type { CSpellReporter, ReporterConfiguration } from '@cspell/cspell-types';
+import type { CSpellJSONReporterSettings } from './CSpellJSONReporterSettings.mjs';
+export declare function getReporter(settings: unknown | CSpellJSONReporterSettings, cliOptions?: ReporterConfiguration): Required<CSpellReporter>;
+//# sourceMappingURL=index.d.mts.map

package/dist/esm/index.mjs

@@ -0,0 +1,74 @@
+import { MessageTypes } from '@cspell/cspell-types';
+import { promises as fs } from 'fs';
+import * as path from 'path';
+import { setToJSONReplacer } from './utils/setToJSONReplacer.mjs';
+import { validateSettings } from './utils/validateSettings.mjs';
+function mkdirp(p) {
+    return fs.mkdir(p, { recursive: true });
+}
+const noopReporter = () => undefined;
+const STDOUT = 'stdout';
+const STDERR = 'stderr';
+export function getReporter(settings, cliOptions) {
+    const useSettings = normalizeSettings(settings);
+    const reportData = { issues: [], info: [], debug: [], error: [], progress: [] };
+    return {
+        issue: (issue) => {
+            reportData.issues.push(issue);
+        },
+        info: (message, msgType) => {
+            if (msgType === MessageTypes.Debug && !useSettings.debug) {
+                return;
+            }
+            if (msgType === MessageTypes.Info && !useSettings.verbose) {
+                return;
+            }
+            reportData.info = push(reportData.info, { message, msgType });
+        },
+        debug: useSettings.debug
+            ? (message) => {
+                reportData.debug = push(reportData.debug, { message });
+            }
+            : noopReporter,
+        error: (message, error) => {
+            reportData.error = push(reportData.error, { message, error });
+        },
+        progress: useSettings.progress
+            ? (item) => {
+                reportData.progress = push(reportData.progress, item);
+            }
+            : noopReporter,
+        result: async (result) => {
+            const outFile = useSettings.outFile || STDOUT;
+            const output = {
+                ...reportData,
+                result,
+            };
+            const jsonData = JSON.stringify(output, setToJSONReplacer, 4);
+            if (outFile === STDOUT) {
+                console.log(jsonData);
+                return;
+            }
+            if (outFile === STDERR) {
+                console.error(jsonData);
+                return;
+            }
+            const outFilePath = path.join(cliOptions?.root ?? process.cwd(), outFile);
+            await mkdirp(path.dirname(outFilePath));
+            return fs.writeFile(outFilePath, jsonData);
+        },
+    };
+}
+function normalizeSettings(settings) {
+    if (settings === undefined)
+        return { outFile: STDOUT };
+    validateSettings(settings);
+    return settings;
+}
+function push(src, value) {
+    if (src) {
+        src.push(value);
+        return src;
+    }
+    return [value];
+}

package/dist/esm/utils/setToJSONReplacer.d.mts

@@ -0,0 +1,5 @@
+/**
+ * JSON.stringify replacer which converts Set to Array to allow serialization
+ */
+export declare function setToJSONReplacer(_: string, value: unknown): unknown;
+//# sourceMappingURL=setToJSONReplacer.d.mts.map

package/dist/esm/utils/setToJSONReplacer.mjs

@@ -0,0 +1,9 @@
+/**
+ * JSON.stringify replacer which converts Set to Array to allow serialization
+ */
+export function setToJSONReplacer(_, value) {
+    if (typeof value === 'object' && value instanceof Set) {
+        return [...value];
+    }
+    return value;
+}

package/dist/esm/utils/validateSettings.d.mts

@@ -0,0 +1,6 @@
+import type { CSpellJSONReporterSettings } from '../CSpellJSONReporterSettings.mjs';
+/**
+ * Throws an error if passed cspell-json-reporter settings are invalid
+ */
+export declare function validateSettings(settings: unknown): asserts settings is CSpellJSONReporterSettings;
+//# sourceMappingURL=validateSettings.d.mts.map

package/dist/esm/utils/validateSettings.mjs

@@ -0,0 +1,33 @@
+import { AssertionError } from 'assert';
+function assertBooleanOrUndefined(key, value) {
+    if (typeof value !== 'boolean' && value !== undefined) {
+        throw new AssertionError({
+            message: `cspell-json-reporter settings.${key} must be a boolean`,
+            actual: typeof value,
+            expected: 'boolean',
+        });
+    }
+}
+/**
+ * Throws an error if passed cspell-json-reporter settings are invalid
+ */
+export function validateSettings(settings) {
+    if (!settings || typeof settings !== 'object' || Array.isArray(settings)) {
+        throw new AssertionError({
+            message: 'cspell-json-reporter settings must be an object',
+            actual: typeof settings,
+            expected: 'object',
+        });
+    }
+    const { outFile = 'stdout', debug, verbose, progress } = settings;
+    if (typeof outFile !== 'string') {
+        throw new AssertionError({
+            message: 'cspell-json-reporter settings.outFile must be a string',
+            actual: typeof outFile,
+            expected: 'string',
+        });
+    }
+    assertBooleanOrUndefined('verbose', verbose);
+    assertBooleanOrUndefined('debug', debug);
+    assertBooleanOrUndefined('progress', progress);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-json-reporter",
-  "version": "6.28.0",
+  "version": "6.29.0",
   "description": "JSON reporter for CSpell",
   "author": "Jason Dent",
   "license": "MIT",
@@ -8,12 +8,23 @@
     "url": "https://github.com/streetsidesoftware/cspell/labels/cspell-json-reporter"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-json-reporter#readme",
-  "main": "dist/index.js",
-  "typings": "dist/index.d.ts",
+  "type": "commonjs",
+  "main": "dist/cjs/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "module": "dist/esm/index.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.mjs",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "files": [
     "dist",
+    "!dist/esm/**/*.js",
+    "!dist/esm/**/*.ts",
     "!**/*.tsbuildInfo",
     "!**/__mocks__",
+    "!**/test/**",
     "!**/*.test.*",
     "!**/*.spec.*",
     "!**/*.map"
@@ -26,22 +37,22 @@
     "url": "git+https://github.com/streetsidesoftware/cspell.git"
   },
   "scripts": {
-    "clean": "shx rm -rf dist temp coverage .tsbuildinfo",
-    "build": "pnpm run compile",
+    "clean": "shx rm -rf dist coverage .tsbuildinfo",
+    "build": "tsc -b . && ts2mjs dist/esm",
+    "build:esm": "tsc -p tsconfig.esm.json",
     "clean-build": "pnpm run clean && pnpm run build",
-    "compile": "tsc -p .",
-    "watch": "tsc --watch -p .",
-    "coverage": "jest --coverage",
-    "test-watch": "jest --watch",
-    "prepublishOnly": "pnpm run clean-build",
-    "test": "jest",
-    "update-snapshot": "jest --updateSnapshot"
+    "coverage": "pnpm coverage:vitest && pnpm coverage:fix",
+    "coverage:vitest": "vitest run --coverage",
+    "coverage:fix": "nyc report --temp-dir \"$(pwd)/coverage\" --reporter lcov --report-dir \"$(pwd)/coverage\" --cwd ../..",
+    "test:watch": "vitest",
+    "test": "vitest run",
+    "watch": "tsc -b . -w"
   },
   "dependencies": {
-    "@cspell/cspell-types": "6.28.0"
+    "@cspell/cspell-types": "6.29.0"
   },
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "1c314413e76908e5fbf61fd2555726112b177c0e"
+  "gitHead": "2eabb1c47c12c2a42eb95d30329be6f544ee2ffc"
 }