Merge pull request #9 from hodfords-solutions/feat/refactor-source

feat: refactor eslint and upgrade dependencies

Author: hodfords-phuong-vt-backend

.eslintrc.js

@@ -2,16 +2,18 @@ name: Publish Package to npmjs
 on:
   push:
     branches:
-      - master
+      - main
 jobs:
+  lint:
+    uses: hodfords-solutions/actions/.github/workflows/lint.yaml@main
   build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version: '22.x'
-          registry-url: 'https://registry.npmjs.org'
-      - run: sh scripts/publish.sh
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+    uses: hodfords-solutions/actions/.github/workflows/publish.yaml@main
+    with:
+      build_path: dist
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+  update-docs:
+    uses: hodfords-solutions/actions/.github/workflows/update-doc.yaml@main
+    needs: build
+    secrets:
+      DOC_SSH_PRIVATE_KEY: ${{ secrets.DOC_SSH_PRIVATE_KEY }}

.github/workflows/publish.yml

@@ -1,3 +1,3 @@
 {
-    "libs/**/*.ts": ["eslint --fix --max-warnings 0"]
+    "lib/**/*.ts": ["eslint --fix --max-warnings 0"]
 }

.lintstagedrc.json

@@ -6,7 +6,8 @@
         "typeorm",
         "postbuild",
         "hodfords",
-        "npmjs"
+        "npmjs",
+        "extname"
     ],
     "flagWords": ["hte"],
     "ignorePaths": ["node_modules", "test", "*.spec.ts", "cspell.json"]

.prettierrc

@@ -0,0 +1 @@
+module.exports = require('@hodfords/nestjs-eslint-config');

cspell.json

