@thegetty/quire-cli 1.0.0-rc.35 → 1.0.0-rc.37

package/schemas/objects.schema.json

@@ -2,7 +2,6 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Objects Schema",
   "type": "object",
-
   "required": [
     "object_card",
     "object_display_order",
@@ -12,23 +11,17 @@
   "properties": {
     "object_filters": {
       "type": "array",
-      "items": {
-        "type": "string"
-      },
+      "items": { "type": "string" },
       "minItems": 0
     },
     "object_card": {
       "type": "array",
-      "items": {
-        "type": "string"
-      },
+      "items": { "type": "string" },
       "minItems": 0
     },
     "object_display_order": {
       "type": "array",
-      "items": {
-        "type": "string"
-      },
+      "items": { "type": "string" },
       "minItems": 0
     },
     "object_list": {
@@ -36,39 +29,20 @@
       "items": {
         "type": "object",
         "properties": {
-          "id": {
-            "type": "string"
-          },
-          "title": {
-            "type": "string"
-          },
-          "artist": {
-            "type": "string"
-          },
-          "year": {
-            "type": "integer"
-          },
-          "medium": {
-            "type": "string"
-          },
-          "dimensions": {
-            "type": "string"
-          },
-          "location": {
-            "type": "string"
-          },
-          "link": {
-            "type": "string",
-            "format": "uri"
-          },
+          "id": { "type": "string" },
+          "title": { "type": "string" },
+          "artist": { "type": "string" },
+          "year": { "type": "string" },
+          "medium": { "type": "string" },
+          "dimensions": { "type": "string" },
+          "location": { "type": "string" },
+          "link": { "type": "string", "format": "uri" },
           "figure": {
             "type": "array",
             "items": {
               "type": "object",
               "properties": {
-                "id": {
-                  "type": "string"
-                }
+                "id": { "type": "string" }
               },
               "required": [
                 "id"

package/schemas/publication.schema.json

@@ -2,7 +2,6 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "Publication Schema",
   "type": "object",
-
   "required": [
     "url",
     "title",
@@ -21,15 +20,12 @@
     "revision_history",
     "promo_image"
   ],
-
   "properties": {
     "url": { "type": "string" },
     "title": { "type": "string" },
     "subtitle": { "type": "string" },
-
     "reading_line": { "type": ["string", "null"] },
     "short_title": { "type": ["string", "null"] },
-
     "description": {
       "type": "object",
       "required": ["full"],
@@ -38,7 +34,6 @@
         "full": { "type": "string" }
       }
     },
-
     "pub_date": { 
         "oneOf": [
             { "type": "string" },
@@ -46,50 +41,38 @@
   ] },
     "language": { "type": "string" },
     "pub_type": { "type": "string" },
-
     "identifier": {
       "type": "object",
       "properties": {
         "isbn": { "type": ["string", "null"] }
       }
     },
-
     "publisher": {
       "type": "array",
       "items": { "$ref": "#/definitions/publisher" }
     },
-
     "contributor_as_it_appears": { "type": ["string", "null"] },
-
     "contributor": {
       "type": "array",
       "items": { "$ref": "#/definitions/contributor" }
     },
-
     "copyright": { "type": "string" },
-
     "license": { "$ref": "#/definitions/license" },
-
     "resource_link": {
       "type": "array",
       "items": { "$ref": "#/definitions/resourceLink" }
     },
-
     "subject": {
       "type": "array",
       "items": { "$ref": "#/definitions/subject" }
     },
-
     "revision_history": {
       "type": "array",
       "items": { "$ref": "#/definitions/revision" }
     },
-
     "repository_url": { "type": ["string", "null"] },
-
     "promo_image": { "type": "string" }
   },
-
   "definitions": {
     "publisher": {
       "type": "object",
@@ -101,7 +84,6 @@
         "logo": { "type": ["string", "null"] }
       }
     },
-
     "contributor": {
       "type": "object",
       "required": ["id", "type", "first_name", "last_name"],
@@ -117,7 +99,6 @@
         "image": { "type": ["string", "null"] }
       }
     },
-
     "license": {
       "type": "object",
       "required": ["name", "abbreviation", "url", "scope"],
@@ -128,7 +109,6 @@
         "scope": { "type": "string" }
       }
     },
-
     "resourceLink": {
       "type": "object",
       "required": ["type", "name", "link_relation"],
@@ -140,7 +120,6 @@
         "url": { "type": ["string", "null"] }
       }
     },
-
     "subject": {
       "type": "object",
       "required": ["type", "name"],
@@ -150,7 +129,6 @@
         "identifier": { "type": ["string", "null"] }
       }
     },
-
     "revision": {
       "type": "object",
       "properties": {

package/schemas/references.schema.json

@@ -2,7 +2,6 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "title": "References Schema",
   "type": "object",
-
   "required": [
     "entries"
   ],

package/src/Command.js

@@ -1,4 +1,6 @@
 import config from '#src/lib/conf/config.js'
+import createLogger from '#lib/logger/index.js'
+import createDebug from '#debug'
 
 /**
  * Command
@@ -13,10 +15,13 @@ export default class Command {
 
   /**
    * @typedef CommandDefinition
-   * @property {String} name
-   * @property {String} alias
-   * @property {Array<String>} aliases
-   * @property {String} descriptions
+   * @property {String} name - Command name used to invoke it
+   * @property {String} alias - Single alias for the command
+   * @property {Array<String>} aliases - Multiple aliases for the command
+   * @property {String} description - Full description shown in command's own help
+   * @property {String} summary - One-line summary shown in parent help listing
+   * @property {String} [docsLink] - Path appended to docs base URL (e.g., 'quire-commands/#output-files')
+   * @property {String} [helpText] - Custom help text shown after built-in help (examples, notes)
    * @property {Array<CommandArgument>} args
    * @property {Array<CommandOption>} options
    * @property {String} version
@@ -32,12 +37,24 @@ export default class Command {
    * @param {CommandDefinition}  definition  The definition
    */
   constructor(definition) {
-    if (this.constructor.prototype === Command) {
+    if (this.constructor === Command) {
       throw new Error('Command is an *abstract* class')
     }
 
     this.config = config // quire-cli configuration
 
+    /**
+     * Command-specific debug instance for internal debugging
+     * Enable via: DEBUG=quire:commands:name or DEBUG=quire:commands:*
+     */
+    this.debug = createDebug(`commands:${definition.name}`)
+
+    /**
+     * Command-specific logger with prefix including command name
+     * Output format: [quire] LEVEL commands:name message
+     */
+    this.logger = createLogger(`commands:${definition.name}`)
+
     /**
      * Merge and deduplicate command definition alias and aliases
      * Nota bene: Only the first command alias is displayed in the help.
@@ -48,6 +65,9 @@ export default class Command {
     this.name = definition.name
     this.aliases = definition.aliases
     this.description = definition.description
+    this.summary = definition.summary
+    this.docsLink = definition.docsLink
+    this.helpText = definition.helpText
     this.args = definition.args
     this.options = definition.options
     this.version = definition.version
@@ -55,7 +75,7 @@ export default class Command {
   }
 
   definition() {
-    return this.prototype.definition
+    return this.constructor.definition
   }
 
   action() {

package/src/Command.spec.js

@@ -0,0 +1,99 @@
+import Command from './Command.js'
+import test from 'ava'
+
+/**
+ * Command Base Class Unit Tests
+ *
+ * Tests the abstract Command base class API contract.
+ * These tests verify the class cannot be instantiated directly
+ * and that the base methods behave correctly.
+ */
+
+test('Command cannot be instantiated directly', (t) => {
+  const error = t.throws(() => {
+    new Command({ name: 'test', description: 'test command' })
+  })
+
+  t.truthy(error)
+  t.regex(error.message, /abstract/i, 'error message should mention abstract')
+})
+
+test('Command.action() throws not-implemented error', (t) => {
+  // Create a minimal subclass that does not override action
+  class TestCommand extends Command {
+    constructor() {
+      super({ name: 'test', description: 'test command' })
+    }
+  }
+
+  const command = new TestCommand()
+  const error = t.throws(() => command.action())
+
+  t.truthy(error)
+  t.regex(error.message, /not been implemented/i, 'error message should indicate not implemented')
+  t.regex(error.message, /test/i, 'error message should include the command name')
+})
+
+test('subclass can override action without error', (t) => {
+  class TestCommand extends Command {
+    constructor() {
+      super({ name: 'test', description: 'test command' })
+    }
+
+    action() {
+      return 'action executed'
+    }
+  }
+
+  const command = new TestCommand()
+  const result = command.action()
+
+  t.is(result, 'action executed')
+})
+
+test('Command constructor sets properties from definition', (t) => {
+  const definition = {
+    name: 'test',
+    description: 'A test command',
+    summary: 'test summary',
+    aliases: ['t', 'tst'],
+    args: [['<input>', 'input file']],
+    options: [['--verbose', 'enable verbose output']],
+    version: '1.0.0',
+    hidden: true,
+  }
+
+  class TestCommand extends Command {
+    constructor() {
+      super(definition)
+    }
+
+    action() {}
+  }
+
+  const command = new TestCommand()
+
+  t.is(command.name, 'test')
+  t.is(command.description, 'A test command')
+  t.is(command.summary, 'test summary')
+  t.deepEqual(command.aliases, ['t', 'tst'])
+  t.deepEqual(command.args, [['<input>', 'input file']])
+  t.deepEqual(command.options, [['--verbose', 'enable verbose output']])
+  t.is(command.version, '1.0.0')
+  t.is(command.hidden, true)
+})
+
+test('Command constructor injects shared configuration', (t) => {
+  class TestCommand extends Command {
+    constructor() {
+      super({ name: 'test', description: 'test command' })
+    }
+
+    action() {}
+  }
+
+  const command = new TestCommand()
+
+  t.truthy(command.config, 'config should be injected')
+  t.is(typeof command.config.get, 'function', 'config should have get method')
+})