Added JSON schemas to aid with CLI implementations

Author: maxbilbow

.gitignore

@@ -4,4 +4,5 @@
 /build
 **/.DS_Store
 /.idea
-/coverage
+/coverage
+generated

.prettierignore

@@ -7,3 +7,4 @@ coverage
 *.md
 package-lock.json
 package.json
+generated

package-lock.json

@@ -9,7 +9,8 @@
     },
     "scripts": {
         "prebuild": "rimraf dist",
-        "build": "tsc --build ./src/lib/tsconfig.json",
+        "build": "npm run schemas && tsc --build ./src/lib/tsconfig.json",
+        "schemas": "json2ts -i schemas/ -o src/lib/generated/",
         "preversion": "npm run lint && npm run test && npm run build",
         "prepublishOnly": "npm run build",
         "test": "jest",
@@ -43,6 +44,7 @@
         "eslint": "^8.36.0",
         "jest": "^29.5.0",
         "jest-environment-node": "^29.5.0",
+        "json-schema-to-typescript": "^13.0.1",
         "prettier": "^2.8.8",
         "rimraf": "^4.4.0",
         "ts-jest": "^29.1.0"

package.json

@@ -0,0 +1,44 @@
+{
+  "$id": "https://raw.githubusercontent.com/main/schemas/GenerationResponse.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Ng2rGenerationResponse",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "prompt": {
+      "type": "string",
+      "description": "The prompted used to generate this response"
+    },
+    "result": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/GeneratedCode"
+      }
+    }
+  },
+  "required": [
+    "prompt",
+    "result"
+  ],
+  "$defs": {
+    "GeneratedCode": {
+      "type": "object",
+      "title": "Ng2rGeneratedCode",
+      "additionalProperties": false,
+      "properties": {
+        "jsx": {
+          "type": "string",
+          "description": "The generated JSX or TSX"
+        },
+        "markdown": {
+          "type": "string",
+          "description": "The full response in Markdown format"
+        }
+      },
+      "required": [
+        "jsx",
+        "markdown"
+      ]
+    }
+  }
+}

schemas/GenerationResponse.json

@@ -0,0 +1,56 @@
+{
+  "$id": "https://raw.githubusercontent.com/main/schemas/SearchResponse.json",
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Ng2rSearchResult",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["result"],
+  "properties": {
+    "result": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/ComponentInfo"
+      }
+    }
+  },
+  "$defs": {
+    "ComponentInfo": {
+      "type": "object",
+      "title": "Ng2rComponent",
+      "additionalProperties": false,
+      "required": [
+        "name",
+        "file",
+        "location"
+      ],
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "The name of the AngularJS component"
+        },
+        "file": {
+          "type": "string",
+          "description": "The name of the file"
+        },
+        "location": {
+          "type": "object",
+          "title": "Location",
+          "required": [
+            "start",
+            "end"
+          ],
+          "description": "the location of the component within the file",
+          "additionalProperties": false,
+          "properties": {
+            "start": {
+              "type": "integer"
+            },
+            "end": {
+              "type": "integer"
+            }
+          }
+        }
+      }
+    }
+  }
+}

schemas/SearchResult.json

@@ -8,7 +8,7 @@ module.exports = {
         sourceType: 'module',
         tsconfigRootDir: __dirname,
     },
-    ignorePatterns: ['node_modules', 'dist', 'coverage', '.eslintrc.cjs', 'templates', 'test_data'],
+    ignorePatterns: ['node_modules', 'dist', 'coverage', '.eslintrc.cjs', 'templates', 'test_data', 'generated'],
     rules: {
         quotes: ['error', 'single'],
         semi: ['error', 'never'],

src/.eslintrc.cjs

@@ -3,11 +3,12 @@ import {ConvertComponentArgs} from '../cliArgs'
 import path from 'path'
 import {onComplete} from '../io/writeOutput'
 import fs from 'fs'
+import {Ng2RGenerationResponse} from '../generated/GenerationResponse'
 
 export default async function convertCmd({cwd, ...ng2ReactArgs}: ConvertComponentArgs) {
     const absoluteFilePath = path.join(cwd, ng2ReactArgs.file)
     const fileContent = fs.readFileSync(absoluteFilePath, 'utf-8')
     const {prompt, results} = await convert(fileContent, ng2ReactArgs)
 
-    onComplete({prompt, result: results})
+    onComplete({prompt, result: results} satisfies Ng2RGenerationResponse)
 }

src/lib/commands/convertCmd.ts

@@ -3,11 +3,12 @@ import {GenerateTestArgs} from '../cliArgs'
 import path from 'path'
 import {onComplete} from '../io/writeOutput'
 import fs from 'fs'
+import {Ng2RGenerationResponse} from '../generated/GenerationResponse'
 
 export default async function generateReactTestCmd({cwd, file, ...ng2ReactArgs}: GenerateTestArgs) {
     const absoluteFilePath = path.join(cwd, file)
     const fileContent = fs.readFileSync(absoluteFilePath, 'utf-8')
     const {prompt, results} = await generateReactTest(fileContent, ng2ReactArgs)
 
-    onComplete({prompt, result: results})
+    onComplete({prompt, result: results} satisfies Ng2RGenerationResponse)
 }

src/lib/commands/generateReactTestCmd.ts

@@ -2,8 +2,8 @@ import { search } from '@ng2react/core'
 import { CliArgs } from '../cliArgs'
 import path from 'path'
 import { onComplete } from '../io/writeOutput'
-import { ComponentInfo } from '../model/SearchResult'
 import fs from 'fs'
+import type {Ng2RComponent} from '../generated/SearchResult'
 
 export default function searchCmd({ file, cwd }: CliArgs): void {
     const fileContent = fs.readFileSync(path.join(cwd, file), 'utf-8')
@@ -20,7 +20,7 @@ export default function searchCmd({ file, cwd }: CliArgs): void {
                     start: c.node.getStart(),
                     end: c.node.getEnd(),
                 },
-            } satisfies ComponentInfo)
+            } satisfies Ng2RComponent)
     )
 
     onComplete({ result })

src/lib/commands/searchCmd.ts

@@ -1,7 +1,7 @@
-import {SearchResult} from '../model/SearchResult'
-import {ConvertResult} from '../model/ConvertResult'
+import {Ng2RSearchResult} from '../generated/SearchResult'
+import {Ng2RGenerationResponse} from '../generated/GenerationResponse'
 
-export function onComplete(output: SearchResult | ConvertResult): void {
+export function onComplete(output: Ng2RSearchResult | Ng2RGenerationResponse): void {
     // For json output, we want to write the full object to stdout
     const json = JSON.stringify(output)
     process.stdout.write(json)