Merge pull request #30 from NodeFactoryIo/nmlinaric/lint-config

Add eslint import order config

Author: nmlinaric

.eslintrc.js

@@ -8,7 +8,8 @@ module.exports = {
   "parser": "@typescript-eslint/parser",
   "plugins": [
     "@typescript-eslint",
-    "prettier"
+    "prettier",
+    "eslint-plugin-import"
   ],
   "extends": [
     "eslint:recommended",
@@ -31,7 +32,7 @@ module.exports = {
     "prefer-const": "error",
     "no-consecutive-blank-lines": 0,
     "no-console": "error",
-    "@typescript-eslint/naming-convention": ["error", 
+    "@typescript-eslint/naming-convention": ["error",
       {selector: "default", format: ['camelCase']},
       {
         selector: [
@@ -52,6 +53,16 @@ module.exports = {
         modifiers: ["destructured"],
         format: null
       }
-  ],
+    ],
+    "import/order": [
+      "error",
+      {
+        "groups": ["builtin", "external", "parent", "internal", "sibling"],
+        "newlines-between": "always",
+        "alphabetize": {
+          order: 'asc'
+        }
+      },
+    ]
   }
-}
+}

package.json

@@ -75,6 +75,7 @@
     "env-prompt": "^1.2.3",
     "eslint": "^7.18.0",
     "eslint-config-prettier": "^7.2.0",
+    "eslint-plugin-import": "^2.22.1",
     "eslint-plugin-prettier": "^3.3.1",
     "mocha": "^8.2.1",
     "nodemon": "^2.0.7",

src/App.ts

@@ -1,21 +1,22 @@
-import fastify, { FastifyInstance } from "fastify";
+import fastify, {FastifyInstance} from "fastify";
 import fastifyCompress from "fastify-compress";
 import fastifyCors from "fastify-cors";
 import fastifyEnv from "fastify-env";
 import fastifyFormBody from "fastify-formbody";
-import { fastifyHelmet } from "fastify-helmet";
+import fastifyHealthCheck from "fastify-healthcheck";
+import {fastifyHelmet} from "fastify-helmet";
+import fastifyMetrics from "fastify-metrics";
 import fastifyRateLimit from "fastify-rate-limit";
 import fastifySensible from "fastify-sensible";
 import fastifySwagger from "fastify-swagger";
-import fastifyMetrics from "fastify-metrics";
-import fastifyHealthCheck from "fastify-healthcheck";
-import { Connection } from "typeorm";
-import { config as envPluginConfig } from "./config";
-import { getDatabaseConnection } from "./services/db";
-import { logger } from "./services/logger";
-import { routesPlugin } from "./services/plugins/routes";
-import { SWAGGER_CONFIG } from "./services/swagger";
-import { fastifyLogger } from "./services/logger/fastify";
+import {Connection} from "typeorm";
+
+import {config as envPluginConfig} from "./config";
+import {getDatabaseConnection} from "./services/db";
+import {logger} from "./services/logger";
+import {fastifyLogger} from "./services/logger/fastify";
+import {routesPlugin} from "./services/plugins/routes";
+import {SWAGGER_CONFIG} from "./services/swagger";
 export class App {
 
   public readonly instance: FastifyInstance;
@@ -68,7 +69,7 @@ export class App {
       );
     try {
       await this.instance.close();
-    } catch(e) {
+    } catch (e) {
       logger.error(`Error occurred during server closing because: ${e.message}`);
     }
 
@@ -102,7 +103,7 @@ export class App {
         }
       }
     });
