Feat/template

json-to-pretty-yaml.d.ts

@@ -0,0 +1,3 @@
+declare module 'json-to-pretty-yaml' {
+  function stringify(json: string): string
+}

package.json

@@ -8,8 +8,9 @@
   },
   "scripts": {
     "test": "jest",
-    "dev": "node-dev src/index.ts",
+    "dev": "node-dev src/write-yaml-template.ts",
     "build": "tsc",
+    "postbuild": "node bin/write-yaml-template.js",
     "format": "prettier -w .",
     "lint": "eslint --ignore-path .prettierignore \"**/*.ts\"",
     "lint:fix": "eslint --fix --ignore-path .prettierignore \"**/*.ts\"",
@@ -44,6 +45,7 @@
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.2",
     "jest": "^29.3.1",
+    "json-to-pretty-yaml": "^1.2.2",
     "lint-staged": "^13.0.3",
     "node-dev": "^7.4.3",
     "prettier": "^2.7.1",
@@ -55,7 +57,7 @@
   },
   "lint-staged": {
     "*.{js,ts}": [
-      "npm run typecheck",
+      "npm run typecheck -- --lib ESNext",
       "npm run format",
       "npm run lint:fix"
     ]

src/write-yaml-template.ts

@@ -0,0 +1,45 @@
+import * as fs from 'fs'
+import * as path from 'path'
+import { stringify } from 'json-to-pretty-yaml'
+
+const walk = (dir: string, prevResults?: string[]): string[] => {
+  const list = fs.readdirSync(dir)
+  const results = prevResults || []
+  list.forEach((file) => {
+    file = path.resolve(dir, file)
+    const stat = fs.statSync(file)
+    if (stat && stat.isDirectory()) {
+      walk(file, results)
+    } else {
+      results.push(file)
+    }
+  })
+  return results
+}
+
+;((): void => {
+  fs.mkdirSync('./bin/templates')
+  const jsonPaths = walk('./templates/json')
+  jsonPaths.forEach((jsonPath) => {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    const json = require(jsonPath)
+    const data = stringify(json)
+    const binJsonTemplatesPath = jsonPath.replace(
+      '/templates/',
+      '/bin/templates/',
+    )
+    const binYamlTemplatesPath = binJsonTemplatesPath.replaceAll('json', 'yaml')
+    const jsonDirname = path.dirname(binJsonTemplatesPath)
+    const yamlDirname = path.dirname(binYamlTemplatesPath)
+    const jsonStat = fs.statSync(jsonDirname, { throwIfNoEntry: false })
+    const yamlStat = fs.statSync(jsonDirname, { throwIfNoEntry: false })
+    if (!jsonStat?.isDirectory()) {
+      fs.mkdirSync(jsonDirname)
+    }
+    if (!yamlStat?.isDirectory()) {
+      fs.mkdirSync(yamlDirname)
+    }
+    fs.writeFileSync(binJsonTemplatesPath, data)
+    fs.writeFileSync(binYamlTemplatesPath, data)
+  })
+})()

templates/json/[entryPoint].json

@@ -0,0 +1,14 @@
+{
+  "openapi": "3.0.2",
+  "info": {
+    "title": "Welcome to PATIOS",
+    "description": "Manage large Open API specifications and automatically generate TypeScript definitions",
+    "version": "1.0"
+  },
+  "servers": [{ "url": "https://github.com/theappbusiness/patios/" }],
+  "paths": {
+    "/v1/information": {
+      "$ref": "./paths/information.json"
+    }
+  }
+}

templates/json/attributes/heading.json

@@ -0,0 +1,8 @@
+{
+  "type": "object",
+  "properties": {
+    "heading": {
+      "type": "string"
+    }
+  }
+}

templates/json/examples/content.json

@@ -0,0 +1,3 @@
+{
+  "heading": "Welcome to PATIOS"
+}

templates/json/paths/information.json

@@ -0,0 +1,10 @@
+{
+  "get": {
+    "description": "An example path providing information about PATIOS",
+    "responses": {
+      "200": {
+        "$ref": "../responses/informationSuccess.json"
+      }
+    }
+  }
+}

templates/json/responses/informationSuccess.json

@@ -0,0 +1,10 @@
+{
+  "description": "OK",
+  "content": {
+    "application/json": {
+      "schema": {
+        "$ref": "../schemas/information.json"
+      }
+    }
+  }
+}

templates/json/schemas/information.json

@@ -0,0 +1,16 @@
+{
+  "type": "object",
+  "properties": {
+    "content": {
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "../attributes/heading.json"
+        }
+      ],
+      "example": {
+        "$ref": "../examples/content.json"
+      }
+    }
+  }
+}