Skip to content

Latest commit

 

History

History
102 lines (78 loc) · 5.04 KB

README.md

File metadata and controls

102 lines (78 loc) · 5.04 KB
Raw

Angular File Generator VSCode Extension

VSCode Extension to generate boilerplate files for Angular Modules, Components, etc...

Why use it? Customization to fit your needs!

While the default ng or nx generator is great, this allows you to customize your new generated files to fit your workflow without having to delete or add repetitively to the generated files.

Support Me

If you find the extension or the source code useful, consider:

Features

  • Right click in the explorer
    Menu
  • Select "Angular Generator"
  • Select what you want to generate
    • Component generates html, spec, stories and ts
    • Service generates ts and spec
    • Module Component generates module ts, spec and everything component does
  • Type in dash-case name
    Name Input
  • New files will be generated. You can right click into the folder to generate more. No files will be overridden.
    Generated Files

Extension Settings/Config

In .vscode/settings.json add in the following settings to customize the extension.

  • customTemplateFolder - Custom template folder location. Path relative you your workspace root. If empty will use extension default templates.
  • useOnlyCustomTemplates - Generate code only from custom templates folder. No build in defaults are used.
  • generateSpec - Spec (Test) files can be written using basic class declarations (more performant) or using the angular test bed (More features). If unit testing, basic test structure should do fine. Can also disable tests as well.
    • 0: Disabled
    • 1: Simple
    • 2: TestBed
  • generateStories - Storybook 6 and earlier use Component Story Format 2, Storybook 7 uses CSF 3. Can disable stories as well.
    • 0: Disabled
    • 2: CSF2
    • 3: CSF3

Using the json file

  "angular-files-generator.customTemplateFolder": ".vscode/ngfg-templates",
  "angular-files-generator.useOnlyCustomTemplates": false,
  "angular-files-generator.generateSpec": 1,
  "angular-files-generator.generateStories": 3,

Using the UI
UI

Custom Templates

  • Set the customTemplateFolder config to your custom template folder.
  • See the default templates for reference.
  • File naming should be__name__.TEMPLATE_TYPE.EXTENSION.mustache where TEMPLATE_TYPE is one of component, module or service. EXTENSION should reflect the file type and subtype, such as spec.ts for typescript tests.
  • Additional files with TEMPLATE_TYPE will also be rendered.
    Example: __name__.component.scss.mustache does not have a default template, but will be rendered if included in the user's custom template folder.
  • Available variables examples
    • {{componentPrefix}} - app
    • {{dashCaseName}} - new-module
    • {{camelCaseName}} - newModule
    • {{upperCamelCaseName}} - NewModule
    • {{constantCaseName}} - NEW_MODULE
    • {{upperReadableName}} - New Module
    • {{type}} - Custom type that was entered or blank/empty otherwise

Note: Overrides to component.ts and module.ts files will take precedence over internal extension templates and will yield in files in StandaloneComponent and ModuleComponentto be the same as the Component and Module Commands respectively, which may or may not matter...
This should not be a problem unless using the override and creating a mix of new module and standalone components.

Custom Template Types

  • Define a custom template with a custom name such as __name__TEMPLATE_TYPE.EXTENSION.mustache
  • After right clicking, in the Angular Generator menu select Custom
    • Type in a desired file __name__
    • Then type in the matching TEMPLATE_TYPE
    • TEMPLATE_TYPE can be left blank/empty to target __name__.EXTENSION.mustache or __name__.mustache

Requirements

Generator creates the files from custom templates, so nothing is needed to create the files!
However, to use the files install

  • Angular for component code
  • Jest for unit testing
  • Storybook for visual tests/documentation
  • ng-mocks recommended for helping mock services, etc.. for jest or storybook

Known Issues/Feature Requests

https://github.com/deniszholob/angular-files-generator/issues

Versioning Pattern

0.0.0 = major.minor.patch = breaking changes.new features.bug fixes

Downloads

Windows UI