@cspell/cspell-json-reporter 7.1.1 → 7.3.0

package/dist/esm/CSpellJSONReporterOutput.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CSpellJSONReporterOutput.js.map

package/dist/esm/CSpellJSONReporterSettings.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=CSpellJSONReporterSettings.js.map

package/dist/esm/{index.mjs → index.js}

@@ -1,8 +1,8 @@
 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';
+import { setToJSONReplacer } from './utils/setToJSONReplacer.js';
+import { validateSettings } from './utils/validateSettings.js';
 function mkdirp(p) {
     return fs.mkdir(p, { recursive: true });
 }
@@ -72,3 +72,4 @@ function push(src, value) {
     }
     return [value];
 }
+//# sourceMappingURL=index.js.map

package/dist/esm/utils/{setToJSONReplacer.mjs → setToJSONReplacer.js}

@@ -7,3 +7,4 @@ export function setToJSONReplacer(_, value) {
     }
     return value;
 }
+//# sourceMappingURL=setToJSONReplacer.js.map

package/dist/esm/utils/{validateSettings.mjs → validateSettings.js}

@@ -31,3 +31,4 @@ export function validateSettings(settings) {
     assertBooleanOrUndefined('debug', debug);
     assertBooleanOrUndefined('progress', progress);
 }
+//# sourceMappingURL=validateSettings.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-json-reporter",
-  "version": "7.1.1",
+  "version": "7.3.0",
   "description": "JSON reporter for CSpell",
   "author": "Jason Dent",
   "license": "MIT",
@@ -8,20 +8,16 @@
     "url": "https://github.com/streetsidesoftware/cspell/labels/cspell-json-reporter"
   },
   "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-json-reporter#readme",
-  "type": "commonjs",
-  "main": "dist/cjs/index.js",
-  "types": "dist/cjs/index.d.ts",
-  "module": "dist/esm/index.mjs",
+  "type": "module",
+  "types": "dist/esm/index.d.ts",
+  "module": "dist/esm/index.js",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.js"
+      "import": "./dist/esm/index.js"
     }
   },
   "files": [
     "dist",
-    "!dist/esm/**/*.js",
-    "!dist/esm/**/*.ts",
     "!**/*.tsbuildInfo",
     "!**/__mocks__",
     "!**/test/**",
@@ -38,7 +34,7 @@
   },
   "scripts": {
     "clean": "shx rm -rf dist temp coverage \"*.tsbuildInfo\"",
-    "build": "tsc -b . && ts2mjs dist/esm",
+    "build": "tsc -b .",
     "build:esm": "tsc -p tsconfig.esm.json",
     "clean-build": "pnpm run clean && pnpm run build",
     "coverage": "vitest run --coverage",
@@ -47,10 +43,10 @@
     "watch": "tsc -b . -w"
   },
   "dependencies": {
-    "@cspell/cspell-types": "7.1.1"
+    "@cspell/cspell-types": "7.3.0"
   },
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "2dafa5386c58637614034c7a6d0fa13c03b16e41"
+  "gitHead": "4a16b099b64c5b55645529a4ae79bc32aaf0fc8e"
 }

package/dist/cjs/CSpellJSONReporterOutput.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CSpellJSONReporterOutput.js.map

package/dist/cjs/CSpellJSONReporterSettings.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=CSpellJSONReporterSettings.js.map

package/dist/cjs/index.js

@@ -1,102 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getReporter = void 0;
-const cspell_types_1 = require("@cspell/cspell-types");
-const fs_1 = require("fs");
-const path = __importStar(require("path"));
-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 });
-}
-const noopReporter = () => undefined;
-const STDOUT = 'stdout';
-const STDERR = 'stderr';
-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 === cspell_types_1.MessageTypes.Debug && !useSettings.debug) {
-                return;
-            }
-            if (msgType === cspell_types_1.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_js_1.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_1.promises.writeFile(outFilePath, jsonData);
-        },
-    };
-}
-exports.getReporter = getReporter;
-function normalizeSettings(settings) {
-    if (settings === undefined)
-        return { outFile: STDOUT };
-    (0, validateSettings_js_1.validateSettings)(settings);
-    return settings;
-}
-function push(src, value) {
-    if (src) {
-        src.push(value);
-        return src;
-    }
-    return [value];
-}
-//# sourceMappingURL=index.js.map

package/dist/cjs/utils/setToJSONReplacer.js

@@ -1,14 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.setToJSONReplacer = void 0;
-/**
- * JSON.stringify replacer which converts Set to Array to allow serialization
- */
-function setToJSONReplacer(_, value) {
-    if (typeof value === 'object' && value instanceof Set) {
-        return [...value];
-    }
-    return value;
-}
-exports.setToJSONReplacer = setToJSONReplacer;
-//# sourceMappingURL=setToJSONReplacer.js.map

package/dist/cjs/utils/validateSettings.js

@@ -1,38 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSettings = void 0;
-const assert_1 = require("assert");
-function assertBooleanOrUndefined(key, value) {
-    if (typeof value !== 'boolean' && value !== undefined) {
-        throw new assert_1.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
- */
-function validateSettings(settings) {
-    if (!settings || typeof settings !== 'object' || Array.isArray(settings)) {
-        throw new assert_1.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 assert_1.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);
-}
-exports.validateSettings = validateSettings;
-//# sourceMappingURL=validateSettings.js.map

package/dist/esm/CSpellJSONReporterOutput.d.mts

@@ -1,36 +0,0 @@
-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

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

package/dist/esm/CSpellJSONReporterSettings.d.mts

@@ -1,33 +0,0 @@
-/**
- * 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

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

package/dist/esm/index.d.mts

@@ -1,4 +0,0 @@
-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/utils/setToJSONReplacer.d.mts

@@ -1,5 +0,0 @@
-/**
- * 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/validateSettings.d.mts

@@ -1,6 +0,0 @@
-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