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

package/.github/workflows/main.yml

@@ -5,16 +5,16 @@ name: Test CI
 
 on:
   push:
-    branches: ["master"]
+    branches: ["main"]
   pull_request:
-    branches: ["master"]
+    branches: ["main"]
 
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14, 16, 18, 19]
+        node-version: [18, 20]
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

package/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![Test Coverage](https://coveralls.io/repos/github/uscreen/create-fastify-app/badge.svg?branch=main)](https://coveralls.io/github/uscreen/create-fastify-app?branch=main)
 [![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)
 
@@ -73,6 +73,18 @@ $ make logs
 
 ## Changelog
 
+### 1.1.2
+
+#### Changed
+
+- upgraded to node 20.x (LTS)
+
+### 1.1.1
+
+#### Changed
+
+- upgraded to node 18.x (LTS)
+
 ### 1.1.0
 
 #### Changed

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uscreen.de/create-fastify-app",
-  "version": "1.1.1",
+  "version": "1.1.3",
   "description": "cli to create a new @uscreen.de/fastify-app",
   "main": "index.js",
   "type": "module",
@@ -22,14 +22,14 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "commander": "^10.0.0",
+    "commander": "^11.0.0",
     "fs-extra": "^11.1.0",
-    "read-pkg-up": "^9.1.0",
-    "write-pkg": "^5.0.0"
+    "read-pkg-up": "^10.0.0",
+    "write-pkg": "^6.0.0"
   },
   "devDependencies": {
     "@uscreen.de/eslint-config-prettystandard-node": "^0.2.10",
-    "c8": "^7.12.0",
+    "c8": "^8.0.0",
     "husky": ">=8.0.2",
     "lint-staged": ">=13.0.3",
     "strip-ansi": "^7.0.1",

package/skeleton/.nvmrc

@@ -1 +1 @@
-18
+20

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

@@ -1,13 +0,0 @@
-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

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

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

@@ -1,4 +0,0 @@
-# @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

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

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

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

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

@@ -1,25 +0,0 @@
-# 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

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

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

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

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

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

package/test/_arena/new-app/Makefile

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

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

@@ -1,38 +0,0 @@
-# ${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

@@ -1,17 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,34 +0,0 @@
-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

@@ -1,37 +0,0 @@
-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

@@ -1,22 +0,0 @@
-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

@@ -1,40 +0,0 @@
-{
-  "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

@@ -1,54 +0,0 @@
-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

@@ -1,29 +0,0 @@
-// 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))