feat(dry): use shared Makefile, remove db drop script and update types

Author: djMax

src/plopfile.ts

@@ -90,7 +90,18 @@ export default function (plop: NodePlopAPI) {
           // By default is false, but if "true" will log the output of commands
           verbose: true,
         },
-      ].filter(a => typeof a === 'object');
+        `
+Your project is ready to roll! We ran yarn for you, so your next steps are:
+* Go into the api directory and edit your API specification.
+  You could use https://editor.swagger.io/ and then paste the yaml back in.
+${data?.features.includes('db') ? `* Go into migrations/sql and add your initial database up/down migration to the existing files
+* Run "make db-ci" to create the database and run the migrations.` : ''}
+* Run "yarn test" to just make sure the environment is all sorted out.
+* Run "yarn build" to build the database interface, service types and TS code.
+* Start implementing your API by adding appropriate handler methods.
+
+Happy hacking!`,
+      ].filter(a => typeof a === 'object' || typeof a === 'string');
     },
   });
 }

templates/all/Makefile

@@ -1,52 +1,11 @@
-#!make
-.PHONY: all build clean
-
-src_files := $(shell find src -name '*.ts')
-build_files := $(patsubst src/%.ts,build/%.js,$(src_files))
+# Makefiles are useful for slightly more complex scenarios than npm scripts can easily handle.
+# You can use gulp or whatever other thing you like, but we prefer the simplicity of Make.
 
-export PGUSER ?= postgres
-export PGPASSWORD ?= postgres
-export PGHOST ?= localhost
+.PHONY: all build clean
 
 all: service {{#inArray features 'db'}}dbi {{/inArray}}$(word 1, $(build_files))
 
-ts: $(word 1, $(build_files))
-
-$(word 1, $(build_files)): $(src_files)
-	./node_modules/.bin/tsc -p tsconfig.build.json
-
-clean:
-	yarn dlx rimraf ./build src/generated
-
-service: src/generated/service/index.ts
-
-{{#inArray features 'db'}}
-db-ci:
-	yarn run-pg-sql -q postgres ./migrations/setup/ci_setup.sql
-	yarn run-pg-sql -q postgres ./migrations/setup/db_setup.sql
-	yarn migration:apply
-	yarn run-pg-sql {{dbName}} ./migrations/setup/dev_setup.sql
-
-db-drop:
-	yarn run-pg-sql -q {{dbName}} ./migrations/setup/db_clean.sql || true
-
-db+:
-	yarn migration:apply
-
-db-:
-	yarn migration:undo
-
-db-clean: db-drop db-ci
-
-dbi:
-	echo "Generating database types"
-	DATABASE_URL=postgres://$(PGUSER):$(PGPASSWORD)@$(PGHOST)/{{dbName}} yarn kysely-codegen \
-		--dialect postgres --schema public \
-		--out-file src/generated/database.ts
-{{/inArray}}
+{{#inArray features 'db'}}export DB_NAME ?= {{dbName}}
+{{/inArray}}export SERVICE_NAME ?= {{dashCase name}}
 
-src/generated/service/index.ts: api/{{dashCase name}}.yaml
-	echo "Building service interface"
-	yarn dlx openapi-typescript-express ./api/{{dashCase name}}.yaml \
-		--output ./src/generated/service/index.ts
-	./node_modules/.bin/prettier ./src/generated/service/index.ts --write
+include node_modules/@openapi-typescript-infra/service/Makefile

templates/all/src/index.ts.hbs

@@ -7,12 +7,12 @@ import { Kysely, PostgresDialect } from 'kysely';
 import type { DB } from './generated/database';
 {{else}}
 {{/inArray}}
-import type { {{properCase name}}Service, {{properCase name}}ConfigSchema } from './types';
+import type { {{properCase name}}Locals, {{properCase name}}Service, {{properCase name}}ConfigSchema } from './types';
 
 type Config = {{properCase name}}ConfigSchema;
 
 export function service(): {{properCase name}}Service {
-  const base = useService();
+  const base = useService<{{properCase name}}Locals>();
   return {
     ...base,
     async start(app) {
@@ -38,7 +38,7 @@ export function service(): {{properCase name}}Service {
       });
     },
     async stop(app) {
-      await base.stop(app);
+      await base.stop?.(app);
       const { locals } = app;
       // Shutdown any service wide infra here
       {{#inArray features 'db'}}