feat: bring validation schema inline instead of reading from a file

Author: thetutlage

package.json

@@ -33,7 +33,7 @@
     "prepublishOnly": "npm run build",
     "lint": "eslint",
     "format": "prettier --write .",
-    "quick:test": "node --import=@poppinss/ts-exec bin/test.ts"
+    "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts"
   },
   "devDependencies": {
     "@adonisjs/eslint-config": "^3.0.0-next.1",

schemas/command_metadata_schema.json renamed to schemas/command_metadata_schema_stub.json

@@ -7,4 +7,153 @@
  * file that was distributed with this source code.
  */
 
-export const schemaRoot = import.meta.url
+export const schema = {
+  $ref: '#/definitions/CommandMetaData',
+  $schema: 'http://json-schema.org/draft-07/schema#',
+  definitions: {
+    CommandMetaData: {
+      description: 'Command metdata required to display command help.',
+      properties: {
+        aliases: {
+          description: 'Command aliases. The same command can be run using these aliases as well.',
+          items: {
+            type: 'string',
+          },
+          type: 'array',
+        },
+        args: {
+          description: 'Args accepted by the command',
+          items: {
+            additionalProperties: false,
+            properties: {
+              allowEmptyValue: {
+                description:
+                  'Whether or not to allow empty values. When set to false, the validation will fail if the argument is provided an empty string\n\nDefaults to false',
+                type: 'boolean',
+              },
+              argumentName: {
+                type: 'string',
+              },
+              default: {},
+              description: {
+                type: 'string',
+              },
+              name: {
+                type: 'string',
+              },
+              required: {
+                type: 'boolean',
+              },
+              type: {
+                enum: ['string', 'spread'],
+                type: 'string',
+              },
+            },
+            required: ['name', 'argumentName', 'type'],
+            type: 'object',
+          },
+          type: 'array',
+        },
+        commandName: {
+          description: 'The name of the command',
+          type: 'string',
+        },
+        description: {
+          description: 'The command description to show on the help screen',
+          type: 'string',
+        },
+        flags: {
+          description: 'Flags accepted by the command',
+          items: {
+            additionalProperties: false,
+            properties: {
+              alias: {
+                anyOf: [
+                  {
+                    type: 'string',
+                  },
+                  {
+                    items: {
+                      type: 'string',
+                    },
+                    type: 'array',
+                  },
+                ],
+              },
+              allowEmptyValue: {
+                description:
+                  'Whether or not to allow empty values. When set to false, the validation will fail if the flag is mentioned but no value is provided\n\nDefaults to false',
+                type: 'boolean',
+              },
+              default: {},
+              description: {
+                type: 'string',
+              },
+              flagName: {
+                type: 'string',
+              },
+              name: {
+                type: 'string',
+              },
+              required: {
+                type: 'boolean',
+              },
+              showNegatedVariantInHelp: {
+                description:
+                  'Whether or not to display the negated variant in the help output.\n\nApplicable for boolean flags only\n\nDefaults to false',
+                type: 'boolean',
+              },
+              type: {
+                enum: ['string', 'boolean', 'number', 'array'],
+                type: 'string',
+              },
+            },
+            required: ['name', 'flagName', 'type'],
+            type: 'object',
+          },
+          type: 'array',
+        },
+        help: {
+          anyOf: [
+            {
+              type: 'string',
+            },
+            {
+              items: {
+                type: 'string',
+              },
+              type: 'array',
+            },
+          ],
+          description: 'Help text for the command',
+        },
+        namespace: {
+          description: 'Command namespace. The namespace is extracted from the command name',
+          type: ['string', 'null'],
+        },
+        options: {
+          $ref: '#/definitions/CommandOptions',
+          description: 'Command configuration options',
+        },
+      },
+      required: ['aliases', 'args', 'commandName', 'description', 'flags', 'namespace', 'options'],
+      type: 'object',
+    },
+    CommandOptions: {
+      description: 'Static set of command options',
+      properties: {
+        allowUnknownFlags: {
+          description:
+            'Whether or not to allow for unknown flags. If set to false, the command will not run when unknown flags are provided through the CLI\n\nDefaults to false',
+          type: 'boolean',
+        },
+        staysAlive: {
+          description:
+            'When flag set to true, the kernel will not trigger the termination process unless the command explicitly calls the terminate method.\n\nDefaults to false',
+          type: 'boolean',
+        },
+      },
+      type: 'object',
+    },
+  },
+}

schemas/main.ts

@@ -8,16 +8,11 @@
  */
 
 import { Validator } from 'jsonschema'
-import { readFile } from 'node:fs/promises'
 import { RuntimeException } from '@poppinss/utils/exception'
 
-import { schemaRoot } from '../schemas/main.ts'
+import { schema } from '../schemas/main.ts'
 import type { AbstractBaseCommand, CommandMetaData, UIPrimitives } from './types.ts'
 
-const schema = JSON.parse(
-  await readFile(new URL('./command_metadata_schema.json', schemaRoot), 'utf8')
-)
-
 /**
  * Helper to sort array of strings alphabetically.
  */

src/utils.ts

@@ -65,7 +65,7 @@ test.group('Helpers | validateCommandMetaData', () => {
   })
 
   test('work fine when command metadata is complete', ({ assert }) => {
-    assert.doesNotThrows(() =>
+    assert.doesNotThrow(() =>
       validateCommandMetaData(
         {
           commandName: 'serve',
@@ -127,7 +127,7 @@ test.group('Helpers | validateCommand', () => {
       }
     }
 
-    assert.doesNotThrows(
+    assert.doesNotThrow(
       () => validateCommand(MakeController, '"./foo.js" file'),
       'Invalid command exported from "./foo.js" file. requires property "aliases"'
     )