@uscreen.de/create-fastify-app 1.0.2 → 1.1.0

package/.eslintcache

@@ -1 +1 @@
-[{"/Users/martin/repos/uscreen/npm/create-fastify-app/bin/cli.js":"1"},{"size":4769,"mtime":1669380908819,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","suppressedMessages":"6","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1s60doj","/Users/martin/repos/uscreen/npm/create-fastify-app/bin/cli.js",[],[]]
+[{"/Users/marcus/Sites/npm-uscreen/repos/create-fastify-app/bin/cli.js":"1"},{"size":4235,"mtime":1669742140487,"results":"2","hashOfConfig":"3"},{"filePath":"4","messages":"5","suppressedMessages":"6","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"8tgkqw","/Users/marcus/Sites/npm-uscreen/repos/create-fastify-app/bin/cli.js",[],[]]

package/README.md

@@ -68,6 +68,23 @@ $ make logs
 
 ## Changelog
 
+### 1.1.0
+
+#### Changed
+
+- migrated yorkie to husky
+- cleanup app.js and server.js
+
+#### Added
+
+- uses @uscreen.de/common-esm for esm migration
+- uses @uscreen.de/fastify-app options for app creation
+- uses nodemon for dev mode
+
+#### Removed
+
+- dropped pm2 package and config
+
 ### 1.0.0
 
 #### Changed

package/bin/cli.js

@@ -98,25 +98,10 @@ const addPackageConfig = (path, skelPath) => {
   delete pack.packageJson.readme
 
   pack.packageJson.main = skelPack.packageJson.main
-  pack.packageJson.type = 'module'
-
-  pack.packageJson.scripts = Object.assign(pack.packageJson.scripts || {}, {
-    start: 'pm2 start pm2-dev.config.cjs',
-    stop: 'pm2 delete pm2-dev.config.cjs',
-    logs: `pm2 logs ${pack.packageJson.name} --raw | pino-pretty -t`,
-    lint: "eslint '**/*.js' --fix",
-    test: 'tap test/**/*.test.js',
-    'test:cov': 'tap --coverage-report=html test/**/*.test.js',
-    'test:ci': 'tap --coverage-report=text-summary test/**/*.test.js',
-    deploy: 'pm2 deploy pm2.config.cjs',
-    postdeploy: 'pm2 reload pm2.config.cjs'
-  })
-  pack.packageJson.gitHooks = {
-    'pre-commit': 'lint-staged'
-  }
-  pack.packageJson['lint-staged'] = {
-    '*.{js}': ['eslint --fix', 'git add']
-  }
+  pack.packageJson.type = skelPack.packageJson.type
+  pack.packageJson.scripts = skelPack.packageJson.scripts
+  pack.packageJson['lint-staged'] = skelPack.packageJson['lint-staged']
+
   return writePackage(pack.path, pack.packageJson)
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uscreen.de/create-fastify-app",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "cli to create a new @uscreen.de/fastify-app",
   "main": "index.js",
   "type": "module",

package/skeleton/.gitignore

@@ -3,4 +3,5 @@ node_modules
 /.nyc_output
 /coverage
 .DS_Store
-yarn-error.log
+yarn-error.log
+/.eslintcache

package/skeleton/Makefile

@@ -1,12 +1,6 @@
 start:
 	yarn
-	yarn start
-
-stop:
-	yarn stop
-
-logs:
-	yarn logs
+	yarn dev
 
 test:
 	yarn test
@@ -14,16 +8,4 @@ test:
 test.coverage:
 	yarn test:cov
 
-deploy:
-	yarn deploy stage
-
-deploy.setup:
-	yarn deploy stage setup
-
-live.deploy:
-	yarn deploy live
-
-live.deploy.setup:
-	yarn deploy live setup
-
 .PHONY: test

package/skeleton/README.md

@@ -6,11 +6,7 @@
 ## Usage
 
 * `make start`: start app on local dev
-* `make logs`: watch logs
-* `make stop`: stop app
 * `make test`: test app
-* `make deploy`: deploy app to stage
-* `make live.deploy`: deploy app to live
 
 ## Configure
 

package/skeleton/app/config.js

@@ -1,8 +1,7 @@
-import path from 'path'
 import envSchema from 'env-schema'
-import { dirname } from './modules/common-esm.js'
+import CommonESM from '@uscreen.de/common-esm'
 
-const __dirname = dirname(import.meta.url)
+const { join } = new CommonESM(import.meta.url)
 
 const schema = {
   type: 'object',
@@ -20,10 +19,7 @@ const config = envSchema({
   dotenv: true
 })
 
-config.autoloads = [
-  path.join(__dirname, 'plugins'),
-  path.join(__dirname, 'services')
-]
+config.autoloads = [join('plugins'), join('services')]
 
 config.swagger = {
   routePrefix: `${config.prefix}/docs`,

package/skeleton/app/server.js

@@ -1,29 +1,9 @@
 import fastify from 'fastify'
-import hyperid from 'hyperid'
+import { options } from '@uscreen.de/fastify-app'
 import config from './config.js'
 import app from './app.js'
-import { json } from './modules/common-esm.js'
 
-const { name, version } = json(import.meta.url, '../package.json')
-
-const instance = hyperid({ urlSafe: true })
-
-const server = fastify({
-  genReqId() {
-    return instance()
-  },
-
-  logger: config.logEnabled
-    ? {
-        level: config.logLevel,
-        name: `${name} (v${version}) ${process.env.NODE_APP_INSTANCE}`,
-        redact: {
-          paths: ['pattern'], // limit hemeras verbosity
-          remove: true
-        }
-      }
-    : false
-})
+const server = fastify(options(config))
 
 server.register(app, config)
 
@@ -32,17 +12,24 @@ server.register(app, config)
  */
 server.ready((err) => {
   if (err) throw err
-  server.log.debug('server ready, routes are set:\n' + server.printRoutes())
+  server.log.debug(
+    'server ready, routes are set:\n' +
+      server.printRoutes({ commonPrefix: false })
+  )
 })
 
 /**
  * graceful shutdown (closing handles, etc.)
  */
-process.on('SIGINT', async () => {
-  server.log.info(`server shutting down.`)
+const shutdown = async () => {
+  server.log.info(
+    `application shutting down. (${server.app.name} ${server.app.version})`
+  )
   await server.close()
   process.exit()
-})
+}
+process.on('SIGINT', shutdown)
+process.on('SIGTERM', shutdown)
 
 /**
  * start http server

package/skeleton/package.json

@@ -4,41 +4,32 @@
   "main": "app/server.js",
   "type": "module",
   "dependencies": {
+    "@uscreen.de/common-esm": "^1.0.0",
     "@uscreen.de/fastify-app": "^1.0.0-0",
-    "desm": "^1.3.0",
     "env-schema": "^5.1.1",
     "fastify": "^4.10.2",
     "fastify-plugin": "^4.3.0",
     "fluent-json-schema": "^4.0.0",
-    "hyperid": "^3.0.1"
+    "pino-pretty": "^9.1.1"
   },
   "devDependencies": {
     "@uscreen.de/eslint-config-prettystandard-node": "^0.2.8",
     "c8": "^7.12.0",
-    "lint-staged": "^13.0.3",
-    "pino-pretty": "^9.1.1",
-    "pm2": "^5.2.2",
-    "prettier": "^2.7.1",
-    "tap": "^16.3.2",
-    "yorkie": "^2.0.0"
+    "husky": ">=6",
+    "lint-staged": ">=10",
+    "nodemon": "^2.0.20",
+    "prettier": "^2.8.0",
+    "tap": "^16.3.2"
   },
   "scripts": {
-    "start": "pm2 start pm2-dev.config.cjs",
-    "stop": "pm2 delete pm2-dev.config.cjs",
-    "logs": "pm2 logs new-fastify-app --raw | pino-pretty -t",
-    "lint": "eslint '**/*.js' --fix",
+    "dev": "nodemon",
+    "lint": "eslint --fix",
     "test": "c8 tap",
     "test:cov": "c8 --reporter=html --reporter=text tap",
-    "test:ci": "c8 --reporter=text-summary tap",
-    "deploy": "pm2 deploy pm2.config.cjs",
-    "postdeploy": "pm2 reload pm2.config.cjs"
-  },
-  "gitHooks": {
-    "pre-commit": "lint-staged"
+    "test:ci": "tap",
+    "prepare": "husky install"
   },
   "lint-staged": {
-    "*.{js}": [
-      "eslint --fix"
-    ]
+    "*.js": "eslint --cache --fix"
   }
 }

package/skeleton/test/helper.js

@@ -8,13 +8,9 @@ import fp from 'fastify-plugin'
 import App from '../app/app.js'
 import Config from '../app/config.js'
 
-// overwrite some config option(s) on tests
-Config.hemeralogLevel = 'fatal'
-Config.hemeraNS = `test-${process.env.TAP_CHILD_ID}`
-
 // automatically build and tear down our instance
-export const build = async (t, featureSwitches = {}, ConfigOverwrite = {}) => {
-  return new Promise((resolve, reject) => {
+export const build = async (t, ConfigOverwrite = {}) => {
+  return new Promise((resolve) => {
     const app = Fastify()
 
     // setup to register YOUR app

package/skeleton/app/modules/common-esm.js

@@ -1,17 +0,0 @@
-import { readFileSync } from 'fs'
-import desm, { dirname, filename, join } from 'desm'
-
-/**
- * like const { name } = require('./package.json')
- */
-const json = (metaUrl, file) => JSON.parse(readFileSync(join(metaUrl, file)))
-
-/**
- * like if (!module.parent)
- */
-const isMain = (metaUrl) =>
-  filename(metaUrl) === process.argv[1] ||
-  filename(metaUrl) === process.env.pm_exec_path
-
-export { dirname, filename, join, json, isMain }
-export default desm

package/skeleton/pm2-dev.config.cjs

@@ -1,16 +0,0 @@
-const { name, main } = require('./package.json')
-
-module.exports = {
-  apps: [
-    {
-      name,
-      script: main,
-      merge_logs: true,
-      watch: ['app'],
-      ignore_watch: ['.git', 'app/*.pid'],
-      env: {
-        NODE_ENV: 'development'
-      }
-    }
-  ]
-}

package/skeleton/pm2.config.cjs

@@ -1,29 +0,0 @@
-const { name, main, repository } = require('./package.json')
-
-module.exports = {
-  apps: [
-    {
-      name,
-      script: main,
-      merge_logs: true,
-      ignore_watch: ['.git', 'app/*.pid'],
-      env: {
-        NODE_ENV: 'production'
-      }
-    }
-  ],
-  deploy: {
-    stage: {
-      user: 'user',
-      host: 'server-stage.example.com',
-      ref: 'origin/master',
-      repo: repository.url || repository,
-      path: `/home/user/${name}`,
-      'pre-setup': 'yarn add pm2 pino-pretty;',
-      'post-setup':
-        'cp ./.env.example ../shared/.env; ln -s ../shared/.env ./.env',
-      'post-deploy':
-        'yarn install --production; ~/node_modules/.bin/pm2 reload pm2.config.cjs'
-    }
-  }
-}