https://github.com/pardjs/create-pardjs-module
🔦 The scaffold used to create pardjs module template
https://github.com/pardjs/create-pardjs-module
Last synced: 3 months ago
JSON representation
🔦 The scaffold used to create pardjs module template
- Host: GitHub
- URL: https://github.com/pardjs/create-pardjs-module
- Owner: pardjs
- Created: 2019-05-14T06:09:16.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T06:51:56.000Z (over 2 years ago)
- Last Synced: 2025-03-11T10:50:36.628Z (4 months ago)
- Language: TypeScript
- Size: 681 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
create-pardjs-module
====================The cli fool for create pardjs module scaffold
[](https://oclif.io)
[](https://npmjs.org/package/create-pardjs-module)
[](https://npmjs.org/package/create-pardjs-module)
[](https://github.com/dozto/create-pardjs-module/blob/master/package.json)# Usage
This is a lib followed NPX approach to create module project for pardjs.
Use this with yarn `yarn create pardjs-module [module-name]`
Once sucess the `module-name` will be created at the same folder that you execute this command.
# Commands
Run the command with `yarn [command]`
**Please always use `yarn commit` instead of `git commit`**
```yaml
lint: lint all ts file in src and test folder.
build: Compile and build the project.
build:doc: Build doc with typedoc lib.
test: Execute the test in the project.
test:watch: Execute the test in watch mode.
commit: Make a commit followed the best approach.
release: Make a release followed the best approach (For module it will publish to NPM, for service it will build docker image.)
```