feat(cli): added parser arg

docs/guides/2-cli.md

@@ -45,6 +45,8 @@ Other options include:
   -D, --display-only-failures    only output results equal to or greater than --fail-severity                    [boolean] [default: false]
       --ignore-unknown-format    do not warn about unmatched formats                                             [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns                                                 [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

@@ -151,6 +151,13 @@ const lintCommand: CommandModule = {
           type: 'boolean',
           default: false,
         },
+        parser: {
+          alias: 'p',
+          description: 'which parser should be used to read the file (defaults to Yaml)',
+          type: 'string',
+          choices: ['Yaml', 'Json'],
+          default: 'Yaml',
+        },
         verbose: {
           alias: 'v',
           description: 'increase verbosity',
@@ -175,6 +182,7 @@ const lintCommand: CommandModule = {
       encoding,
       ignoreUnknownFormat,
       failOnUnmatchedGlobs,
+      parser,
       ...config
     } = args as unknown as ILintConfig & {
       documents: Array<number | string>;
@@ -191,6 +199,7 @@ const lintCommand: CommandModule = {
         failOnUnmatchedGlobs,
         ruleset,
         stdinFilepath,
+        parser,
         ...pick<Partial<ILintConfig>, keyof ILintConfig>(config, ['verbose', 'quiet', 'resolver']),
       });
 

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;
@@ -29,4 +30,5 @@ export interface ILintConfig {
   failOnUnmatchedGlobs: boolean;
   verbose?: boolean;
   quiet?: boolean;
+  parser?: keyof Pick<typeof Parsers, 'Json' | 'Yaml'>;
 }

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

@@ -44,7 +44,12 @@ 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 +68,16 @@ const createDocument = async (
   identifier: string | number,
   opts: IFileReadOptions,
   source: string,
-): Promise<Document<unknown, Parsers.YamlParserResult<unknown>>> => {
+  parser: ILintConfig['parser'] = 'Yaml',
+) => {
+  if (parser === 'Json') {
+    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

@@ -28,6 +28,7 @@ Options:
   -D, --display-only-failures    only output results equal to or greater than --fail-severity  [boolean] [default: false]
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [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

@@ -28,6 +28,7 @@ Options:
   -D, --display-only-failures    only output results equal to or greater than --fail-severity  [boolean] [default: false]
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [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

@@ -28,6 +28,7 @@ Options:
   -D, --display-only-failures    only output results equal to or greater than --fail-severity  [boolean] [default: false]
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [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

@@ -29,6 +29,7 @@ Options:
   -D, --display-only-failures    only output results equal to or greater than --fail-severity  [boolean] [default: false]
       --ignore-unknown-format    do not warn about unmatched formats  [boolean] [default: false]
       --fail-on-unmatched-globs  fail on unmatched glob patterns  [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]