lazyts
TS project initialization for lazy people.
This package is still in developement. Usage beyond testing is not advised.
Usage
npx lazyts <subcommand> [args] [options]
Subcommands
name | arguments | description |
---|
init | <name> [framework] | Creates a project in the given framework. Default: 'node' |
setup | --- | Sets up running TS by installing NPM packages. May require admin/root on some systems. |
list | --- | Lists all framework options possible to use in init . |
Note: arguments in <carets> are required and ones in [brackets] are optional.
More commands will come soon!
Options
short | long | description |
---|
-V | --version | Prints the program version and exits |
-h | --help | Prints help text (less stylized version of this README) |
Frameworks
Each supported framework has its own directory in frameworks.
Currently the supported frameworks are:
Adding Frameworks
Anyone looking to add a framework to this utility should submit a PR against main
Adding the following:
- directory with name for framework
- basic skeleton files to begin development on a project
- DO NOT include
package.json
.
- If needed, add a section in
README.md
to tell the user what modifications must be made for proper usage. - The default
package.json
will be whatever the user has configured for npm init -y
.
- DO include a
README.md
to tell the user how to quickly get started on their project.
- For reference, look at the
node
framework's README.
- DO include a
tsconfig.json
.
- Make sure to keep it appropriate for the framework at hand.