feat(cli): use Content-Type header to detect ruleset format (#2272)

stoplightio · Oct 24, 2022 · b4c3c11 · b4c3c11
1 parent f3fb425
commit b4c3c11
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 10 deletions.
diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -40,7 +40,7 @@
     "@stoplight/spectral-parsers": "^1.0.1",
     "@stoplight/spectral-ref-resolver": "1.0.2",
     "@stoplight/spectral-ruleset-bundler": "^1.0.0",
-    "@stoplight/spectral-ruleset-migrator": "^1.5.0",
+    "@stoplight/spectral-ruleset-migrator": "^1.9.0",
     "@stoplight/spectral-rulesets": ">=1",
     "@stoplight/spectral-runtime": "^1.1.0",
     "@stoplight/types": "12.3.0",

diff --git a/packages/cli/src/services/__tests__/linter.test.ts b/packages/cli/src/services/__tests__/linter.test.ts
@@ -313,7 +313,7 @@ describe('Linter service', () => {
           .persist()
           .get('/ruleset.json')
           .replyWithFile(200, join(__dirname, '__fixtures__/ruleset.json'), {
-            'Content-Type': 'application/yaml',
+            'Content-Type': 'application/json',
           });
 
         const output = await run(`lint ${validOas3SpecPath} -r http://foo.local/ruleset.json`);
@@ -326,6 +326,45 @@ describe('Linter service', () => {
           ]),
         );
       });
+
+      it('fallbacks to Content-Type', async () => {
+        nock('http://foo.local')
+          .persist()
+          .get('/ruleset')
+          .replyWithFile(200, join(__dirname, '__fixtures__/ruleset.json'), {
+            'Content-Type': 'application/json',
+          });
+
+        const output = await run(`lint ${validOas3SpecPath} -r http://foo.local/ruleset`);
+        expect(output).toEqual(expect.arrayContaining([expect.objectContaining({ code: 'info-matches-stoplight' })]));
+        expect(output).toEqual(
+          expect.not.arrayContaining([
+            expect.objectContaining({
+              message: 'Info object should contain `contact` object',
+            }),
+          ]),
+        );
+      });
+
+      it('ignores query parameters', async () => {
+        nock('http://foo.local')
+          .persist()
+          .get('/ruleset.json')
+          .query({ token: 'bar' })
+          .replyWithFile(200, join(__dirname, '__fixtures__/ruleset.json'), {
+            'Content-Type': 'text/plain', // GitHub raw like
+          });
+
+        const output = await run(`lint ${validOas3SpecPath} -r http://foo.local/ruleset.json?token=bar`);
+        expect(output).toEqual(expect.arrayContaining([expect.objectContaining({ code: 'info-matches-stoplight' })]));
+        expect(output).toEqual(
+          expect.not.arrayContaining([
+            expect.objectContaining({
+              message: 'Info object should contain `contact` object',
+            }),
+          ]),
+        );
+      });
     });
   });
 

diff --git a/packages/cli/src/services/linter/utils/getRuleset.ts b/packages/cli/src/services/linter/utils/getRuleset.ts
@@ -5,7 +5,7 @@ import * as path from '@stoplight/path';
 import * as process from 'process';
 import { createRequire } from 'module';
 import { fetch } from '@stoplight/spectral-runtime';
-import { migrateRuleset } from '@stoplight/spectral-ruleset-migrator';
+import { migrateRuleset, isBasicRuleset } from '@stoplight/spectral-ruleset-migrator';
 import { bundleRuleset } from '@stoplight/spectral-ruleset-bundler';
 import { node } from '@stoplight/spectral-ruleset-bundler/presets/node';
 import { stdin } from '@stoplight/spectral-ruleset-bundler/plugins/stdin';
@@ -25,10 +25,6 @@ async function getDefaultRulesetFile(): Promise<Optional<string>> {
   return;
 }
 
-function isBasicRuleset(filepath: string): boolean {
-  return /\.(json|ya?ml)$/.test(path.extname(filepath));
-}
-
 function isErrorWithCode(error: Error | (Error & { code: unknown })): error is Error & { code: string } {
   return 'code' in error && typeof error.code === 'string';
 }
@@ -49,7 +45,7 @@ export async function getRuleset(rulesetFile: Optional<string>): Promise<Ruleset
   let ruleset: string;
 
   try {
-    if (isBasicRuleset(rulesetFile)) {
+    if (await isBasicRuleset(rulesetFile)) {
       const migratedRuleset = await migrateRuleset(rulesetFile, {
         format: 'esm',
         fs,

diff --git a/yarn.lock b/yarn.lock
@@ -2514,7 +2514,7 @@ __metadata:
     "@stoplight/spectral-parsers": ^1.0.1
     "@stoplight/spectral-ref-resolver": 1.0.2
     "@stoplight/spectral-ruleset-bundler": ^1.0.0
-    "@stoplight/spectral-ruleset-migrator": ^1.5.0
+    "@stoplight/spectral-ruleset-migrator": ^1.9.0
     "@stoplight/spectral-rulesets": ">=1"
     "@stoplight/spectral-runtime": ^1.1.0
     "@stoplight/types": 12.3.0
@@ -2660,7 +2660,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@stoplight/spectral-ruleset-migrator@^1.5.0, @stoplight/spectral-ruleset-migrator@^1.7.4, @stoplight/spectral-ruleset-migrator@workspace:packages/ruleset-migrator":
+"@stoplight/spectral-ruleset-migrator@^1.7.4, @stoplight/spectral-ruleset-migrator@^1.9.0, @stoplight/spectral-ruleset-migrator@workspace:packages/ruleset-migrator":
   version: 0.0.0-use.local
   resolution: "@stoplight/spectral-ruleset-migrator@workspace:packages/ruleset-migrator"
   dependencies: