feat(cli): added parser arg

docs/guides/2-cli.md

@@ -46,6 +46,8 @@ Other options include:
       --ignore-unknown-format    do not warn about unmatched formats                          [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns                              [boolean] [default: false]
       --show-documentation-url   show documentation url in output result                      [boolean] [default: false]
+  -p, --parser                   which parser should be used to read the file (defaults to Yaml)
+                                                                    [string] [choices: "Yaml", "Json"] [default: "Yaml"]
   -v, --verbose                  increase verbosity                                                            [boolean]
   -q, --quiet                    no logging - output only                                                      [boolean]
 ```

packages/cli/src/commands/lint.ts

@@ -128,6 +128,13 @@ const lintCommand: CommandModule = {
           description: 'path/URL to a ruleset file',
           type: 'string',
         },
+        parser: {
+          alias: 'p',
+          description: 'which parser should be used to read the file (defaults to Yaml)',
+          type: 'string',
+          choices: ['Yaml', 'Json'],
+          default: 'Yaml',
+        },
         'fail-severity': {
           alias: 'F',
           description: 'results of this level or above will trigger a failure exit code',
@@ -178,6 +185,7 @@ const lintCommand: CommandModule = {
       format,
       output,
       encoding,
+      parser,
       ignoreUnknownFormat,
       failOnUnmatchedGlobs,
       showDocumentationUrl,
@@ -193,6 +201,7 @@ const lintCommand: CommandModule = {
         format,
         output,
         encoding,
+        parser,
         ignoreUnknownFormat,
         failOnUnmatchedGlobs,
         showDocumentationUrl,

packages/cli/src/services/config.ts

@@ -1,4 +1,5 @@
 import { Dictionary } from '@stoplight/types';
+import type * as Parsers from '@stoplight/spectral-parsers';
 import { HumanReadableDiagnosticSeverity } from '@stoplight/spectral-core';
 
 export type FailSeverity = HumanReadableDiagnosticSeverity;
@@ -24,6 +25,7 @@ export interface ILintConfig {
   output?: Dictionary<string>;
   resolver?: string;
   ruleset?: string;
+  parser?: keyof Pick<typeof Parsers, 'Json' | 'Yaml'>;
   stdinFilepath?: string;
   ignoreUnknownFormat: boolean;
   failOnUnmatchedGlobs: boolean;

packages/cli/src/services/linter/linter.ts

@@ -44,7 +44,7 @@ export async function lint(documents: Array<number | string>, flags: ILintConfig
       console.info(`Linting ${targetUri}`);
     }
 
-    const document = await createDocument(targetUri, { encoding: flags.encoding }, flags.stdinFilepath ?? '<STDIN>');
+    const document = await createDocument(targetUri, { encoding: flags.encoding }, flags.stdinFilepath ?? '<STDIN>', flags.parser);
 
     results.push(
       ...(await spectral.run(document, {
@@ -63,7 +63,18 @@ const createDocument = async (
   identifier: string | number,
   opts: IFileReadOptions,
   source: string,
-): Promise<Document<unknown, Parsers.YamlParserResult<unknown>>> => {
+  parser: ILintConfig['parser'] = 'Yaml'
+) => {
+  if (parser === "Json") {
+    // Due to type issues, the parser cannot be dynamically resolved using something like Parsers[parser]
+    // This causes new Document() to fail for Json types.
+    if (typeof identifier === 'string') {
+      return new Document(await readParsable(identifier, opts), Parsers.Json, identifier);
+    }
+
+    return new Document(await readFileDescriptor(identifier, opts), Parsers.Json, source);
+  }
+
   if (typeof identifier === 'string') {
     return new Document(await readParsable(identifier, opts), Parsers.Yaml, identifier);
   }

test-harness/scenarios/formats/too-few-outputs.scenario

@@ -29,6 +29,7 @@ Options:
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [boolean] [default: false]
       --show-documentation-url   show documentation url in output result  [boolean] [default: false]
+  -p, --parser                   which parser should be used to read the file (defaults to Yaml)  [string] [choices: "Yaml", "Json"] [default: "Yaml"]
   -v, --verbose                  increase verbosity  [boolean]
   -q, --quiet                    no logging - output only  [boolean]
 

test-harness/scenarios/formats/too-many-outputs.scenario

@@ -29,6 +29,7 @@ Options:
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [boolean] [default: false]
       --show-documentation-url   show documentation url in output result  [boolean] [default: false]
+  -p, --parser                   which parser should be used to read the file (defaults to Yaml)  [string] [choices: "Yaml", "Json"] [default: "Yaml"]
   -v, --verbose                  increase verbosity  [boolean]
   -q, --quiet                    no logging - output only  [boolean]
 

test-harness/scenarios/formats/unmatched-outputs.scenario

@@ -29,6 +29,7 @@ Options:
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [boolean] [default: false]
       --show-documentation-url   show documentation url in output result  [boolean] [default: false]
+  -p, --parser                   which parser should be used to read the file (defaults to Yaml)  [string] [choices: "Yaml", "Json"] [default: "Yaml"]
   -v, --verbose                  increase verbosity  [boolean]
   -q, --quiet                    no logging - output only  [boolean]
 

test-harness/scenarios/help-no-document.scenario

@@ -30,6 +30,7 @@ Options:
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [boolean] [default: false]
       --show-documentation-url   show documentation url in output result  [boolean] [default: false]
+  -p, --parser                   which parser should be used to read the file (defaults to Yaml)  [string] [choices: "Yaml", "Json"] [default: "Yaml"]
   -v, --verbose                  increase verbosity  [boolean]
   -q, --quiet                    no logging - output only  [boolean]