feat(config): add project comment, state divider to config

src/config/index.ts

@@ -5,40 +5,51 @@ import { FlagLabel, StateLabel } from '../labels';
 import { RemoteOptions } from '../remote';
 import * as SCHEMA_DATA from './schema.yml';
 
-/**
- * Config data for the app, loaded from CLI or DOM.
- */
-export interface ConfigData {
-  logger: {
-    level: LogLevel;
-    name: string;
-  };
-  projects: Array<{
-    /**
-     * Color palette for labels without their own.
-     */
-    colors: Array<string>;
+export interface LoggerConfig {
+  level: LogLevel;
+  name: string;
+}
+
+export interface ProjectConfig {
+  /**
+   * Color palette for labels without their own.
+   */
+  colors: Array<string>;
 
-    /**
-     * Individual flag labels.
-     */
-    flags: Array<FlagLabel>;
+  /**
+   * Leave a comment along with any update, explaining the changes that were made.
+   *
+   * @default `true`
+   */
+  comment: boolean;
 
-    /**
-     * Project name or path.
-     */
-    name: string;
+  /**
+   * Individual flag labels.
+   */
+  flags: Array<FlagLabel>;
 
-    /**
-     * Remote APIs.
-     */
-    remote: RemoteOptions;
+  /**
+   * Project name or path.
+   */
+  name: string;
 
-    /**
-     * Grouped state labels.
-     */
-    states: Array<StateLabel>;
-  }>;
+  /**
+   * Remote APIs.
+   */
+  remote: RemoteOptions;
+
+  /**
+   * Grouped state labels.
+   */
+  states: Array<StateLabel>;
+}
+
+/**
+ * Config data for the app, loaded from CLI or DOM.
+ */
+export interface ConfigData {
+  logger: LoggerConfig;
+  projects: Array<ProjectConfig>;
 }
 
 /**
@@ -54,6 +65,7 @@ export function initConfig(): ConfigData {
     },
     projects: [{
       colors: [],
+      comment: true,
       flags: [],
       name: '',
       remote: {
@@ -82,5 +94,11 @@ export function validateConfig(it: unknown): it is ConfigData {
   const ajv = new Ajv(SCHEMA_OPTIONS);
   ajv.addSchema(SCHEMA_DATA, 'cautious-journey');
 
-  return ajv.validate('cautious-journey#/definitions/config', it) === true;
+  if (ajv.validate('cautious-journey#/definitions/config', it) === true) {
+    return true;
+  } else {
+    /* eslint-disable-next-line */
+    console.error('invalid config', ajv.errors, it);
+    return false;
+  }
 }

src/config/schema.yml

@@ -3,12 +3,17 @@ $id: cautious-journey
 definitions:
   label-ref:
     type: object
+    required:
+      - name
     properties:
       name:
         type: string
 
   change-set:
     type: object
+    required:
+      - adds
+      - removes
     properties:
       adds:
         type: array
@@ -23,6 +28,9 @@ definitions:
 
   base-label:
     type: object
+    required:
+      - name
+      - requires
     properties:
       color:
         type: string
@@ -59,7 +67,13 @@ definitions:
       - $ref: "#/definitions/change-set"
       - $ref: "#/definitions/base-label"
       - type: object
+        required:
+          - divider
+          - values
         properties:
+          divider:
+            type: string
+            default: "/"
           values:
             type: array
             items:
@@ -71,45 +85,69 @@ definitions:
       - $ref: "#/definitions/change-set"
       - $ref: "#/definitions/base-label"
       - type: object
+        required:
+          - becomes
         properties:
           becomes:
             type: array
             items:
               $ref: "#/definitions/state-change"
             default: []
 
+  project:
+    type: object
+    required:
+      - colors
+      - comment
+      - flags
+      - name
+      - remote
+      - states
+    properties:
+      colors:
+        type: array
+        items:
+          type: string
+      comment:
+        type: boolean
+        default: true
+      flags:
+        type: array
+        items:
+          $ref: "#/definitions/flag-label"
+        default: []
+      name:
+        type: string
+      remote:
+        type: object
+      states:
+        type: array
+        items:
+          $ref: "#/definitions/state-label"
+        default: []
+
+  logger:
+    type: object
+    required:
+      - level
+      - name
+    properties:
+      level:
+        type: string
+      name:
+        type: string
+
   config:
     type: object
+    required:
+      - logger
+      - projects
     properties:
       logger:
-        type: object
-        properties:
-          level:
-            type: string
-          name:
-            type: string
+        $ref: "#/definitions/logger"
       projects:
         type: array
         items:
-          type: object
-          properties:
-            colors:
-              type: array
-              items:
-                type: string
-            flags:
-              type: array
-              items:
-                $ref: "#/definitions/flag-label"
-              default: []
-            name:
-              type: string
-            remote:
-              type: object
-            states:
-              type: array
-              items:
-                $ref: "#/definitions/state-label"
-              default: []
-
+          $ref: "#/definitions/project"
+
 type: object

src/index.ts

@@ -14,7 +14,7 @@ const STATUS_ERROR = 1;
  */
 main(process.argv).then((status) => process.exit(status)).catch((err: Error) => {
   // eslint-disable-next-line no-console
-  console.error('uncaught error during main:', err);
+  console.error('uncaught error during main:', err.message);
   process.exit(STATUS_ERROR);
 });
 

src/labels.ts

@@ -71,6 +71,8 @@ export interface StateValue extends BaseLabel {
  * Grouped labels: the equivalent of a radio group.
  */
 export interface StateLabel extends BaseLabel {
+  divider: string;
+
   /**
    * Values for this state.
    */
@@ -97,12 +99,12 @@ export function getLabelNames(flags: Array<FlagLabel>, states: Array<StateLabel>
   return new Set(labels);
 }
 
-export function splitValueName(name: string): Array<string> {
-  return name.split('/');
+export function splitValueName(state: StateLabel, name: string): Array<string> {
+  return name.split(state.divider);
 }
 
 export function getValueName(state: StateLabel, value: StateValue): string {
-  return `${state.name}/${value.name}`;
+  return `${state.name}${state.divider}${value.name}`;
 }
 
 /**