Merge pull request #6 from Innovix-Matrix-Systems/IMS-18

Ims 18: enable contributor in readme

.github/workflows/contributor.yml

@@ -0,0 +1,19 @@
+name: Generate contributor list
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  contrib-readme-job:
+    runs-on: ubuntu-latest
+    name: A job to automate contrib in readme
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Contribute List
+        uses: akhilmhdh/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -266,13 +266,14 @@ For reference, check out the `xsecurity` command implemented in [src/commands/xs
 
 ## Custom Module Creation Command
 
-This project includes a custom script to generate a NestJS module along with additional folder structures for better organization.
+This project includes a custom script to generate a new NestJS module with a well-organized folder structure.
 
 ### What this command does:
 
 - Creates a new module using the NestJS CLI.
 - Generates the associated controller and service.
-- Adds additional folders (`dto`, `types`, `repositories`, `helpers`) inside the module folder for organizing your code.
+- Adds additional folders (`dto`, `repositories`,) inside the module folder for organizing your code.
+- Creates a `types.d.ts` file for type definitions.
 
 ### How to Use:
 
@@ -293,6 +294,10 @@ This project includes a custom script to generate a NestJS module along with add
 
 - [@AHS12](https://www.github.com/AHS12)
 
+## Contributors
+<!-- readme: contributors -start -->
+<!-- readme: contributors -end -->
+
 ## License
 
 This project is brought to you by Innovix Matrix System and is released as open-source software under the [MIT license](https://opensource.org/licenses/MIT).

src/commands/create-module.command.ts

@@ -6,22 +6,18 @@ import * as path from 'path';
 
 @Injectable()
 export class CreateModuleCommand {
-
   @Command({
     command: 'create:module <moduleName>',
     describe: 'Create a new module with a predefined structure',
   })
-
   async run(
-
     @Positional({
       name: 'moduleName',
       describe: 'The name of the module',
       type: 'string',
     })
     moduleName: string,
   ): Promise<void> {
-
     if (!moduleName) {
       console.error('Please provide a module name.');
       process.exit(1);
@@ -49,35 +45,28 @@ export class CreateModuleCommand {
 
   // Utility function to run shell commands
   runCommand(command: string): void {
-
     try {
       execSync(command, { stdio: 'inherit' });
-
     } catch (error) {
       console.error(`Error executing command: ${command}`, error);
     }
   }
 
   // Utility function to create a directory if it doesn't exist
   createDir(dirPath: string): void {
-
     if (!fs.existsSync(dirPath)) {
       fs.mkdirSync(dirPath, { recursive: true });
       console.log(`Created directory: ${dirPath}`);
-
     } else {
       console.log(`Directory already exists: ${dirPath}`);
     }
   }
 
   // Utility function to create a file with content
   createFile(filePath: string, content: string): void {
-
     if (!fs.existsSync(filePath)) {
-
       fs.writeFileSync(filePath, content);
       console.log(`Created file: ${filePath}`);
-
     } else {
       console.log(`File already exists: ${filePath}`);
     }