build(deps-dev): replace standard with neostandard (#779)

* build(deps-dev): replace standard with neostandard * chore: add eslint.config.js * chore: rebase * Update package.json Signed-off-by: Frazer Smith <[email protected]> * chore: ignore voids --------- Signed-off-by: Frazer Smith <[email protected]>
fastify · Jan 16, 2025 · e248931 · e248931
1 parent 09c53d7
commit e248931
Show file tree

Hide file tree

Showing 19 changed files with 109 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![CI](https://github.com/fastify/fastify-cli/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/fastify/fastify-cli/actions/workflows/ci.yml)
 [![NPM version](https://img.shields.io/npm/v/fastify-cli.svg?style=flat)](https://www.npmjs.com/package/fastify-cli)
-[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://standardjs.com/)
+[![neostandard javascript style](https://img.shields.io/badge/code_style-neostandard-brightgreen?style=flat)](https://github.com/neostandard/neostandard)
 
 Command line tools for [Fastify](https://github.com/fastify/fastify).
 Generate, write, and run an application with one single command!
@@ -326,15 +326,15 @@ if your project uses `@fastify/swagger`, `fastify-cli` can generate and write ou
 
 ```diff
 "devDependencies": {
-+ "standard": "^11.0.1",
++ "neostandard": "^0.11.9",
 }
 
 "scripts": {
-+ "pretest": "standard",
++ "pretest": "eslint",
   "test": "node --test test/**/*.test.js",
   "start": "fastify start -l info app.js",
   "dev": "fastify start -l info -P app.js",
-+ "lint": "standard --fix"
++ "lint": "eslint --fix"
 },
 ```
 

diff --git a/eslint.config.js b/eslint.config.js
@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = require('neostandard')({
+  ignores: [
+    ...require('neostandard').resolveIgnoresFromGitignore(),
+    'test/data/parsing-error.js',
+    'test/data/undefinedVariable.js',
+  ],
+  ts: true
+})
diff --git a/helper.d.ts b/helper.d.ts
@@ -1,9 +1,9 @@
 import fastify from 'fastify'
 
 declare module 'fastify-cli/helper.js' {
-    module helper {
-        export function build(args: Array<string>, additionalOptions?: Object, serverOptions?: Object): ReturnType<typeof fastify>;
-    }
+  module helper {
+    export function build (args: Array<string>, additionalOptions?: Object, serverOptions?: Object): ReturnType<typeof fastify>
+  }
 
-    export = helper;
+  export = helper
 }
diff --git a/package.json b/package.json
@@ -8,8 +8,8 @@
     "fastify": "cli.js"
   },
   "scripts": {
-    "lint": "standard",
-    "lint:fix": "standard --fix",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
     "pretest": "xcopy /e /k /i . \"..\\node_modules\\fastify-cli\" || rsync -r --exclude=node_modules ./ node_modules/fastify-cli || echo 'this is fine'",
     "test": "npm run unit:suites && c8 --clean npm run test:cli-and-typescript",
     "unit:cjs": "node suite-runner.js \"templates/app/test/**/*.test.js\"",
@@ -46,12 +46,6 @@
     "url": "https://github.com/fastify/fastify-cli/issues"
   },
   "homepage": "https://github.com/fastify/fastify-cli#readme",
-  "standard": {
-    "ignore": [
-      "test/data/parsing-error.js",
-      "test/data/undefinedVariable.js"
-    ]
-  },
   "dependencies": {
     "@fastify/deepmerge": "^2.0.0",
     "chalk": "^4.1.2",
@@ -79,14 +73,15 @@
     "c8": "^10.1.2",
     "concurrently": "^9.0.0",
     "cross-env": "^7.0.3",
+    "eslint": "^9.17.0",
     "fastify-tsconfig": "^3.0.0",
     "glob": "^11.0.1",
     "minimatch": "^9.0.5",
+    "neostandard": "^0.12.0",
     "proxyquire": "^2.1.3",
     "rimraf": "^3.0.2",
     "simple-get": "^4.0.0",
     "sinon": "^19.0.2",
-    "standard": "^17.0.0",
     "strip-ansi": "^6.0.1",
     "tap": "^16.1.0",
     "ts-node": "^10.4.0",

diff --git a/templates/app-ts-esm/src/app.ts b/templates/app-ts-esm/src/app.ts
@@ -1,23 +1,22 @@
-import * as path from 'node:path';
-import AutoLoad, {AutoloadPluginOptions} from '@fastify/autoload';
-import { FastifyPluginAsync } from 'fastify';
+import * as path from 'node:path'
+import AutoLoad, { AutoloadPluginOptions } from '@fastify/autoload'
+import { FastifyPluginAsync } from 'fastify'
 import { fileURLToPath } from 'node:url'
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 
 export type AppOptions = {
   // Place your custom options for app below here.
-} & Partial<AutoloadPluginOptions>;
-
+} & Partial<AutoloadPluginOptions>
 
 // Pass --options via CLI arguments in command to enable these options.
 const options: AppOptions = {
 }
 
 const app: FastifyPluginAsync<AppOptions> = async (
-    fastify,
-    opts
+  fastify,
+  opts
 ): Promise<void> => {
   // Place here your custom code!
 
@@ -26,6 +25,7 @@ const app: FastifyPluginAsync<AppOptions> = async (
   // This loads all plugins defined in plugins
   // those should be support plugins that are reused
   // through your application
+  // eslint-disable-next-line no-void
   void fastify.register(AutoLoad, {
     dir: path.join(__dirname, 'plugins'),
     options: opts,
@@ -34,13 +34,13 @@ const app: FastifyPluginAsync<AppOptions> = async (
 
   // This loads all plugins defined in routes
   // define your routes in one of these
+  // eslint-disable-next-line no-void
   void fastify.register(AutoLoad, {
     dir: path.join(__dirname, 'routes'),
     options: opts,
     forceESM: true
   })
+}
 
-};
-
-export default app;
+export default app
 export { app, options }
diff --git a/templates/app-ts-esm/src/routes/example/index.ts b/templates/app-ts-esm/src/routes/example/index.ts
@@ -1,9 +1,9 @@
-import { FastifyPluginAsync } from "fastify"
+import { FastifyPluginAsync } from 'fastify'
 
 const example: FastifyPluginAsync = async (fastify, opts): Promise<void> => {
   fastify.get('/', async function (request, reply) {
     return 'this is an example'
   })
 }
 
-export default example;
+export default example
diff --git a/templates/app-ts-esm/src/routes/root.ts b/templates/app-ts-esm/src/routes/root.ts
@@ -6,4 +6,4 @@ const root: FastifyPluginAsync = async (fastify, opts): Promise<void> => {
   })
 }
 
-export default root;
+export default root
diff --git a/templates/app-ts-esm/test/helper.ts b/templates/app-ts-esm/test/helper.ts
@@ -6,7 +6,7 @@ import { fileURLToPath } from 'node:url'
 
 export type TestContext = {
   after: typeof test.after
-};
+}
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
@@ -31,6 +31,7 @@ async function build (t: TestContext) {
   const app = await helper.build(argv, config())
 
   // Tear down our app after we are done
+  // eslint-disable-next-line no-void
   t.after(() => void app.close())
 
   return app

diff --git a/templates/app-ts-esm/test/plugins/support.test.ts b/templates/app-ts-esm/test/plugins/support.test.ts
@@ -5,6 +5,7 @@ import Support from '../../src/plugins/support.js'
 
 test('support works standalone', async (t) => {
   const fastify = Fastify()
+  // eslint-disable-next-line no-void
   void fastify.register(Support)
   await fastify.ready()
 

diff --git a/templates/app-ts/src/app.ts b/templates/app-ts/src/app.ts
@@ -1,6 +1,6 @@
-import { join } from 'node:path';
-import AutoLoad, {AutoloadPluginOptions} from '@fastify/autoload';
-import { FastifyPluginAsync, FastifyServerOptions } from 'fastify';
+import { join } from 'node:path'
+import AutoLoad, { AutoloadPluginOptions } from '@fastify/autoload'
+import { FastifyPluginAsync, FastifyServerOptions } from 'fastify'
 
 export interface AppOptions extends FastifyServerOptions, Partial<AutoloadPluginOptions> {
 
@@ -10,8 +10,8 @@ const options: AppOptions = {
 }
 
 const app: FastifyPluginAsync<AppOptions> = async (
-    fastify,
-    opts
+  fastify,
+  opts
 ): Promise<void> => {
   // Place here your custom code!
 
@@ -20,18 +20,20 @@ const app: FastifyPluginAsync<AppOptions> = async (
   // This loads all plugins defined in plugins
   // those should be support plugins that are reused
   // through your application
+  // eslint-disable-next-line no-void
   void fastify.register(AutoLoad, {
     dir: join(__dirname, 'plugins'),
     options: opts
   })
 
   // This loads all plugins defined in routes
   // define your routes in one of these
+  // eslint-disable-next-line no-void
   void fastify.register(AutoLoad, {
     dir: join(__dirname, 'routes'),
     options: opts
   })
-};
+}
 
-export default app;
+export default app
 export { app, options }
diff --git a/templates/app-ts/src/routes/example/index.ts b/templates/app-ts/src/routes/example/index.ts
@@ -1,9 +1,9 @@
-import { FastifyPluginAsync } from "fastify"
+import { FastifyPluginAsync } from 'fastify'
 
 const example: FastifyPluginAsync = async (fastify, opts): Promise<void> => {
   fastify.get('/', async function (request, reply) {
     return 'this is an example'
   })
 }
 
-export default example;
+export default example
diff --git a/templates/app-ts/src/routes/root.ts b/templates/app-ts/src/routes/root.ts
@@ -6,4 +6,4 @@ const root: FastifyPluginAsync = async (fastify, opts): Promise<void> => {
   })
 }
 
-export default root;
+export default root
diff --git a/templates/app-ts/test/helper.ts b/templates/app-ts/test/helper.ts
@@ -1,11 +1,11 @@
 // This file contains code that we reuse between our tests.
-const helper = require('fastify-cli/helper.js')
 import * as path from 'node:path'
 import * as test from 'node:test'
+const helper = require('fastify-cli/helper.js')
 
 export type TestContext = {
   after: typeof test.after
-};
+}
 
 const AppPath = path.join(__dirname, '..', 'src', 'app.ts')
 
@@ -28,6 +28,7 @@ async function build (t: TestContext) {
   const app = await helper.build(argv, config())
 
   // Tear down our app after we are done
+  // eslint-disable-next-line no-void
   t.after(() => void app.close())
 
   return app

diff --git a/templates/app-ts/test/plugins/support.test.ts b/templates/app-ts/test/plugins/support.test.ts
@@ -6,6 +6,7 @@ import Support from '../../src/plugins/support'
 
 test('support works standalone', async (t) => {
   const fastify = Fastify()
+  // eslint-disable-next-line no-void
   void fastify.register(Support)
   await fastify.ready()
 

diff --git a/templates/eject-ts/server.ts b/templates/eject-ts/server.ts
@@ -1,20 +1,20 @@
 // Read the .env file.
-import * as dotenv from "dotenv";
-dotenv.config();
+import * as dotenv from 'dotenv'
 
 // Require the framework
-import Fastify from "fastify";
+import Fastify from 'fastify'
 
 // Require library to exit fastify process, gracefully (if possible)
-import closeWithGrace from "close-with-grace";
+import closeWithGrace from 'close-with-grace'
+dotenv.config()
 
 // Instantiate Fastify with some config
 const app = Fastify({
   logger: true,
-});
+})
 
 // Register your application as a normal plugin.
-app.register(import("./app"));
+app.register(import('./app'))
 
 // delay is the number of milliseconds for the graceful close to finish
 closeWithGrace({ delay: parseInt(process.env.FASTIFY_CLOSE_GRACE_DELAY) || 500 }, async function ({ signal, err, manual }) {
@@ -27,7 +27,7 @@ closeWithGrace({ delay: parseInt(process.env.FASTIFY_CLOSE_GRACE_DELAY) || 500 }
 // Start listening.
 app.listen({ port: parseInt(process.env.PORT) || 3000 }, (err: any) => {
   if (err) {
-    app.log.error(err);
-    process.exit(1);
+    app.log.error(err)
+    process.exit(1)
   }
-});
+})
diff --git a/templates/plugin/test/index.test-d.ts b/templates/plugin/test/index.test-d.ts
@@ -5,7 +5,9 @@ import { expectType } from 'tsd'
 let app
 try {
   app = fastify()
+  // eslint-disable-next-line no-void
   void app.ready()
+  // eslint-disable-next-line no-void
   void app.register(example)
   expectType<() => string>(app.exampleDecorator)
 } catch (err) {

diff --git a/test/data/custom-import.mjs b/test/data/custom-import.mjs
@@ -1,3 +1,3 @@
 /* global GLOBAL_MODULE_3 */
-globalThis.GLOBAL_MODULE_3 = true // eslint-disable-line
+globalThis.GLOBAL_MODULE_3 = true
 console.log('this is module to be preloaded that sets GLOBAL_MODULE_3=', GLOBAL_MODULE_3)
diff --git a/test/data/custom-import2.mjs b/test/data/custom-import2.mjs
@@ -1,3 +1,3 @@
 /* global GLOBAL_MODULE_4 */
-globalThis.GLOBAL_MODULE_4 = true // eslint-disable-line
+globalThis.GLOBAL_MODULE_4 = true
 console.log('this is module to be preloaded that sets GLOBAL_MODULE_4=', GLOBAL_MODULE_4)
-Original file line number
+Diff line change
@@ Expand Up @@
       })
     }
-    export default root;
+    export default root