@uscreen.de/create-fastify-app 0.7.1 → 1.0.0

package/README.md

@@ -2,7 +2,7 @@
 
 > 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 prerequisits than node and yarn. Features include:
+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:
 
 * initialize new __git__ repository
 * initialize new __yarn__ package.json
@@ -49,7 +49,7 @@ new-app
 
 More Details can be found in `@uscreen.de/fastify-app` [README](https://www.npmjs.com/package/@uscreen.de/fastify-app)
 
-After creation has finished cd into the new apps directory and check it's README for options. In General you should be able to start your new app in dev mode, like so:
+After creation has finished cd into the new apps directory and check it's README for options. In general you should be able to start your new app in dev mode, like so:
 
 ```bash
 $ cd ./new-app
@@ -68,6 +68,13 @@ $ make logs
 
 ## Changelog
 
+### 1.0.0
+
+#### Changed
+
+- switch skeleton to __ESM only__
+- upgrade skeleton to fastify@4.x
+
 ### v0.7.0
 
 - added: graceful shutdown in skeleton

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uscreen.de/create-fastify-app",
-  "version": "0.7.1",
+  "version": "1.0.0",
   "description": "cli to create a new @uscreen.de/fastify-app",
   "main": "index.js",
   "type": "module",
@@ -15,14 +15,14 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "commander": "^9.4.0",
+    "commander": "^9.4.1",
     "fs-extra": "^10.0.1",
     "read-pkg-up": "^9.1.0",
     "write-pkg": "^5.0.0"
   },
   "devDependencies": {
     "@uscreen.de/eslint-config-prettystandard-node": "^0.2.10",
-    "husky": ">=8.0.1",
+    "husky": ">=8.0.2",
     "lint-staged": ">=13.0.3"
   },
   "lint-staged": {

package/skeleton/.eslintrc

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

package/skeleton/.taprc

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

package/skeleton/app/app.js

@@ -1,10 +1,8 @@
-'use strict'
+import fastifyApp from '@uscreen.de/fastify-app'
+import fp from 'fastify-plugin'
+import schemas from './schemas.js'
 
-const fastifyApp = require('@uscreen.de/fastify-app')
-const fp = require('fastify-plugin')
-const schemas = require('./schemas')
-
-module.exports = fp((fastify, opts, next) => {
+export default fp((fastify, opts, next) => {
   /**
    * add schemas
    */

package/skeleton/app/config.js

@@ -1,7 +1,8 @@
-'use strict'
+import path from 'path'
+import envSchema from 'env-schema'
+import { dirname } from './modules/common-esm.js'
 
-const path = require('path')
-const envSchema = require('env-schema')
+const __dirname = dirname(import.meta.url)
 
 const schema = {
   type: 'object',
@@ -34,4 +35,4 @@ config.health = {
   exposeStatusRoute: `${config.prefix}/health`
 }
 
-module.exports = config
+export default config

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

@@ -0,0 +1,17 @@
+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/app/plugins/noop.js

@@ -1,8 +1,6 @@
-'use strict'
+import fp from 'fastify-plugin'
 
-const fp = require('fastify-plugin')
-
-module.exports = fp(
+export default fp(
   (fastify, opts, next) => {
     fastify.decorate('noop', () => {
       return 'Hello Universe'

package/skeleton/app/schemas.js

@@ -1,13 +1,11 @@
-'use strict'
-
-const fp = require('fastify-plugin')
-const S = require('fluent-json-schema')
+import fp from 'fastify-plugin'
+import S from 'fluent-json-schema'
 
 /**
  * Usage of the Globaly Shared Schema feature
  */
 
-module.exports = fp((fastify, opts, next) => {
+export default fp((fastify, opts, next) => {
   const addSchema = (schema) => {
     fastify.addSchema(schema)
     return schema

package/skeleton/app/server.js

@@ -1,10 +1,10 @@
-'use strict'
+import fastify from 'fastify'
+import hyperid from 'hyperid'
+import config from './config.js'
+import app from './app.js'
+import { json } from './modules/common-esm.js'
 
-const fastify = require('fastify')
-const hyperid = require('hyperid')
-const { name, version } = require('../package.json')
-const config = require('./config')
-const app = require('./app')
+const { name, version } = json(import.meta.url, '../package.json')
 
 const instance = hyperid({ urlSafe: true })
 
@@ -47,4 +47,4 @@ process.on('SIGINT', async () => {
 /**
  * start http server
  */
-server.listen(config.httpPort, config.httpBind)
+server.listen({ port: config.httpPort, host: config.httpBind })

package/skeleton/app/services/noop.js

@@ -1,6 +1,4 @@
-'use strict'
-
-module.exports = (fastify, opts, next) => {
+export default (fastify, opts, next) => {
   fastify.get(
     '/noop',
     {

package/skeleton/package.json

@@ -2,33 +2,36 @@
   "name": "new-fastify-app",
   "version": "0.0.0",
   "main": "app/server.js",
+  "type": "module",
   "dependencies": {
-    "@uscreen.de/fastify-app": "^0.8.9",
-    "env-schema": "^5.0.0",
-    "fastify": "^3.29.1",
-    "fastify-plugin": "^3.0.1",
-    "fluent-json-schema": "^3.1.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"
   },
   "devDependencies": {
     "@uscreen.de/eslint-config-prettystandard-node": "^0.2.8",
+    "c8": "^7.12.0",
     "lint-staged": "^13.0.3",
-    "pino-pretty": "^9.1.0",
-    "pm2": "^5.2.0",
+    "pino-pretty": "^9.1.1",
+    "pm2": "^5.2.2",
     "prettier": "^2.7.1",
-    "tap": "^16.3.0",
+    "tap": "^16.3.2",
     "yorkie": "^2.0.0"
   },
   "scripts": {
-    "start": "pm2 start pm2-dev.config.js",
-    "stop": "pm2 delete pm2-dev.config.js",
+    "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",
-    "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.js",
-    "postdeploy": "pm2 reload pm2.config.js"
+    "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"

package/skeleton/{pm2.config.js → pm2.config.cjs}

@@ -23,7 +23,7 @@ module.exports = {
       'post-setup':
         'cp ./.env.example ../shared/.env; ln -s ../shared/.env ./.env',
       'post-deploy':
-        'yarn install --production; ~/node_modules/.bin/pm2 reload pm2.config.js'
+        'yarn install --production; ~/node_modules/.bin/pm2 reload pm2.config.cjs'
     }
   }
 }

package/skeleton/test/app/noop.test.js

@@ -1,5 +1,5 @@
-const tap = require('tap')
-const { build } = require('../helper')
+import tap from 'tap'
+import { build } from '../helper.js'
 
 tap.test('Test Setup', (t) => {
   t.equal(true, true, 'Tests and assertions should work')

package/skeleton/test/helper.js

@@ -1,21 +1,19 @@
-'use strict'
-
 // This file contains code that we reuse
 // between our tests.
 
-const Fastify = require('fastify')
-const fp = require('fastify-plugin')
+import Fastify from 'fastify'
+import fp from 'fastify-plugin'
 
-// setup to require YOUR app
-const App = require('../app/app')
-const Config = require('../app/config')
+// setup to import YOUR app
+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
-const build = async (t, featureSwitches = {}, ConfigOverwrite = {}) => {
+export const build = async (t, featureSwitches = {}, ConfigOverwrite = {}) => {
   return new Promise((resolve, reject) => {
     const app = Fastify()
 
@@ -32,9 +30,4 @@ const build = async (t, featureSwitches = {}, ConfigOverwrite = {}) => {
   })
 }
 
-const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms))
-
-module.exports = {
-  build,
-  wait
-}
+export const wait = (ms) => new Promise((resolve) => setTimeout(resolve, ms))

package/skeleton/.eslintrc.js

@@ -1,3 +0,0 @@
-module.exports = {
-  extends: ['@uscreen.de/eslint-config-prettystandard-node']
-}