Merge pull request #93 from coderoad/feature/add-id-requirement

require an "id" for a tutorial

Author: ShMcK

src/schema/skeleton.ts

@@ -7,6 +7,12 @@ export default {
   ...meta,
   type: "object",
   properties: {
+    id: {
+      type: "string",
+      description: "A unique identifier for your tutorial. Currently no system to create this, so create your own for now",
+      examples: ["fcc-learn-npm"]
+    },
+    
     version: {
       $ref: "#/definitions/semantic_version",
       description: "The tutorial version. Must be unique for the tutorial.",
@@ -253,5 +259,5 @@ export default {
     },
   },
   additionalProperties: false,
-  required: ["version", "config", "levels"],
+  required: ["id", "version", "config", "levels"],
 };

src/schema/tutorial.ts

@@ -7,6 +7,12 @@ export default {
   ...meta,
   type: "object",
   properties: {
+    id: {
+      type: "string",
+      description: "A unique identifier for your tutorial. Currently no system to create this, so create your own for now",
+      examples: ["fcc-learn-npm"]
+    },
+    
     version: {
       $ref: "#/definitions/semantic_version",
       description: "The tutorial version. Must be unique for the tutorial.",

tests/skeleton.test.ts

@@ -4,6 +4,7 @@ import skeletonSchema from '../src/schema/skeleton'
 const validateSkeleton = (json: any) => validateSchema(skeletonSchema, json)
 
 const validJson = {
+  id: 'coderoad-test',
   version: '0.1.0',
   config: {
     testRunner: {
@@ -95,6 +96,13 @@ describe('validate skeleton', () => {
     const valid = validateSkeleton(json)
     expect(valid).toBe(true)
   })
+  it('should fail if id is missing', () => {
+    const json = { ...validJson, id: undefined }
+
+    const valid = validateSkeleton(json)
+    expect(valid).toBe(false)
+  })
+
   it('should fail if version is invalid', () => {
     const json = { ...validJson, version: 'NOT A VERSION' }
 

tests/tutorial.test.ts

@@ -3,6 +3,7 @@ import tutorialSchema from '../src/schema/tutorial'
 import { validateSchema } from '../src/utils/validateSchema'
 
 const validJson: Partial<T.Tutorial> = {
+  id: 'coderoad-test',
   version: '0.1.0',
   summary: { title: 'Title', description: 'Description' },
   config: {