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

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/martin/repos/uscreen/npm/create-fastify-app/bin/cli.js":"1","/Users/martin/repos/uscreen/npm/create-fastify-app/test/cli.test.js":"2","/Users/martin/repos/uscreen/npm/create-fastify-app/test/setup.js":"3"},{"size":3522,"mtime":1675168988666,"results":"4","hashOfConfig":"5"},{"size":2397,"mtime":1675169193473,"results":"6","hashOfConfig":"5"},{"size":717,"mtime":1675081403094,"results":"7","hashOfConfig":"5"},{"filePath":"8","messages":"9","suppressedMessages":"10","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"1ohqtje",{"filePath":"11","messages":"12","suppressedMessages":"13","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"14","messages":"15","suppressedMessages":"16","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"/Users/martin/repos/uscreen/npm/create-fastify-app/bin/cli.js",[],[],"/Users/martin/repos/uscreen/npm/create-fastify-app/test/cli.test.js",[],[],"/Users/martin/repos/uscreen/npm/create-fastify-app/test/setup.js",[],[]]

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"

package/.github/workflows/main.yml

@@ -0,0 +1,51 @@
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Test CI
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [14, 16, 18, 19]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+
+      - name: Install packages
+        run: npm install
+
+      - name: Run tests
+        run: npm run test:ci
+
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+
+  automerge:
+    if: >
+        github.event_name == 'pull_request' &&
+        github.event.pull_request.user.login == 'dependabot[bot]'
+    needs: test
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: fastify/github-action-merge-dependabot@v3
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

package/.gitignore

@@ -2,5 +2,7 @@
 .DS_Store
 yarn-error.log
 /.nyc_output
+/coverage
 /skeleton/yarn.lock
+/test/_arena
 /.eslintcache

package/README.md

@@ -1,5 +1,10 @@
 # create-fastify-app
 