-    if(this.instance.config.NODE_ENV !== "test") {
+    if (this.instance.config.NODE_ENV !== "test") {
       this.instance.register(fastifyMetrics, {
         blacklist: '/metrics',
         enableDefaultMetrics: true
@@ -116,4 +117,4 @@ declare module 'fastify' {
   interface FastifyInstance {
     db: Connection;
   }
-}
+}

src/config/index.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/naming-convention */
-import { fasitfyEnvOpt } from "fastify-env";
+import {fasitfyEnvOpt} from "fastify-env";
 
 export const config: fasitfyEnvOpt = {
   schema: {
@@ -32,12 +32,12 @@ export const config: fasitfyEnvOpt = {
 
 declare module 'fastify' {
   interface FastifyInstance {
-    config: { 
+    config: {
       NODE_ENV: string | "test" | "prod";
       SERVER_ADDRESS: string;
       SERVER_PORT: number;
       CORS_ORIGIN: string;
       MAX_REQ_PER_MIN: number;
     };
   }
-}
+}

src/controllers/sample.ts

@@ -1,5 +1,5 @@
-import {ApiController} from "../services/fastify-types";
 import {SampleRepository} from "../repositories/sample";
+import {ApiController} from "../services/fastify-types";
 import {logger} from "../services/logger";
 
 interface GetQuery {
@@ -8,10 +8,10 @@ interface GetQuery {
 
 export const get: ApiController<GetQuery> = {
   url: "/samples",
-  handler: async function(request, reply) {
+  handler: async function (request, reply) {
     logger.info("Fetching samples", {requestId: request.id});
     const sampleRepository = this.db.getCustomRepository(SampleRepository);
-    if(request.query.name) {
+    if (request.query.name) {
       reply.send(
         await sampleRepository.findByName(request.query.name)
       );
@@ -29,7 +29,7 @@ export const get: ApiController<GetQuery> = {
             type: "string"
           },
         }
-      }  
-    }  
+      }
+    }
   }
-};
+};

src/entities/Sample.ts

@@ -8,5 +8,5 @@ export class Sample {
 
   @Column("varchar")
   public name!: string;
-    
+
 }

src/entities/index.ts

@@ -1 +1 @@
-export * from "./Sample";
+export * from "./Sample";

src/index.ts

@@ -1,14 +1,13 @@
-import {App} from "./App";
 import nodeCleanup from "node-cleanup";
 
+import {App} from "./App";
+
 App.init().then((app) => {
   nodeCleanup(function (exitCode, signal) {
     app.stop(signal as string);
     nodeCleanup.uninstall();
     return false;
   });
-  
+
   app.start();
 })
-
-

src/repositories/sample.ts

@@ -1,4 +1,5 @@
 import {EntityRepository, Repository} from "typeorm";
+
 import {Sample} from "../entities";
 
 @EntityRepository(Sample)
@@ -12,4 +13,4 @@ export class SampleRepository extends Repository<Sample> {
     });
   }
 
-}
+}

src/routes/index.ts

@@ -1,6 +1,7 @@
 import {FastifyInstance} from "fastify";
+
 import * as sampleController from "../controllers/sample";
 
 export function registerRoutes(server: FastifyInstance): void {
   server.get(sampleController.get.url, sampleController.get.opts, sampleController.get.handler);
-}
+}

src/services/db/factories/sample.factory.ts

@@ -1,8 +1,9 @@
 import {define} from "typeorm-seeding";
+
 import {Sample} from "../../../entities";
 
-define(Sample, (faker)=> {
+define(Sample, (faker) => {
   const sample = new Sample();
   sample.name = faker.name.jobType();
   return sample;
-});
+});

src/services/db/index.ts

@@ -1,15 +1,16 @@
 import {Connection, createConnection, getConnectionOptions, ObjectType, getConnection} from "typeorm";
-import {sleep} from "../utils";
-import {logger} from "../logger";
 import {PostgresConnectionCredentialsOptions} from "typeorm/driver/postgres/PostgresConnectionCredentialsOptions";
+
+import {logger} from "../logger";
 import {TypeOrmLogger} from "../logger/typeorm";
