NestJS File Generator for VSCode

Are you tired of manually creating files for your NestJS projects in Visual Studio Code? We have the solution for you! Introducing the NestJS File Generator extension for VSCode.

With this powerful extension, you can streamline your NestJS development workflow by generating files with just a few clicks. Whether you need a new class, controller, decorator, or any other NestJS component, our extension has you covered.

Table of Contents

• NestJS File Generator for VSCode
  • Table of Contents
  • Requirements
  • Project Settings
  • Settings Options
  • Features
  • Follow Me
  • VSXpert Template
  • Other Extensions
  • Contributing
  • Code of Conduct
  • Changelog
  • Authors
  • License

Requirements

• VSCode 1.88.0 or later

Project Settings

Configure your project by creating or updating a settings.json file at the project's root. If you already have a .vscode/settings.json file, skip the first two steps.

1. Open the command palette in VSCode:

   • CTRL + SHIFT + P (Windows)
   • CMD + SHIFT + P (Mac OS)

2. Type Preferences: Open Workspace Settings (JSON).

3. In the .vscode/settings.json file, copy and paste the following settings:

   {
     "nestjs.enable": true, // Enable or disable the extension
     "nestjs.files.include": [
       "ts"
     ], // The list of extensions to include in the Sidebar Nest File Generator
     "nestjs.files.exclude": [
       "**/node_modules/**",
       "**/dist/**",
       "**/out/**",
       "**/build/**",
       "**/.*/**"
     ], // Glob patterns of files or folders to exclude in the Sidebar Nest File Generator
     "nestjs.files.watch": [
       "controllers",
       "dtos",
       "services"
     ], // The list of types of files to watch in the Sidebar Nest File Generator
     "nestjs.files.showPath": true, // Show the path in the list of files in the Sidebar Nest File Generator
     "nestjs.terminal.cwd": "/path/to/your/project", // Sets the current working directory for the terminal
     "nestjs.submenu.customCommands": [
       {
         "name": "Template 1",
         "command": "nest g co",
         "args": "--flat"
       },
       {
         "name": "Template 2",
         "command": "nest g co",
         "args": "--no-flat"
       }
     ], // The list of custom commands to execute in the custom command submenu
     "nestjs.submenu.templates": [
       {
         "name": "Template 1",
         "description": "Description of Template 1",
         "type": "controller",
         "template": [
           "import { Controller } from '@nestjs/common';",
           "",
           "@Controller('template1')",
           "export class Template1Controller {",
           "}"
         ]
       }
     ], // The list of templates to use when generating a new file
     "nestjs.submenu.activateItem": {
       "file": {
         "class": true,
         "controller": true,
         "decorator": true,
         "dto": true,
         "exception": true,
         "exceptionFilter": true,
         "filter": true,
         "gateway": true,
         "guard": true,
         "interceptor": true,
         "interface": true,
         "jwtGuard": true,
         "jwtStrategy": true,
         "middleware": true,
         "logger": true,
         "module": true,
         "pipe": true,
         "provider": true,
         "resolver": true,
         "service": true,
         "test": true,
         "template": true
       },
       "terminal": {
         "controller": true,
         "gateway": true,
         "library": true,
         "module": true,
         "provider": true,
         "resolver": true,
         "resource": true,
         "service": true,
         "custom": true,
         "start": true,
         "startDev": true,
         "startDebug": true,
         "startProd": true
       }
     }, // Activate items in the submenu
     "nestjs.files.autoImport": true, // Automatically import the generated file
     "nestjs.files.skipFolderConfirmation": false, // Skip folder confirmation when generating a new file
     "nestjs.files.orm": "typeorm", // The ORM to use when generating a new file
   }
   

4. Restart VS Code

Your project is now set up to automatically format code upon saving.

Settings Options

Configure the Nest File Generator extension to suit your needs. The following settings are available:

• nestjs.enable: Enable or disable the extension. The default is true.
• nestjs.files.include: The list of extensions to include in the Sidebar Nest File Generator. The default is ts.
• nestjs.files.exclude: Glob patterns of files or folders to exclude in the Sidebar Nest File Generator. The default is **/node_modules/**, **/dist/**, **/out/**, **/build/**, and **/.*/**.
• nestjs.files.watch: The list of types of files to watch in the Sidebar Nest File Generator. The default is controllers, dtos, and services.
• nestjs.files.showPath: Show the path in the list of files in the Sidebar Nest File Generator. The default is true.
• nestjs.terminal.cwd: Sets the current working directory for the terminal. The directory must be an absolute path. The default is empty.
• nestjs.submenu.customCommands: The list of custom commands to execute in the custom command submenu. The default is [].
• nestjs.submenu.templates: The list of templates to use when generating a new file. The default is [].
• nestjs.submenu.activateItem: Activate items in the submenu. The default is true.
• nestjs.files.autoImport: Automatically import the generated file. The default is true.
• nestjs.files.skipFolderConfirmation: Skip folder confirmation when generating a new file. The default is false.
• nestjs.files.orm: The ORM to use when generating a new file. The default is typeorm.

The nestjs.submenu.customCommands setting is an array of objects with the following properties:

• name: The name of the command. Example: "Template 1".
• command: The command to execute. Example: "ng g c".
• args: The arguments to pass to the command. Example: "--style css --standalone true --inline-style --inline-template".

The nestjs.submenu.templates setting is an array of objects with the following properties:

• name: The name of the template. Example: "Service".
• description: A description of the template. Example: "Creates a service file".
• type: The type of component. Example: "service".
• template: The template content for the file. Use {{ComponentName}} as a placeholder for the component name and {{EntityName}} for the lowercase component name or any other placeholder you want to use.

For more information on configuring the Nest File Generator extension, see the Project Settings section.

Features

Follow Me

If you enjoy using this extension, consider following me for updates on this and future projects:

VSXpert Template

This extension was created using VSXpert, a template that helps you create Visual Studio Code extensions with ease. VSXpert provides a simple and easy-to-use structure to get you started quickly.

Other Extensions

• Angular File Generator
• NestJS File Generator
• T3 Stack / NextJS / ReactJS File Generator
• Auto Barrel
• CodeIgniter 4 Spark

Contributing

NestJS File Generator for VSCode is open-source software, and we welcome contributions from the community. If you'd like to contribute, please fork the GitHub repository and submit a pull request with your changes.

Before contributing, please read our Contribution Guidelines for instructions on coding standards, testing, and more.

Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, disability, ethnicity, religion, or similar personal characteristic. Please review our Code of Conduct before participating in our community.

Changelog

For a complete list of changes, see the CHANGELOG.md

Authors

• Manuel Gil - Owner - ManuelGil

See also the list of contributors who participated in this project.

License

NestJS File Generator for VSCode is licensed under the MIT License - see the MIT License for details.