feat(api): add capability to create empty route handlers

djMax · djMax · commit 7372a91b95f4 · 2023-07-18T11:33:30.000-04:00
diff --git a/package.json b/package.json
@@ -31,34 +31,38 @@
     "*.{js,jsx,ts,tsx}": "yarn eslint src --cache --fix"
   },
   "devDependencies": {
-    "@commitlint/cli": "^17.6.3",
-    "@commitlint/config-conventional": "^17.6.3",
-    "@openapi-typescript-infra/coconfig": "^3.0.1",
+    "@commitlint/cli": "^17.6.6",
+    "@commitlint/config-conventional": "^17.6.6",
+    "@openapi-typescript-infra/coconfig": "^3.2.0",
     "@types/configstore": "^6.0.0",
     "@types/handlebars-helpers": "^0.5.3",
     "@types/minimist": "^1.2.2",
-    "@types/node": "^20.2.4",
+    "@types/node": "^20.4.2",
     "@types/parse-git-config": "^3.0.1",
-    "@typescript-eslint/eslint-plugin": "^5.59.7",
-    "@typescript-eslint/parser": "^5.59.7",
-    "coconfig": "^0.12.0",
-    "eslint": "^8.41.0",
+    "@types/pascalcase": "^1.0.1",
+    "@typescript-eslint/eslint-plugin": "^6.1.0",
+    "@typescript-eslint/parser": "^6.1.0",
+    "coconfig": "^0.12.2",
+    "eslint": "^8.45.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-jest": "^27.2.1",
+    "eslint-plugin-jest": "^27.2.3",
     "husky": "^8.0.3",
-    "lint-staged": "^13.2.2",
+    "lint-staged": "^13.2.3",
     "pinst": "^3.0.0",
-    "prettier": "^2.8.8",
-    "typescript": "^5.0.4"
+    "prettier": "^3.0.0",
+    "typescript": "^5.1.6"
   },
   "packageManager": "yarn@3.5.1",
   "dependencies": {
-    "boxen": "^7.1.0",
+    "@readme/openapi-parser": "^2.5.0",
+    "boxen": "^7.1.1",
     "configstore": "^6.0.0",
     "handlebars-helpers": "^0.10.0",
     "minimist": "^1.2.8",
+    "mkdirp": "^3.0.1",
+    "openapi-types": "^12.1.3",
     "parse-git-config": "^3.0.0",
     "plop": "^3.1.2",
     "plop-pack-git-init": "^0.3.1"
diff --git a/src/apiProject.ts b/src/apiProject.ts
diff --git a/src/dependencies.ts b/src/dependencies.ts
@@ -9,8 +9,8 @@ function sortByKey(deps: Record<string, string>) {
 
 export function dependencies({ features }: { features: string[] }) {
   const deps = {
-    '@openapi-typescript-infra/coconfig': '^3.0.2',
-    '@openapi-typescript-infra/service': '^1.1.0',
+    '@openapi-typescript-infra/coconfig': '^3.2.0',
+    '@openapi-typescript-infra/service': '^1.1.3',
   } as Record<string, string>;
   if (features.includes('db')) {
     Object.assign(deps, {
@@ -28,23 +28,23 @@ export function dependencies({ features }: { features: string[] }) {
 
 export function devDependencies({ features }: { features: string[] }) {
   const deps = {
-    coconfig: '^0.10.1',
+    coconfig: '^0.12.2',
     '@openapi-typescript-infra/service-tester': '^1.0.5',
-    '@typescript-eslint/eslint-plugin': '^5.59.7',
-    '@typescript-eslint/parser': '^5.59.7',
-    '@types/jest': '^29.5.1',
-    eslint: '^8.41.0',
+    '@typescript-eslint/eslint-plugin': '^6.1.0',
+    '@typescript-eslint/parser': '^6.1.0',
+    '@types/jest': '^29.5.3',
+    eslint: '^8.45.0',
     'eslint-config-prettier': '^8.8.0',
     'eslint-plugin-cypress': '^2.13.3',
     'eslint-plugin-import': '^2.27.5',
-    'eslint-plugin-jest': '^27.2.1',
+    'eslint-plugin-jest': '^27.2.3',
     husky: '^8.0.3',
-    jest: '^29.5.0',
+    jest: '^29.6.1',
     'jest-openapi': '^0.14.2',
-    'lint-staged': '^13.2.2',
-    'prettier': '^2.8.8',
-    'ts-jest': '^29.1.0',
-    typescript: '^4.9.5',
+    'lint-staged': '^13.2.3',
+    'prettier': '^3.0.0',
+    'ts-jest': '^29.1.1',
+    typescript: '^5.1.6',
   };
   if (features.includes('db')) {
     Object.assign(deps, {
diff --git a/src/handlers.ts b/src/handlers.ts
@@ -0,0 +1,77 @@
+import fs from 'node:fs';
+import path from 'node:path';
+
+import pascalcase from 'pascalcase';
+import Helpers from 'handlebars-helpers';
+import { mkdirpSync } from 'mkdirp';
+import OpenAPIParser from '@readme/openapi-parser';
+import type { HelperDelegate } from 'handlebars';
+import type { NodePlopAPI } from 'plop';
+
+import { Prompts } from './prompts.js';
+import { useCliAction } from './actions.js';
+
+async function writeMissing(
+  api: string,
+  methods: Record<string, Record<string, { operationId: string; }>>,
+  apiName: string) {
+  const handlerPath = path.join('src', 'handlers', `${api}.ts`);
+  const exists = fs.existsSync(handlerPath);
+  if (!exists) {
+    console.log('Creating', handlerPath);
+    mkdirpSync(path.dirname(handlerPath));
+    fs.writeFileSync(
+      handlerPath,
+      `import type { ${apiName} } from '@/types';
+
+${Object.keys(methods)
+  .filter((f) => !['parameters'].includes(f))
+  .map(
+    (method) =>
+      `export const ${method}: ${apiName}['${methods[method].operationId}'] = async (req, res) => {
+  // TODO - implement ${method} handler
+  res.sendStatus(501);
+};
+`,
+  )}`,
+    );
+  }
+}
+
+// eslint-disable-next-line import/no-default-export
+export default function (plop: NodePlopAPI) {
+  const helpers = Helpers();
+  Object.entries(helpers).forEach(([name, helper]) => {
+    if (!['raw'].includes(name)) {
+      plop.setHelper(name, helper);
+    }
+  });
+  plop.setHelper('ternary', ((test, yes, no) => (test ? yes : no)) as HelperDelegate);
+  useCliAction(plop);
+
+  // controller generator
+  plop.setGenerator('handlers', {
+    description: 'Generate missing API handlers',
+    prompts: [Prompts.handlerWarning],
+    actions() {
+      return [
+        async () => {
+          const pkg = JSON.parse(fs.readFileSync('package.json', 'utf8'));
+          const svcName = pkg.name.split('/').pop();
+          const apiSpec = `api/${svcName}.yaml`;
+          const { paths } = await OpenAPIParser.validate(apiSpec);
+          const apiName = `${pascalcase(svcName)}Api`;
+          if (paths) {
+            Object.entries(paths).forEach(([api, methods]) => writeMissing(api, methods, apiName));
+          }
+          return '';
+        },
+        `
+We have added any missing handler FILES to your project. If new methods
+needed to be added to existing handler files, we did not add those.
+
+Happy hacking!`,
+      ].filter((a) => typeof a === 'object' || typeof a === 'string' || typeof a === 'function');
+    },
+  });
+}
diff --git a/src/index.ts b/src/index.ts
@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+import fs from 'node:fs';
 import path from 'node:path';
 import * as url from 'url';
 
@@ -12,22 +13,41 @@ const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
 async function runPlop() {
   const { Plop, run } = await import('plop');
 
-  Plop.prepare(
-    {
-      cwd: argv.cwd,
-      configPath: path.join(__dirname, 'plopfile.js'),
-      preload: argv.preload || [],
-      completion: argv.completion,
-    },
-    (env) =>
-      Plop.execute(env, (env) => {
-        const options = {
-          ...env,
-          dest: process.cwd(), // this will make the destination path to be based on the cwd when calling the wrapper
-        };
-        return run(options, undefined, true);
-      }),
-  );
+  if (fs.existsSync('package.json')) {
+    Plop.prepare(
+      {
+        cwd: argv.cwd,
+        configPath: path.join(__dirname, 'handlers.js'),
+        preload: argv.preload || [],
+        completion: argv.completion,
+      },
+      (env) =>
+        Plop.execute(env, (env) => {
+          const options = {
+            ...env,
+            dest: process.cwd(), // this will make the destination path to be based on the cwd when calling the wrapper
+          };
+          return run(options, undefined, true);
+        }),
+    );
+  } else {
+    Plop.prepare(
+      {
+        cwd: argv.cwd,
+        configPath: path.join(__dirname, 'apiProject.js'),
+        preload: argv.preload || [],
+        completion: argv.completion,
+      },
+      (env) =>
+        Plop.execute(env, (env) => {
+          const options = {
+            ...env,
+            dest: process.cwd(), // this will make the destination path to be based on the cwd when calling the wrapper
+          };
+          return run(options, undefined, true);
+        }),
+    );
+  }
 }
 
 runPlop();
diff --git a/src/prompts.ts b/src/prompts.ts
@@ -36,6 +36,11 @@ export const Prompts: Record<string, PromptQuestion> = {
     name: 'dirWarning',
     message: `This will create files in the current directory (${process.cwd()}). Continue?`
   },
+  handlerWarning: {
+    type: 'confirm',
+    name: 'handlerWarning',
+    message: `This will create missing handlers for the project in (${process.cwd()}). Continue?`
+  },
   email: {
     type: 'input',
     name: 'email',
diff --git a/templates/all/.gitignore.hbs b/templates/all/.gitignore.hbs
@@ -1,4 +1,5 @@
 # Custom
+src/generated
 .transpiled
 .nyc_output
 .eslintcache
diff --git a/templates/all/Makefile b/templates/all/Makefile
@@ -3,7 +3,7 @@
 
 .PHONY: all build clean
 
-all: service {{#inArray features 'db'}}dbi {{/inArray}}$(word 1, $(build_files))
+all: service {{#inArray features 'db'}}dbi {{/inArray}}ts
 
 {{#inArray features 'db'}}export DB_NAME ?= {{dbName}}
 {{/inArray}}export SERVICE_NAME ?= {{dashCase name}}
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`# Custom`
	`2`	`+src/generated`
`2`	`3`	`.transpiled`
`3`	`4`	`.nyc_output`
`4`	`5`	`.eslintcache`