@@ -12,7 +12,7 @@ import { MakeServiceCommand } from './commands/make-service.command';
 
 @Module({})
 export class CommandModule {
-    static register(isEnableTypeorm: boolean = true): DynamicModule {
+    static register(isEnableTypeorm = true): DynamicModule {
         const providers: Provider[] = [
             CommandService,
             MakeCommandCommand,

eslint.config.js

@@ -8,7 +8,7 @@ import { COMMAND_KEY } from './decorators/command.decorator';
 export class CommandService {
     constructor(private modulesContainer: ModulesContainer) {}
 
-    async exec() {
+    async exec(): Promise<void> {
         const program = new Command();
         const providerModules = [...this.modulesContainer.values()].map((module) => module.providers.values());
         for (const providerModule of providerModules) {
@@ -26,19 +26,19 @@ export class CommandService {
         await program.parseAsync();
     }
 
-    public addCommand(program, instance, meta) {
+    public addCommand(program, instance, meta): void {
         const commandBuilder = new Command().command(meta.signature);
         if (meta.description) {
             commandBuilder.description(meta.description, meta.params);
         }
         if (meta.options) {
-            for (let option of meta.options) {
+            for (const option of meta.options) {
                 commandBuilder.option(option.value, option.description);
             }
         }
 
         if (meta.requiredOptions) {
-            for (let option of meta.requiredOptions) {
+            for (const option of meta.requiredOptions) {
                 commandBuilder.requiredOption(option.value, option.description);
             }
         }

libs/bin/cli renamed to lib/bin/cli

@@ -10,43 +10,43 @@ export abstract class BaseMakeCommand extends BaseCommand {
 
     abstract getStub();
 
-    public getContent() {
+    public getContent(): void {
         this.content = readFileSync(this.getStub()).toString();
     }
 
-    public replaceContent(contents: { search: string; value: string }[]) {
-        for (let content of contents) {
-            let regex = new RegExp(escapeRegExp(content.search), 'g');
+    public replaceContent(contents: { search: string; value: string }[]): void {
+        for (const content of contents) {
+            const regex = new RegExp(escapeRegExp(content.search), 'g');
             this.content = this.content.replace(regex, content.value);
         }
     }
 
-    public writeFile(pathName, fileName) {
+    public writeFile(pathName: string, fileName: string): void {
         writeFileSync(path.join(process.cwd(), pathName, fileName), this.content);
     }
 
-    public writeFileToModule(pathName, fileName) {
-        let fullPath = this.getModulePath(pathName);
+    public writeFileToModule(pathName: string, fileName: string): void {
+        const fullPath = this.getModulePath(pathName);
         mkdirSync(fullPath, { recursive: true });
         this.writeFile(fullPath, fileName);
     }
 
-    public getModulePath(pathName) {
+    public getModulePath(pathName: string): string {
         if (this.opts.module) {
             return path.join('src', this.opts.module, pathName);
         }
         return path.join('src', pathName);
     }
 
-    public get args() {
+    public get args(): string[] {
         return this.customArgs || this.program.args;
     }
 
-    public get opts() {
+    public get opts(): object & { module?: string } {
         return this.customOptions || this.program.opts();
     }
 
-    public runWith(args: any[] = undefined, opts: any = undefined) {
+    public runWith(args: object = undefined, opts: object = undefined): void {
         this.customArgs = args;
         this.customOptions = opts;
         return this.handle();

libs/command.module.ts renamed to lib/command.module.ts

@@ -4,25 +4,25 @@ import { Command } from 'commander';
 export abstract class BaseCommand {
     protected program: Command;
 
-    abstract handle();
+    abstract handle(): void;
 
-    get params() {
+    get params(): string[] {
         return this.program.args;
     }
 
-    public success(message) {
+    public success(message): void {
         console.log(chalk.green(message));
     }
 
-    public error(message) {
+    public error(message): void {
         console.log(chalk.red(message));
     }
 
-    public info(message) {
+    public info(message): void {
         console.log(chalk.blue(message));
     }
 
-    public warn(message) {
+    public warn(message): void {
         console.log(chalk.yellow(message));
     }
 }

libs/command.service.ts renamed to lib/command.service.ts

@@ -19,11 +19,11 @@ import { BaseMakeCommand } from './base-make.command';
 })
 @Injectable()
 export class MakeCommandCommand extends BaseMakeCommand {
-    public getStub() {
+    public getStub(): string {
         return resolve(__dirname, '../stubs/make-command.stub');
     }
 
-    public handle() {
+    public handle(): void {
         const [command] = this.program.args;
         this.getContent();
         this.replaceContent([

libs/commands/base-make.command.ts renamed to lib/commands/base-make.command.ts

@@ -15,12 +15,12 @@ import { BaseMakeCommand } from './base-make.command';
 })
 @Injectable()
 export class MakeControllerCommand extends BaseMakeCommand {
-    public getStub() {
+    public getStub(): string {
         return resolve(__dirname, '../stubs/modules/http/controllers/controller.stub');
     }
 
-    public handle() {
-        let [name] = this.args;
+    public handle(): void {
+        const [name] = this.args;
         this.getContent();
         this.replaceContent([
             {

libs/commands/base.command.ts renamed to lib/commands/base.command.ts

@@ -15,12 +15,12 @@ import { BaseMakeCommand } from './base-make.command';
 })
 @Injectable()
 export class MakeDtoCommand extends BaseMakeCommand {
-    public getStub() {
+    public getStub(): string {
         return resolve(__dirname, '../stubs/modules/http/dto/dto.stub');
     }
 
-    public handle() {
-        let [name] = this.args;
+    public handle(): void {
+        const [name] = this.args;
         this.getContent();
         this.replaceContent([
             {

libs/commands/make-command.command.ts renamed to lib/commands/make-command.command.ts

@@ -15,12 +15,12 @@ import { BaseMakeCommand } from './base-make.command';
 })
 @Injectable()
 export class MakeE2eTestCommand extends BaseMakeCommand {
-    public getStub() {
+    public getStub(): string {
         return resolve(__dirname, '../stubs/modules/tests/e2e-spec.stub');
     }
 
-    public handle() {
-        let [name] = this.args;
+    public handle(): void {
+        const [name] = this.args;
         this.getContent();
         this.replaceContent([
             {

libs/commands/make-controller.command.ts renamed to lib/commands/make-controller.command.ts

@@ -15,12 +15,12 @@ import { BaseMakeCommand } from './base-make.command';
 })
 @Injectable()
 export class MakeEntityCommand extends BaseMakeCommand {
-    public getStub() {
+    public getStub(): string {
         return resolve(__dirname, '../stubs/modules/entities/entity.stub');
     }
 
-    public handle() {
-        let [name] = this.args;
+    public handle(): void {
+        const [name] = this.args;
         this.getContent();
         this.replaceContent([
             {