Make linter configurable + add some rules

Author: mykulyak

package-lock.json

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('@fresha/openapi-lint/build/index');
+require('@fresha/openapi-lint/cli');

packages/openapi-lint/bin/fresha-openapi-lint.js

@@ -2,10 +2,16 @@
   "name": "@fresha/openapi-lint",
   "version": "0.3.1",
   "description": "Linting tool for OpenAPI schemas",
-  "main": "build/index.js",
   "bin": {
     "fresha-openapi-lint": "./bin/fresha-openapi-lint.js"
   },
+  "main": "build/api.js",
+  "types": "build/api.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./build/api.js",
+    "./cli": "./build/cli.js"
+  },
   "publishConfig": {
     "access": "public"
   },
@@ -63,9 +69,11 @@
     "typescript": "^5.0.2"
   },
   "dependencies": {
+    "@fresha/api-tools-core": "^0.6.1",
     "@fresha/openapi-model": "^0.8.1",
     "chalk": "^4.1.0",
     "glob": "^8.0.3",
+    "yaml": "^2.3.1",
     "yargs": "^17.6.2"
   },
   "gitHead": "5830273395fc060b19d06814b9396ce07eea778d"

packages/openapi-lint/package.json

@@ -0,0 +1,3 @@
+export * from './types';
+export { loadConfigFromFile, createLinter } from './linter';
+export { createFormatter } from './formatters';

packages/openapi-lint/src/Linter.ts

@@ -0,0 +1,70 @@
+import console from 'console';
+
+import { OpenAPIReader, OpenAPIWriter } from '@fresha/openapi-model/build/3.0.3';
+import yargs from 'yargs';
+import { hideBin } from 'yargs/helpers';
+
+import { createFormatter } from './formatters';
+import { loadConfigFromFile, createLinter } from './linter';
+
+try {
+  const argv = yargs(hideBin(process.argv))
+    .epilog(
+      'For more information, see https://github.com/fresha/api-tools/tree/main/packages/openapi-lint',
+    )
+    .usage('Usage: $0 [OPTIONS] FILES')
+    .string('config')
+    .alias('config', 'c')
+    .describe('config', 'Path to configuration file')
+    .boolean('print-config')
+    .describe('print-config', 'Print configuration and exit')
+    .number('max-warnings')
+    .describe('max-warnings', 'Number of warnings to trigger nonzero exit code')
+    .boolean('fix')
+    .describe('fix', 'Automatically fix problems')
+    .choices('formatter', ['simple', 'json'])
+    .default('formatter', 'simple')
+    .alias('formatter', 'f')
+    .boolean('verbose')
+    .alias('verbose', 'v')
+    .describe('verbose', 'Print more information on console')
+    .parseSync();
+
+  const config = loadConfigFromFile(argv.config ?? '.openapi-lint.yaml');
+  if (argv.printConfig) {
+    config.print();
+  }
+
+  const linter = createLinter({
+    config,
+    maxWarnings: argv.maxWarnings ?? -1,
+    autoFix: !!argv.fix,
+    verbose: !!argv.verbose,
+  });
+
+  for (const elem of argv._) {
+    const fpath = String(elem);
+    try {
+      const openapi = new OpenAPIReader().parseFromFile(fpath);
+      openapi.setExtension('__filename', fpath);
+
+      if (linter.run(openapi)) {
+        const writer = new OpenAPIWriter();
+        openapi.deleteExtension('__filename');
+        writer.writeToFile(openapi, fpath);
+      }
+    } catch (err) {
+      if (err instanceof Error) {
+        console.log(err instanceof Error ? err.message : err);
+      }
+    }
+  }
+
+  const formatter = createFormatter(argv.formatter);
+  formatter.format(linter.result);
+
+  process.exit(linter.result.isFailure ? 1 : 0);
+} catch (err) {
+  console.log(err instanceof Error ? err.message : err);
+  process.exit(1);
+}

packages/openapi-lint/src/LinterResult.ts

@@ -0,0 +1,11 @@
+import console from 'console';
+
+import type { Formatter, Result } from '../types';
+
+export class JSONFormatter implements Formatter {
+  // eslint-disable-next-line class-methods-use-this
+  format(result: Result): void {
+    const json = JSON.stringify(result, null, 2);
+    console.log(json);
+  }
+}

packages/openapi-lint/src/api.ts

@@ -0,0 +1,45 @@
+import console from 'console';
+
+import chalk from 'chalk';
+
+import type { Severity, Formatter, Issue, Result } from '../types';
+
+export class SimpleFormatter implements Formatter {
+  // eslint-disable-next-line class-methods-use-this
+  format(result: Result): void {
+    const issuesPerFile = new Map<string, Issue[]>();
+    const severityCount = new Map<Severity, number>();
+
+    for (const issue of result.issues()) {
+      issuesPerFile.set(issue.file, [...(issuesPerFile.get(issue.file) ?? []), issue]);
+      severityCount.set(issue.severity, (severityCount.get(issue.severity) ?? 0) + 1);
+    }
+
+    const fileNames = Array.from(issuesPerFile.keys()).sort();
+    for (const fileName of fileNames) {
+      console.log(fileName);
+      for (const item of issuesPerFile.get(fileName)!) {
+        let str = '  ';
+        if (item.severity === 'error') {
+          str += chalk.red('[error] ');
+        } else if (item.severity === 'warning') {
+          str += chalk.yellow('[warn] ');
+        }
+        str += item.message;
+        console.log(str);
+      }
+    }
+    if (result.issueCount > 0) {
+      let str = 'Summary: ';
+      const errorCount = severityCount.get('error') ?? 0;
+      if (errorCount > 0) {
+        str += chalk.red(`${errorCount} errors`);
+      }
+      const warningCount = severityCount.get('warning') ?? 0;
+      if (warningCount > 0) {
+        str += chalk.red(`${warningCount} warnings`);
+      }
+      console.log(str);
+    }
+  }
+}

packages/openapi-lint/src/cli.ts

@@ -0,0 +1,15 @@
+import { JSONFormatter } from './JSONFormatter';
+import { SimpleFormatter } from './SimpleFormatter';
+
+import type { Formatter } from '../types';
+
+export const createFormatter = (format: string): Formatter => {
+  switch (format) {
+    case 'json':
+      return new JSONFormatter();
+    case 'simple':
+      return new SimpleFormatter();
+    default:
+      throw new Error(`Unknown format: ${format}`);
+  }
+};