add schema validation and checklist rendering

Author: legomushroom

package.json

@@ -43,6 +43,7 @@
     "jest": "^24.9.0",
     "jest-circus": "^26.4.2",
     "js-yaml": "^3.14.0",
+    "jsonschema": "^1.3.0",
     "prettier": "2.1.1",
     "ts-jest": "^24.3.0",
     "typescript": "^4.0.2",

schemas/IConfig.json

@@ -33,8 +33,21 @@
     "footerFileUrl": {
       "description": "File that will be added as the issue footer.\nExample: \"https://raw.githubusercontent.com/legomushroom/codespaces-board/main/sprints/sprint%2012/footer.md\"",
       "type": "string"
+    },
+    "isReplaceProjectMarkers": {
+      "description": "If replace the <!-- codespaces-board:project_{id}:start -->\nmarkers instead of replacing entire issue body.\n\ndefault: false.",
+      "type": "boolean"
+    },
+    "$schema": {
+      "description": "Used by `vscode` in JSON files.",
+      "type": "string"
     }
   },
+  "additionalProperties": false,
+  "required": [
+    "boardIssue",
+    "repos"
+  ],
   "definitions": {
     "IRepoSourceConfig": {
       "type": "object",
@@ -61,7 +74,12 @@
             ]
           }
         }
-      }
+      },
+      "additionalProperties": false,
+      "required": [
+        "owner",
+        "repo"
+      ]
     },
     "IProject": {
       "type": "object",
@@ -76,8 +94,16 @@
           "items": {
             "type": "string"
           }
+        },
+        "isCheckListItems": {
+          "description": "If to render issues as check list using the [x] markers.\n\ndefault: false",
+          "type": "boolean"
         }
-      }
+      },
+      "additionalProperties": false,
+      "required": [
+        "id"
+      ]
     }
   },
   "$schema": "http://json-schema.org/draft-07/schema#"

scripts/generate-json-schema.js

@@ -12,7 +12,11 @@ if (!fs.existsSync(OUTPUT_SCHEMA_FOLDER_PATH)){
 }
 
 // schema generator settings
-const settings = {};
+const settings = {
+  required: true,
+  strictNullChecks: true,
+  noExtraProps: true,
+};
 
 // ts compiler options
 const compilerOptions = {

src/config.ts

@@ -1,7 +1,27 @@
+import { Schema, Validator } from 'jsonschema';
+import * as path from 'path';
+
+import { PROJECT_ROOT } from './constants';
+
 import { IConfig } from './interfaces/IConfig';
 
 export const getConfigs = (configFilePath: string): IConfig[] => {
-    const configs = require(configFilePath);
+  const configs = require(path.join(PROJECT_ROOT, configFilePath));
+
+  return configs;
+};
+
+export const getConfigSchema = (): Schema => {
+  const schema = require(path.join(PROJECT_ROOT, `./schemas/IConfig.json`));
+
+  return schema;
+};
+
+export const validateConfig = (config: unknown) => {
+  const validator = new Validator();
+
+  const validationResult = validator.validate(config, getConfigSchema());
+  const { errors } = validationResult;
 
-    return configs;
+  return errors;
 };

src/constants.ts

@@ -1 +1,3 @@
-export const PROJECT_ROOT = '../';
+import * as path from 'path';
+
+export const PROJECT_ROOT = path.join(__dirname, '../');

src/interfaces/IConfig.ts

@@ -47,4 +47,17 @@ export interface IConfig {
    * Example: "https://raw.githubusercontent.com/legomushroom/codespaces-board/main/sprints/sprint%2012/footer.md"
    */
   footerFileUrl?: string;
+
+  /**
+   * If replace the <!-- codespaces-board:project_{id}:start -->
+   * markers instead of replacing entire issue body.
+   *
+   * default: false.
+   */
+  isReplaceProjectMarkers?: boolean;
+
+  /**
+   * Used by `vscode` in JSON files.
+   */
+  ['$schema']?: string,
 }

src/interfaces/IIssueState.ts

@@ -0,0 +1,4 @@
+export enum IIssueState {
+    Open = 'open',
+    Closed = 'closed',
+}

src/interfaces/IProject.ts

@@ -5,9 +5,17 @@ export interface IProject {
    * @TJS-type integer
    */
   id: number;
+
   /**
    * Issue labels that will be rendered as sections
    * on the aggregated issue.
    */
   trackLabels?: string[];
+
+  /**
+   * If to render issues as check list using the [x] markers.
+   *
+   * default: false
+   */
+  isCheckListItems?: boolean;
 }

src/interfaces/IProjectWithConfig.ts

@@ -0,0 +1,8 @@
+import { TProject } from './TProject';
+import { TProjectConfig } from './TProjetConfig';
+
+
+export interface IProjectWithConfig {
+  project: TProject;
+  projectConfig: TProjectConfig;
+}