+import {sleep} from "../utils";
 
 export async function getDatabaseConnection(): Promise<Connection> {
   const opts = await getConnectionOptions();
   let conn: Connection;
   try {
     conn = getConnection();
-  } catch{
+  } catch {
     conn = await createConnection({
       ...opts,
       logger: new TypeOrmLogger()
@@ -20,7 +21,7 @@ export async function getDatabaseConnection(): Promise<Connection> {
 }
 
 async function openConnection(conn: Connection): Promise<Connection> {
-  if(conn.isConnected) {
+  if (conn.isConnected) {
     logger.info(`Connected to database at ${getUrl(conn.options as PostgresConnectionCredentialsOptions)}`);
     return conn;
   }
@@ -41,4 +42,4 @@ export async function getRepository<T>(customRepository: ObjectType<T>): Promise
 
 function getUrl(opts: PostgresConnectionCredentialsOptions): string {
   return (opts.url ?? `${opts.host}:${opts.port}`) + ` (${opts.database})`
-}
+}

src/services/db/seeders/sample.seed.ts

@@ -1,8 +1,9 @@
 import {Factory, Seeder} from "typeorm-seeding";
+
 import {Sample} from "../../../entities";
 
 export class SampleSeed implements Seeder {
   public async run(factory: Factory): Promise<void> {
     await factory(Sample)().seedMany(10);
   }
-}
+}

src/services/fastify-types.ts

@@ -1,15 +1,15 @@
-import { RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerDefault, RequestBodyDefault, RequestHeadersDefault, RequestParamsDefault, RequestQuerystringDefault, RouteShorthandOptions } from 'fastify';
-import { RouteHandlerMethod } from 'fastify/types/route';
-import { ReplyDefault } from 'fastify/types/utils';
+import {RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerDefault, RequestBodyDefault, RequestHeadersDefault, RequestParamsDefault, RequestQuerystringDefault, RouteShorthandOptions} from 'fastify';
+import {RouteHandlerMethod} from 'fastify/types/route';
+import {ReplyDefault} from 'fastify/types/utils';
 
 export type DefaultQuery = RequestQuerystringDefault;
 export type DefaultParams = RequestParamsDefault;
 export type DefaultBody = RequestBodyDefault;
 export type DefaultHeaders = RequestHeadersDefault;
 export interface ApiController<
   Query = DefaultQuery, Params = DefaultParams, Body = DefaultBody, Headers = DefaultHeaders
-> {
+  > {
   url: string;
   opts: RouteShorthandOptions;
   handler: RouteHandlerMethod<RawServerDefault, RawRequestDefaultExpression<RawServerDefault>, RawReplyDefaultExpression<RawServerDefault>, {Querystring: Query; Params: Params; Body: Body; Headers: Headers; Reply: ReplyDefault}>;
-}
+}

src/services/logger/fastify.ts

@@ -1,8 +1,10 @@
-import {Stream, Transform} from "stream";
-import {logger} from "./index";
 import {IncomingMessage} from "http";
+import {Stream, Transform} from "stream";
+
 import {FastifyLoggerOptions, FastifyRequest, RawServerDefault} from "fastify";
 
+import {logger} from "./index";
+
 function format(req: FastifyRequest<Record<string, unknown>, RawServerDefault>): {msg: string} {
   return {msg: `${req.ip} -> ${req.hostname}\t${req.method}:${req.url}\tRequestId: ${req.id}`};
 }

src/services/logger/typeorm.ts

@@ -1,11 +1,12 @@
-import {Logger} from "typeorm";
 import {Logger as WinstonLogger} from "@nodefactory/winston";
+import {Logger} from "typeorm";
+
 import {logger} from "./index";
 
 export class TypeOrmLogger implements Logger {
-    
+
   private readonly logger: WinstonLogger;
-    
+
   constructor() {
     this.logger = logger.child({label: "database"});
   }
@@ -33,4 +34,4 @@ export class TypeOrmLogger implements Logger {
   logSchemaBuild(message: string): void {
     this.logger.debug(message);
   }
-}
+}

src/services/metrics/auth.ts

@@ -1,4 +1,4 @@
-import { FastifyError, FastifyReply, FastifyRequest } from "fastify";
+import {FastifyError, FastifyReply, FastifyRequest} from "fastify";
 
 export async function onlyWhitelisted(
   request: FastifyRequest

src/services/plugins/routes.ts

@@ -1,6 +1,7 @@
-import { FastifyPluginAsync } from "fastify";
-import { registerRoutes } from "../../routes";
-import { onlyWhitelisted } from "../metrics/auth";
+import {FastifyPluginAsync} from "fastify";
+
+import {registerRoutes} from "../../routes";
+import {onlyWhitelisted} from "../metrics/auth";
 
 export const routesPlugin: FastifyPluginAsync = async function (instance) {
   registerRoutes(instance);

src/services/swagger/index.ts

@@ -18,4 +18,4 @@ export const SWAGGER_CONFIG: FastifyDynamicSwaggerOptions = {
     consumes: ['application/json'],
     produces: ['application/json'],
   }
-};
+};

src/services/utils.ts

@@ -2,4 +2,4 @@ export async function sleep(ms: number): Promise<void> {
   return new Promise((resolve => {
     setTimeout(resolve, ms);
   }));
-}
+}

src/subscribers/SampleSubscriber.ts

@@ -1,4 +1,5 @@
 import {EntitySubscriberInterface, EventSubscriber, InsertEvent} from "typeorm";
+
 import {Sample} from "../entities";
 
 @EventSubscriber()

test/e2e/sample.spec.ts

@@ -1,7 +1,9 @@
 import {expect} from "chai";
-import {app} from "./app-setup";
+
 import {logger} from "../../src/services/logger";
 
+import {app} from "./app-setup";
+
 describe("Sample e2e test", function () {
 
   beforeEach(async function () {