@dlw-digitalworkplace/generator-filetemplates
v0.0.1
Published
This generator let's you install template files that can be used with the VS Code Blueprint extension
Downloads
3
Keywords
Readme
delaware Blueprint Templates Generator
This yeoman geneartor can be used to install templates, created for the Blueprint VS Code extension, into your project. When running the generator you can choose to install all available template files, or select specific template files. Currently the following template files are supported:
- TypeScript React Component
- TypeScript React Stateless Component
- Typescript Interface
All templates will be installed in a blueprint-templates
folder (required by the Blueprint VS Code extension) that will be created in the directory where the generator is executed.
Installation
Install the genertor
npm i -g @dlw-digitalworkplace/generator-filetemplates
Usage
Run the generator
yo @dlw-digitalworkplace/generator-filetemplates
Follow the instructions of the generator to install all templates or specific templates.
Make sure the template files are installed in the root of your VS Code project. Also make sure the Blueprint VS Code extension is installed. Use right-click anywhere in the explorer view in VS Code and select 'New File from Template'. Select the template and give it a name. Done!
Contributing
If you have new ideas for templates you are welcome to contribute to this repo. The following guidelines will help you to get started.
- Fork this repository
- Run
npm run install
in the root of the project. - Run
npm run build
int the root of the project - Create your template file in the
generators/generator-filetemplates/app/templates
folder- Each template should have its dedicated folder
- Each folder should contain a
manifest.json
file with a name (should match the folder name), a title and description (which are shown in the options of the generator)
- Save everything and run
yo @dlw/filetemplates
in thesamples/spfx
folder. This will create the blueprint templates in the sample project (make sure your new template is selected when you run the generator) - Open the sample spfx project in VS Code
- Add the new component in the
/src/webparts/sample/components
folder using the Blueprint VS Code extensions - Make sure the sample spfx project still builds after the new component is added
- Craete a pull request with you new template