+[![Test CI](https://github.com/uscreen/create-fastify-app/actions/workflows/main.yml/badge.svg)](https://github.com/uscreen/create-fastify-app/actions/workflows/main.yml)
+[![Test Coverage](https://coveralls.io/repos/github/uscreen/create-fastify-app/badge.svg?branch=master)](https://coveralls.io/github/uscreen/create-fastify-app?branch=master)
+[![Known Vulnerabilities](https://snyk.io/test/github/uscreen/create-fastify-app/badge.svg?targetFile=package.json)](https://snyk.io/test/github/uscreen/create-fastify-app?targetFile=package.json)
+[![NPM Version](https://badge.fury.io/js/@uscreen.de%2Fcreate-fastify-app.svg)](https://badge.fury.io/js/@uscreen.de%2Fcreate-fastify-app)
+
 > cli to quickly bootstrap a new fastify-app
 
 This package provides the cli skript to create a new `@uscreen.de/fastify-app` from scratch. No need to install any other prerequisites than node and yarn. Features include:
@@ -68,6 +73,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

@@ -2,6 +2,8 @@
 
 import path from 'path'
 import { fileURLToPath } from 'url'
+import { createRequire } from 'module'
+
 import { program } from 'commander'
 import { readPackageUpSync } from 'read-pkg-up'
 import { writePackage } from 'write-pkg'
@@ -11,6 +13,8 @@ import { spawn } from 'child_process'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
+const require = createRequire(import.meta.url)
+const { version } = require('../package.json')
 
 let root
 let skeleton
@@ -25,6 +29,7 @@ const initializeGitRepository = (path) =>
     git.stderr.on('data', (data) => process.stderr.write(data))
     git.on('close', (code) => {
       if (code === 0) return resolve(code)
+      /* c8 ignore next */
       reject(code)
     })
   })
@@ -32,57 +37,35 @@ const initializeGitRepository = (path) =>
 /**
  * init new yarn project
  */
-const initializeYarn = (path) =>
+const initializeYarn = (path, { yes } = {}) =>
   new Promise((resolve, reject) => {
-    const yarn = spawn('yarn', ['init'], {
+    const params = ['init']
+    if (yes) params.push('-y')
+
+    const yarn = spawn('yarn', params, {
       cwd: path,
       stdio: [0, 1, 2]
     })
     yarn.on('close', (code) => {
       if (code === 0) return resolve(code)
+      /* c8 ignore next */
       reject(code)
     })
   })
 
 /**
- * install extra dev packages from skeleleton
- */
-const installDevPackages = (appPath, skelPath) => {
-  const skelPack = readPackageUpSync({ cwd: skelPath })
-  const devDependencies = Object.entries(
-    skelPack.packageJson.devDependencies
-  ).map(([key, val]) => `${key}@${val}`)
-
-  return new Promise((resolve, reject) => {
-    const yarn = spawn('yarn', ['add', ...devDependencies, '-D'], {
-      cwd: appPath
-    })
-    yarn.stdout.on('data', (data) => process.stdout.write(data))
-    yarn.stderr.on('data', (data) => process.stderr.write(data))
-    yarn.on('close', (code) => {
-      if (code === 0) return resolve(code)
-      reject(code)
-    })
-  })
-}
-
-/**
- * install extra prod packages from skeleleton
+ * install packages
  */
-const installPackages = (appPath, skelPath) => {
-  const skelPack = readPackageUpSync({ cwd: skelPath })
-  const dependencies = Object.entries(skelPack.packageJson.dependencies).map(
-    ([key, val]) => `${key}@${val}`
-  )
-
+const installPackages = (appPath) => {
   return new Promise((resolve, reject) => {
-    const yarn = spawn('yarn', ['add', ...dependencies], {
+    const yarn = spawn('yarn', ['install'], {
       cwd: appPath
     })
     yarn.stdout.on('data', (data) => process.stdout.write(data))
     yarn.stderr.on('data', (data) => process.stderr.write(data))
     yarn.on('close', (code) => {
       if (code === 0) return resolve(code)
+      /* c8 ignore next */
       reject(code)
     })
   })
@@ -98,25 +81,13 @@ 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']
+
+  pack.packageJson.dependencies = skelPack.packageJson.dependencies
+  pack.packageJson.devDependencies = skelPack.packageJson.devDependencies
+
   return writePackage(pack.path, pack.packageJson)
 }
 
@@ -144,14 +115,10 @@ const copyEnv = (appPath, skelPath) => {
  * define the command
  */
 program
-  .version('0.1.0')
-  .arguments('<name> [opt]')
+  .version(version)
+  .arguments('<name>')
+  .option('-y --yes')
   .action(async (name, opt) => {
-    if (typeof name === 'undefined') {
-      console.error('please specify your new apps name...')
-      process.exit(1)
-    }
-
     /**
      * the root directory of new project
      */
@@ -166,10 +133,9 @@ program
      * setup new app
      */
     await initializeGitRepository(root)
-    await initializeYarn(root)
-    await installDevPackages(root, skeleton)
-    await installPackages(root, skeleton)
+    await initializeYarn(root, opt)
     await addPackageConfig(root, skeleton)
+    await installPackages(root)
     await copySkeleton(root, skeleton)
     await copyEnv(root, skeleton)
   })
@@ -178,10 +144,3 @@ program
  * read args
  */
 program.parse(process.argv)
-
-/**
- * output help as default
- */
-if (!process.argv.slice(2).length) {
-  program.help()
-}

package/package.json

@@ -1,29 +1,39 @@
 {
   "name": "@uscreen.de/create-fastify-app",
-  "version": "1.0.2",
+  "version": "1.1.1",
   "description": "cli to create a new @uscreen.de/fastify-app",
   "main": "index.js",
   "type": "module",
-  "repository": "git@gitlab.uscreen.net:uscreen/npm/create-fastify-app.git",
+  "homepage": "https://github.com/uscreen/create-fastify-app",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uscreen/create-fastify-app.git"
+  },
   "author": "Marcus Spiegel <spiegel@uscreen.de>",
   "license": "MIT",
   "bin": {
     "create-fastify-app": "./bin/cli.js"
   },
   "scripts": {
+    "test": "c8 tap",
+    "test:cov": "c8 --reporter=html --reporter=text tap",
+    "test:ci": "c8 --reporter=lcovonly tap",
     "lint": "eslint --fix",
     "prepare": "husky install"
   },
   "dependencies": {
-    "commander": "^9.4.1",
-    "fs-extra": "^10.0.1",
+    "commander": "^10.0.0",
+    "fs-extra": "^11.1.0",
     "read-pkg-up": "^9.1.0",
     "write-pkg": "^5.0.0"
   },
   "devDependencies": {
     "@uscreen.de/eslint-config-prettystandard-node": "^0.2.10",
+    "c8": "^7.12.0",
     "husky": ">=8.0.2",
-    "lint-staged": ">=13.0.3"
+    "lint-staged": ">=13.0.3",
+    "strip-ansi": "^7.0.1",
+    "tap": "^16.3.4"
   },
   "lint-staged": {
     "*.js": "eslint --cache --fix"

package/skeleton/.gitignore

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

package/skeleton/.nvmrc

@@ -1 +1 @@
-16
+18

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/test/_arena/new-app/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[{Makefile,**.mk}]
+# Use tabs for indentation (Makefiles require tabs)
+indent_style = tab

package/test/_arena/new-app/.env.example

@@ -0,0 +1,4 @@
+# @see ./app/config.js for defaults and options
+
+logLevel = debug
+

package/test/_arena/new-app/.envrc

@@ -0,0 +1,4 @@
+# @see https://direnv.net/ and https://github.com/direnv/direnv/wiki/Node for docs
+set -e
+use node
+layout node

package/test/_arena/new-app/.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "@uscreen.de/eslint-config-prettystandard-node"
+}

package/test/_arena/new-app/.gitignore

@@ -0,0 +1,7 @@
+node_modules
+/.env
+/.nyc_output
+/coverage
+.DS_Store
+yarn-error.log
+/.eslintcache

package/test/_arena/new-app/.gitlab-ci.yml.example

@@ -0,0 +1,25 @@
+# image: node:lts-alpine
+
+# cache:
+#   paths:
+#     - node_modules/
+#     - .yarn
+
+# stages:
+#   - test
+#   - audit
+
+# test:
+#   stage: test
+#   script:
+#     - npm config set //registry.npmjs.org/:_authToken ${NPM_TOKEN}
+#     - yarn install --pure-lockfile --cache-folder .yarn
+#     - yarn test:ci
+#   coverage: '/^Statements\s*:\s*([^%]+)/'
+
+# audit:
+#   stage: audit
+#   only:
+#     - schedules
+#   script:
+#     - yarn audit

package/test/_arena/new-app/.husky/_/.gitignore

@@ -0,0 +1 @@
+*

package/test/_arena/new-app/.nvmrc

@@ -0,0 +1 @@
+18

package/test/_arena/new-app/.taprc

@@ -0,0 +1,7 @@
+{
+  "timeout": 10,
+  "reporter": "spec",
+  "check-coverage": false,
+  "no-coverage": true,
+  "test-regex": "\\w+\\.test\\.js$"
+}

package/test/_arena/new-app/Makefile

@@ -0,0 +1,11 @@
+start:
+	yarn
+	yarn dev
+
+test:
+	yarn test
+
+test.coverage:
+	yarn test:cov
+
+.PHONY: test

package/test/_arena/new-app/README.md

@@ -0,0 +1,38 @@
+# ${app-name}
+
+> __TODO:__
+> add a name & short description of this apps purpose
+
+## Usage
+
+* `make start`: start app on local dev
+* `make test`: test app
+
+## Configure
+
+Configuration is read by dotenv from `app/.env` file and validated _[optional modified]_ by `app/config.js`. Please add extra defaults if needed to `config.js`. Default values should __always__ refer to local dev setups.
+
+> __Note:__
+> the `.env` file should __never__ get pushed to repository. So adding secrets and credentials to `.env` can be considered a secure option bound to specific environments.
+
+## Api
+
+After starting your server you will find swagger documenation at [http://127.0.0.1:3000/api/docs/](http://127.0.0.1:3000/api/docs/) to explore web api requests interactively.
+
+---
+
+## Roadmap
+
+> TBD
+
+## Changelog
+
+### v0.0.0
+
+- initially bootstrapped by `yarn create @uscreen.de/fastify-app`
+
+---
+
+## Credits
+
+application [boilerplate](https://www.npmjs.com/package/@uscreen.de/fastify-app) provided by [u|screen](https://uscreen.de)

package/test/_arena/new-app/app/app.js

@@ -0,0 +1,17 @@
+import fastifyApp from '@uscreen.de/fastify-app'
+import fp from 'fastify-plugin'
+import schemas from './schemas.js'
+
+export default fp((fastify, opts, next) => {
+  /**
+   * add schemas
+   */
+  fastify.register(schemas)
+
+  /**
+   * register app
+   */
+  fastify.register(fastifyApp, opts)
+
+  next()
+})

package/test/_arena/new-app/app/config.js

@@ -0,0 +1,34 @@
+import envSchema from 'env-schema'
+import CommonESM from '@uscreen.de/common-esm'
+
+const { join } = new CommonESM(import.meta.url)
+
+const schema = {
+  type: 'object',
+  properties: {
+    httpPort: { default: 3000 },
+    httpBind: { default: '127.0.0.1' },
+    prefix: { default: '/api' },
+    logEnabled: { default: true },
+    logLevel: { default: 'info' }
+  }
+}
+
+const config = envSchema({
+  schema: schema,
+  dotenv: true
+})
+
+config.autoloads = [join('plugins'), join('services')]
+
+config.swagger = {
+  routePrefix: `${config.prefix}/docs`,
+  exposeRoute: true,
+  addModels: true
+}
+
+config.health = {
+  exposeStatusRoute: `${config.prefix}/health`
+}
+
+export default config

package/test/_arena/new-app/app/plugins/noop.js

@@ -0,0 +1,14 @@
+import fp from 'fastify-plugin'
+
+export default fp(
+  (fastify, opts, next) => {
+    fastify.decorate('noop', () => {
+      return 'Hello Universe'
+    })
+
+    next()
+  },
+  {
+    name: 'noop'
+  }
+)

package/test/_arena/new-app/app/schemas.js

@@ -0,0 +1,34 @@
+import fp from 'fastify-plugin'
+import S from 'fluent-json-schema'
+
+/**
+ * Usage of the Globaly Shared Schema feature
+ */
+
+export default fp((fastify, opts, next) => {
+  const addSchema = (schema) => {
+    fastify.addSchema(schema)
+    return schema
+  }
+
+  /**
+   * add generic schemas
+   */
+  const noop = addSchema(S.object().id('noop').prop('noop'))
+
+  const plugin = addSchema(S.object().id('plugin').prop('plugin'))
+
+  /**
+   * combine and extend schemas
+   */
+  addSchema(
+    S.object()
+      .id('noopNplugin')
+      .required(['noop'])
+      // .prop('property') // --> strip it
+      .extend(noop)
+      .extend(plugin)
+  )
+
+  next()
+})

package/test/_arena/new-app/app/server.js

@@ -0,0 +1,37 @@
+import fastify from 'fastify'
+import { options } from '@uscreen.de/fastify-app'
+import config from './config.js'
+import app from './app.js'
+
+const server = fastify(options(config))
+
+server.register(app, config)
+
+/**
+ * post-treatment
+ */
+server.ready((err) => {
+  if (err) throw err
+  server.log.debug(
+    'server ready, routes are set:\n' +
+      server.printRoutes({ commonPrefix: false })
+  )
+})
+
+/**
+ * graceful shutdown (closing handles, etc.)
+ */
+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
+ */
+server.listen({ port: config.httpPort, host: config.httpBind })

package/test/_arena/new-app/app/services/noop.js

@@ -0,0 +1,22 @@
+export default (fastify, opts, next) => {
+  fastify.get(
+    '/noop',
+    {
+      schema: {
+        response: {
+          200: { $ref: 'noopNplugin#' } // fastest and json-schema spec compatiple way, or use 'fastify.getSchema()'
+          // 200: fastify.getSchema('noopNplugin')
+        }
+      }
+    },
+    async (req, res) => {
+      return {
+        noop: 'Hello world',
+        plugin: fastify.noop(),
+        property: 'should be stripped from response'
+      }
+    }
+  )
+
+  next()
+}

package/test/_arena/new-app/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "new-app",
+  "version": "1.0.0",
+  "main": "app/server.js",
+  "author": {
+    "name": "Martin Herting",
+    "email": "herting@uscreen.de"
+  },
+  "license": "MIT",
+  "type": "module",
+  "scripts": {
+    "dev": "nodemon",
+    "lint": "eslint --fix",
+    "test": "c8 tap",
+    "test:cov": "c8 --reporter=html --reporter=text tap",
+    "test:ci": "tap",
+    "prepare": "husky install"
+  },
+  "lint-staged": {
+    "*.js": "eslint --cache --fix"
+  },
+  "dependencies": {
+    "@uscreen.de/common-esm": "^1.0.0",
+    "@uscreen.de/fastify-app": "^1.0.0-0",
+    "env-schema": "^5.1.1",
+    "fastify": "^4.10.2",
+    "fastify-plugin": "^4.3.0",
+    "fluent-json-schema": "^4.0.0",
+    "pino-pretty": "^9.1.1"
+  },
+  "devDependencies": {
+    "@uscreen.de/eslint-config-prettystandard-node": "^0.2.8",
+    "c8": "^7.12.0",
+    "husky": ">=6",
+    "lint-staged": ">=10",
+    "nodemon": "^2.0.20",
+    "prettier": "^2.8.0",
+    "tap": "^16.3.2"
+  }
+}

package/test/_arena/new-app/test/app/noop.test.js

@@ -0,0 +1,54 @@
+import tap from 'tap'
+import { build } from '../helper.js'
+
+tap.test('Test Setup', (t) => {
+  t.equal(true, true, 'Tests and assertions should work')
+  t.end()
+})
+
+tap.test('Healthcheck', async (t) => {
+  const fastify = await build(t)
+  const { prefix } = fastify.config
+
+  t.test('a valid GET Request', (t) => {
+    fastify.inject(
+      {
+        method: 'GET',
+        url: `${prefix}/health`
+      },
+      (e, response) => {
+        t.error(e)
+        t.same(response.statusCode, 200, 'response ok')
+        t.same(JSON.parse(response.body), { status: 'ok' }, 'payload ok')
+        t.end()
+      }
+    )
+  })
+})
+
+tap.test('Noop Service', async (t) => {
+  const fastify = await build(t)
+  const { prefix } = fastify.config
+
+  t.test('a valid GET Request', (t) => {
+    fastify.inject(
+      {
+        method: 'GET',
+        url: `${prefix}/noop`
+      },
+      (e, response) => {
+        t.error(e)
+        t.same(response.statusCode, 200, 'response ok')
+        t.same(
+          JSON.parse(response.body),
+          {
+            noop: 'Hello world',
+            plugin: 'Hello Universe'
+          },
+          'payload ok'
+        )
+        t.end()
+      }
+    )
+  })
+})

package/test/_arena/new-app/test/helper.js

@@ -0,0 +1,29 @@
+// This file contains code that we reuse
+// between our tests.
+
+import Fastify from 'fastify'
+import fp from 'fastify-plugin'
+
+// setup to import YOUR app
+import App from '../app/app.js'
+import Config from '../app/config.js'
+
+// automatically build and tear down our instance
+export const build = async (t, ConfigOverwrite = {}) => {
+  return new Promise((resolve) => {
+    const app = Fastify()
+
+    // setup to register YOUR app
+    app.register(fp(App), { ...Config, ...ConfigOverwrite })
+
+    // tear down our app after we are done
+    t.teardown(app.close.bind(app))
+
+    app.ready((err) => {
+      if (err) throw err
+      resolve(app)
+    })
+  })
+}
+
+export const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms))

package/test/cli.test.js

@@ -0,0 +1,109 @@
+import tap from 'tap'
+import fs from 'fs-extra'
+import path from 'path'
+import { createRequire } from 'module'
+import stripAnsi from 'strip-ansi'
+import { before, teardown, cli, cwd } from './setup.js'
+
+const require = createRequire(import.meta.url)
+const { version } = require('../package.json')
+
+tap.before(before)
+tap.teardown(teardown)
+
+tap.test('$ cli', async (t) => {
+  const result = await cli([])
+  t.equal(
+    true,
+    result.stderr.startsWith("error: missing required argument 'name'"),
+    'Should print error message'
+  )
+
+  t.end()
+})
+
+tap.test('$ cli -V', async (t) => {
+  const result = await cli(['--version'])
+  t.equal(
+    true,
+    result.stdout.startsWith(version),
+    'Should show correct version'
+  )
+
+  t.end()
+})
+
+tap.test('$ cli new-app -y', async (t) => {
+  const result = await cli(['new-app', '-y'])
+
+  /**
+   * check output
+   */
+  t.equal(0, result.code, 'Should succeed')
+
+  t.test('Check output', (t) => {
+    const expectedOut = [
+      `Initialized empty Git repository in ${path.resolve(
+        cwd,
+        'new-app',
+        '.git'
+      )}`,
+      'success Saved package.json',
+      '[1/4] Resolving packages...',
+      '[2/4] Fetching packages...',
+      '[3/4] Linking dependencies...',
+      '[4/4] Building fresh packages...',
+      'success Saved lockfile.',
+      'husky - Git hooks installed'
+    ]
+
+    const stdout = stripAnsi(result.stdout)
+
+    for (const e of expectedOut) {
+      t.equal(true, stdout.includes(e), `"${e.substring(0, 36)}"`)
+    }
+
+    t.end()
+  })
+
+  /**
+   * check files
+   */
+  t.test('Check files', (t) => {
+    const appPath = path.resolve(cwd, 'new-app')
+
+    t.equal(
+      true,
+      fs.existsSync(path.resolve(appPath, 'package.json')),
+      'package.json was created'
+    )
+    t.equal(
+      true,
+      fs.existsSync(path.resolve(appPath, 'README.md')),
+      'skeleton was copied'
+    )
+    t.equal(
+      true,
+      fs.existsSync(path.resolve(appPath, 'yarn.lock')),
+      'Packages were installed'
+    )
+
+    const pack = JSON.parse(
+      fs.readFileSync(path.resolve(appPath, 'package.json'), {
+        encoding: 'utf-8'
+      })
+    )
+    t.equal(
+      true,
+      pack.name !== 'new-fastify-app',
+      'package.json was not just copied from skeleton'
+    )
+    t.equal(
+      true,
+      pack.main === 'app/server.js',
+      'package.json was correctly enriched with data'
+    )
+
+    t.end()
+  })
+})

package/test/setup.js

@@ -0,0 +1,33 @@
+import fs from 'fs-extra'
+import path from 'path'
+import { exec } from 'child_process'
+import { fileURLToPath } from 'url'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+export const cwd = path.resolve(__dirname, './_arena/')
+
+export const cli = (args) => {
+  return new Promise((resolve) => {
+    exec(
+      `node ${path.resolve(__dirname, '../bin/cli.js')} ${args.join(' ')}`,
+      { cwd },
+      (error, stdout, stderr) => {
+        resolve({
+          code: error && error.code ? error.code : 0,
+          error,
+          stdout,
+          stderr
+        })
+      }
+    )
+  })
+}
+
+export const before = () => {
+  fs.ensureDirSync(cwd)
+}
+
+export const teardown = () => {
+  fs.removeSync(cwd)
+}

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'
-    }
-  }
-}