@cspell/cspell-json-reporter 6.20.1 → 6.22.0

package/README.md

@@ -37,7 +37,52 @@ or `cspell.json`
 - `info` - CSpell execution logs if `settings.verbose` is enabled
 - `debug` - CSpell debug logs if `settings.debug` is enabled
 
-See [CSpellJSONReporterOutput](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterOutput.ts) for more info.
+<details>
+<summary>JSON Output Definition</summary>
+
+<!--- @@inject: src/CSpellJSONReporterOutput.ts --->
+
+```ts
+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;
+};
+```
+
+<!--- @@inject-end: src/CSpellJSONReporterOutput.ts --->
+
+</details>
 
 ## Settings
 
@@ -48,4 +93,46 @@ Possible settings:
 - `debug` (default: false) - enable saving of debug logs
 - `progress` (default: false) - enable saving of file progress logs
 
-See [CSpellJSONReporterSettings](https://github.com/streetsidesoftware/cspell/blob/main/packages/cspell-json-reporter/src/CSpellJSONReporterSettings.ts) for more info.
+<details>
+<summary>Reporter Settings</summary>
+
+<!--- @@inject: src/CSpellJSONReporterSettings.ts --->
+
+```ts
+/**
+ * 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;
+};
+```
+
+<!--- @@inject-end: src/CSpellJSONReporterSettings.ts --->
+
+</details>

package/dist/CSpellJSONReporterOutput.d.ts

@@ -7,27 +7,27 @@ export type CSpellJSONReporterOutput = {
     /**
      * CSpell execution logs
      */
-    info: Array<{
+    info?: Array<{
         message: string;
         msgType: MessageType;
     }>;
     /**
      * CSpell debug logs
      */
-    debug: Array<{
+    debug?: Array<{
         message: string;
     }>;
     /**
      * CSpell error logs
      */
-    error: Array<{
+    error?: Array<{
         message: string;
         error: ErrorLike;
     }>;
     /**
      * CSpell file progress logs
      */
-    progress: Array<ProgressItem | ProgressFileComplete>;
+    progress?: Array<ProgressItem | ProgressFileComplete>;
     /**
      * Execution result
      */

package/dist/CSpellJSONReporterSettings.d.ts

@@ -3,9 +3,17 @@
  */
 export type CSpellJSONReporterSettings = {
     /**
-     * Output JSON file path
+     * 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;
+    outFile?: string;
     /**
      * Add more information about the files being checked and the configuration
      * @default false

package/dist/index.d.ts

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

package/dist/index.js

@@ -33,51 +33,70 @@ function mkdirp(p) {
     return fs_1.promises.mkdir(p, { recursive: true });
 }
 const noopReporter = () => undefined;
-function getReporter(settings) {
-    (0, validateSettings_1.validateSettings)(settings);
-    const reportData = {
-        issues: [],
-        info: [],
-        debug: [],
-        error: [],
-        progress: [],
-    };
+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 && !settings.debug) {
+            if (msgType === cspell_types_1.MessageTypes.Debug && !useSettings.debug) {
                 return;
             }
-            if (msgType === cspell_types_1.MessageTypes.Info && !settings.verbose) {
+            if (msgType === cspell_types_1.MessageTypes.Info && !useSettings.verbose) {
                 return;
             }
-            reportData.info.push({ message, msgType });
+            reportData.info = push(reportData.info, { message, msgType });
         },
-        debug: settings.debug
+        debug: useSettings.debug
             ? (message) => {
-                reportData.debug.push({ message });
+                reportData.debug = push(reportData.debug, { message });
             }
             : noopReporter,
         error: (message, error) => {
-            reportData.error.push({ message, error });
+            reportData.error = push(reportData.error, { message, error });
         },
-        progress: settings.progress
+        progress: useSettings.progress
             ? (item) => {
-                reportData.progress.push(item);
+                reportData.progress = push(reportData.progress, item);
             }
             : noopReporter,
         result: async (result) => {
-            const outFilePath = path.join(process.cwd(), settings.outFile);
+            const outFile = useSettings.outFile || STDOUT;
             const output = {
                 ...reportData,
                 result,
             };
+            const jsonData = JSON.stringify(output, setToJSONReplacer_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, JSON.stringify(output, setToJSONReplacer_1.setToJSONReplacer, 4));
+            return fs_1.promises.writeFile(outFilePath, jsonData);
         },
     };
 }
 exports.getReporter = getReporter;
+function normalizeSettings(settings) {
+    if (settings === undefined)
+        return { outFile: STDOUT };
+    (0, validateSettings_1.validateSettings)(settings);
+    return settings;
+}
+function push(src, value) {
+    if (src) {
+        src.push(value);
+        return src;
+    }
+    return [value];
+}
 //# sourceMappingURL=index.js.map

package/dist/utils/validateSettings.js

@@ -15,14 +15,14 @@ function assertBooleanOrUndefined(key, value) {
  * Throws an error if passed cspell-json-reporter settings are invalid
  */
 function validateSettings(settings) {
-    if (!settings || typeof settings !== 'object') {
+    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, debug, verbose, progress } = settings;
+    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',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cspell/cspell-json-reporter",
-  "version": "6.20.1",
+  "version": "6.22.0",
   "description": "JSON reporter for CSpell",
   "author": "Jason Dent",
   "license": "MIT",
@@ -38,10 +38,10 @@
     "update-snapshot": "jest --updateSnapshot"
   },
   "dependencies": {
-    "@cspell/cspell-types": "6.20.1"
+    "@cspell/cspell-types": "6.22.0"
   },
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "508a06d32dd59d881d07cb60fe8c0a7c0bddf8eb"
+  "gitHead": "a133874ed7590cbe140f5067cfa80db84b644a5d"
 }