@scalar/cli 0.2.204 → 0.2.206

package/README.md

@@ -172,6 +172,20 @@ scalar init
 
 This will create a `scalar.config.json` file for you. All commands will use the configured OpenAPI file by default.
 
+### check
+
+Validate a Scalar Configuration file (`scalar.config.json`), gives helpful hints to fix invalid configurations. To check a `scalar.config.json` in the same folder:
+
+```bash
+scalar check
+```
+
+Or to validate a specific file:
+
+```bash
+scalar check some-custom-folder/scalar.config.json
+```
+
 ## Options
 
 ### --version

package/dist/commands/check/CheckCommand.js

@@ -0,0 +1,62 @@
+import { check } from '@scalar/config';
+import { Command } from 'commander';
+import kleur from 'kleur';
+import fs from 'node:fs';
+import path from 'node:path';
+import { ERRORS } from '../../libs/errors.js';
+import { CONFIG_FILE } from '../../utils/useGivenFileOrConfiguration.js';
+
+/**
+ * Lint users scalar configs (scalar.config.json files)
+ */
+function CheckCommand() {
+    const cmd = new Command('check');
+    cmd.description('Check a Scalar Configuration file');
+    cmd.argument('[file]', 'File to check');
+    cmd.action(async (inputArgument) => {
+        const startTime = performance.now();
+        // Read file
+        const file = path.resolve(inputArgument ?? CONFIG_FILE);
+        // Check if `scalar.config.json` already exists
+        if (!fs.existsSync(file)) {
+            console.log();
+            console.error(kleur.red().bold(`ERROR`));
+            console.error(kleur.red(`Couldn’t find the Scalar Configuration file:`));
+            console.error(kleur.red(file));
+            console.log();
+            process.exit(1);
+        }
+        // Validate
+        const result = check(file);
+        if (result.valid) {
+            console.log();
+            console.log(kleur.green().bold('SUCCESS'));
+            console.log(kleur.green('The Scalar Configuration is valid:'));
+            console.log(kleur.green(file));
+            const endTime = performance.now();
+            console.log();
+            console.log(kleur.green('Scalar Configuration validated'), kleur.grey(`in ${kleur.white(`${kleur.bold(`${Math.round(endTime - startTime)}`)} ms`)}`));
+            console.log();
+        }
+        else {
+            console.log();
+            console.error(kleur.red().bold('ERROR'));
+            console.error(kleur.red(ERRORS.INVALID_SCALAR_CONFIGURATION));
+            console.error(kleur.red(file));
+            result.errors?.forEach((error) => {
+                console.log();
+                if (error.path) {
+                    console.error(kleur.white(`➜ ${error.path}`));
+                }
+                if (error.message) {
+                    console.error(kleur.white(`  ${error.message}`));
+                }
+            });
+            console.log();
+            process.exit(1);
+        }
+    });
+    return cmd;
+}
+
+export { CheckCommand };

package/dist/index.js

@@ -9,6 +9,7 @@ import { ServeCommand } from './commands/serve/ServeCommand.js';
 import { MockCommand } from './commands/mock/MockCommand.js';
 import { VoidCommand } from './commands/void/VoidCommand.js';
 import { ShareCommand } from './commands/share/ShareCommand.js';
+import { CheckCommand } from './commands/check/CheckCommand.js';
 
 const program = new Command();
 program
@@ -25,6 +26,7 @@ program.addCommand(ServeCommand());
 program.addCommand(MockCommand());
 program.addCommand(VoidCommand());
 program.addCommand(ShareCommand());
+program.addCommand(CheckCommand());
 /** display help if no argument has been provided */
 if (process.argv.length === 2) {
     program.help();

package/dist/libs/errors.js

@@ -0,0 +1,6 @@
+/** Centralized list of all error messages */
+const ERRORS = {
+    INVALID_SCALAR_CONFIGURATION: 'The given Scalar Configuration is invalid.',
+};
+
+export { ERRORS };

package/dist/package.json.js

@@ -1,3 +1,3 @@
-var version = "0.2.204";
+var version = "0.2.206";
 
 export { version };

package/dist/src/commands/check/CheckCommand.d.ts

@@ -0,0 +1,6 @@
+import { Command } from 'commander';
+/**
+ * Lint users scalar configs (scalar.config.json files)
+ */
+export declare function CheckCommand(): Command;
+//# sourceMappingURL=CheckCommand.d.ts.map

package/dist/src/commands/check/CheckCommand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CheckCommand.d.ts","sourceRoot":"","sources":["../../../../src/commands/check/CheckCommand.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAQnC;;GAEG;AACH,wBAAgB,YAAY,YAiE3B"}

package/dist/src/commands/check/check.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=check.test.d.ts.map

package/dist/src/commands/check/check.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check.test.d.ts","sourceRoot":"","sources":["../../../../src/commands/check/check.test.ts"],"names":[],"mappings":""}

package/dist/src/commands/index.d.ts

@@ -1,6 +1,7 @@
 export * from './bundle/BundleCommand';
 export * from './format/FormatCommand';
 export * from './init/InitCommand';
+export * from './check/CheckCommand';
 export * from './mock/MockCommand';
 export * from './serve/ServeCommand';
 export * from './share/ShareCommand';

package/dist/src/commands/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,oBAAoB,CAAA;AAClC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,4BAA4B,CAAA;AAC1C,cAAc,oBAAoB,CAAA"}

package/dist/src/libs/errors.d.ts

@@ -0,0 +1,5 @@
+/** Centralized list of all error messages */
+export declare const ERRORS: {
+    readonly INVALID_SCALAR_CONFIGURATION: "The given Scalar Configuration is invalid.";
+};
+//# sourceMappingURL=errors.d.ts.map

package/dist/src/libs/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../../src/libs/errors.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,eAAO,MAAM,MAAM;;CAET,CAAA"}

package/package.json

@@ -16,7 +16,7 @@
     "swagger",
     "cli"
   ],
-  "version": "0.2.204",
+  "version": "0.2.206",
   "engines": {
     "node": ">=18"
   },
@@ -43,12 +43,13 @@
     "hono": "^4.2.7",
     "kleur": "^4.1.5",
     "prettyjson": "^1.2.5",
-    "@scalar/api-reference": "1.25.21",
-    "@scalar/oas-utils": "0.2.47",
+    "@scalar/api-reference": "1.25.23",
+    "@scalar/config": "0.1.0",
+    "@scalar/mock-server": "0.2.53",
+    "@scalar/oas-utils": "0.2.49",
+    "@scalar/void-server": "2.0.11",
     "@scalar/openapi-parser": "0.8.4",
-    "@scalar/mock-server": "0.2.51",
-    "@scalar/openapi-types": "0.1.1",
-    "@scalar/void-server": "2.0.11"
+    "@scalar/openapi-types": "0.1.1"
   },
   "devDependencies": {
     "@rollup/plugin-json": "^6.1.0",
@@ -65,7 +66,7 @@
   "scripts": {
     "@scalar/cli": "pnpm vite-node src/index.ts",
     "build": "scalar-build-rollup",
-    "link:cli": "pnpm run build && npm unlink -g @scalar/cli && npm link",
+    "cli:link": "pnpm run build && npm unlink -g @scalar/cli && npm link",
     "lint:check": "eslint .",
     "lint:fix": "eslint .  --fix",
     "screenshot": "./scripts/take-screenshots.sh",