chore: add eslint typescript (#16)

Author: RafaelGSS

.eslintrc.json

@@ -0,0 +1,20 @@
+{
+    "env": {
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "standard"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": "latest",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint"
+    ],
+    "rules": {
+    },
+    "ignorePatterns": ["dist/"]
+}

.github/workflows/ci.yml

@@ -28,6 +28,10 @@ jobs:
         run: |
           npm i fastify json-schema-to-ts
 
+      - name: Run lint
+        run: |
+          npm run lint
+
       - name: Run tests
         run: |
           npm run test

index.ts

@@ -4,13 +4,13 @@ import {
   RawServerBase,
   RawServerDefault,
   FastifyPluginCallback,
-  FastifyPluginAsync,
-} from "fastify";
+  FastifyPluginAsync
+} from 'fastify'
 
-import { JSONSchema7, FromSchema } from "json-schema-to-ts";
+import { JSONSchema7, FromSchema } from 'json-schema-to-ts'
 
 export interface JsonSchemaToTsProvider extends FastifyTypeProvider {
-  output: this["input"] extends JSONSchema7 ? FromSchema<this["input"]> : never;
+  output: this['input'] extends JSONSchema7 ? FromSchema<this['input']> : never;
 }
 
 /**

package.json

@@ -7,6 +7,8 @@
   "scripts": {
     "build": "rimraf ./dist && mkdir dist && tsc --outDir dist",
     "test": "npm run build && npm run typescript",
+    "lint": "eslint \"**/*.ts\"",
+    "lint:fix": "eslint \"**/*.ts\" --fix",
     "typescript": "tsd"
   },
   "repository": {
@@ -32,8 +34,16 @@
   },
   "devDependencies": {
     "@types/node": "^18.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.32.0",
+    "@typescript-eslint/parser": "^5.32.0",
+    "eslint": "^8.21.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.26.0",
+    "eslint-plugin-n": "^15.2.4",
+    "eslint-plugin-promise": "^6.0.0",
     "fastify-tsconfig": "^1.0.1",
     "rimraf": "^3.0.2",
-    "tsd": "^0.22.0"
+    "tsd": "^0.22.0",
+    "typescript": "^4.7.4"
   }
 }

types/plugin.test-d.ts

@@ -1,11 +1,11 @@
 import {
   FastifyPluginAsyncJsonSchemaToTs,
-  FastifyPluginCallbackJsonSchemaToTs,
-} from "../index";
-import { expectType } from "tsd";
-import Fastify, { FastifyPluginAsync, FastifyPluginCallback } from "fastify";
+  FastifyPluginCallbackJsonSchemaToTs
+} from '../index'
+import { expectType } from 'tsd'
+import Fastify, { FastifyPluginAsync, FastifyPluginCallback } from 'fastify'
 
-import { Http2Server } from "http2";
+import { Http2Server } from 'http2'
 
 // Ensure the defaults of FastifyPluginAsyncJsonSchemaToTs are the same as FastifyPluginAsync
 export const pluginAsyncDefaults: FastifyPluginAsync = async (
@@ -14,11 +14,11 @@ export const pluginAsyncDefaults: FastifyPluginAsync = async (
 ) => {
   const pluginAsyncJSONSchemaToTsDefaults: FastifyPluginAsyncJsonSchemaToTs =
     async (fastifyWithJSONSchemaToTs, optionsJSONSchemaToTs) => {
-      expectType<typeof fastifyWithJSONSchemaToTs["server"]>(fastify.server);
-      expectType<typeof optionsJSONSchemaToTs>(options);
-    };
-  fastify.register(pluginAsyncJSONSchemaToTsDefaults);
-};
+      expectType<typeof fastifyWithJSONSchemaToTs['server']>(fastify.server)
+      expectType<typeof optionsJSONSchemaToTs>(options)
+    }
+  fastify.register(pluginAsyncJSONSchemaToTsDefaults)
+}
 
 // Ensure the defaults of FastifyPluginCallbackJsonSchemaToTs are the same as FastifyPluginCallback
 export const pluginCallbackDefaults: FastifyPluginCallback = async (
@@ -32,77 +32,77 @@ export const pluginCallbackDefaults: FastifyPluginCallback = async (
       optionsJSONSchemaToTs,
       doneJSONSchemaToTs
     ) => {
-      expectType<typeof fastifyWithJSONSchemaToTs["server"]>(fastify.server);
-      expectType<typeof optionsJSONSchemaToTs>(options);
-    };
+      expectType<typeof fastifyWithJSONSchemaToTs['server']>(fastify.server)
+      expectType<typeof optionsJSONSchemaToTs>(options)
+    }
 
-  fastify.register(pluginCallbackJSONSchemaToTsDefaults);
-};
+  fastify.register(pluginCallbackJSONSchemaToTsDefaults)
+}
 
 const asyncPlugin: FastifyPluginAsyncJsonSchemaToTs<
   { optionA: string },
   Http2Server
 > = async (fastify, options) => {
-  expectType<Http2Server>(fastify.server);
+  expectType<Http2Server>(fastify.server)
 
-  expectType<string>(options.optionA);
+  expectType<string>(options.optionA)
 
   fastify.get(
-    "/",
+    '/',
     {
       schema: {
         body: {
-          type: "object",
+          type: 'object',
           properties: {
-            x: { type: "string" },
-            y: { type: "number" },
-            z: { type: "boolean" },
+            x: { type: 'string' },
+            y: { type: 'number' },
+            z: { type: 'boolean' }
           },
-          required: ["x", "y", "z"],
-        } as const,
-      },
+          required: ['x', 'y', 'z']
+        } as const
+      }
     },
     (req) => {
-      expectType<boolean>(req.body.z);
-      expectType<number>(req.body.y);
-      expectType<string>(req.body.x);
+      expectType<boolean>(req.body.z)
+      expectType<number>(req.body.y)
+      expectType<string>(req.body.x)
     }
-  );
-};
+  )
+}
 
 const callbackPlugin: FastifyPluginCallbackJsonSchemaToTs<
   { optionA: string },
   Http2Server
 > = (fastify, options, done) => {
-  expectType<Http2Server>(fastify.server);
+  expectType<Http2Server>(fastify.server)
 
-  expectType<string>(options.optionA);
+  expectType<string>(options.optionA)
 
   fastify.get(
-    "/",
+    '/',
     {
       schema: {
         body: {
-          type: "object",
+          type: 'object',
           properties: {
-            x: { type: "string" },
-            y: { type: "number" },
-            z: { type: "boolean" },
+            x: { type: 'string' },
+            y: { type: 'number' },
+            z: { type: 'boolean' }
           },
-          required: ["x", "y", "z"],
-        } as const,
-      },
+          required: ['x', 'y', 'z']
+        } as const
+      }
     },
     (req) => {
-      expectType<boolean>(req.body.z);
-      expectType<number>(req.body.y);
-      expectType<string>(req.body.x);
+      expectType<boolean>(req.body.z)
+      expectType<number>(req.body.y)
+      expectType<string>(req.body.x)
     }
-  );
-  done();
-};
+  )
+  done()
+}
 
-const fastify = Fastify();
+const fastify = Fastify()
 
-fastify.register(asyncPlugin);
-fastify.register(callbackPlugin);
+fastify.register(asyncPlugin)
+fastify.register(callbackPlugin)