https://github.com/hadenlabs/plop-utils
Utilities for plop generator.
https://github.com/hadenlabs/plop-utils
codegenerator hadenlabs peru plop tools typescript utils
Last synced: 7 months ago
JSON representation
Utilities for plop generator.
- Host: GitHub
- URL: https://github.com/hadenlabs/plop-utils
- Owner: hadenlabs
- License: lgpl-3.0
- Created: 2021-04-20T02:07:54.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2022-02-28T03:48:52.000Z (over 3 years ago)
- Last Synced: 2025-02-05T07:24:31.637Z (8 months ago)
- Topics: codegenerator, hadenlabs, peru, plop, tools, typescript, utils
- Language: Makefile
- Homepage:
- Size: 203 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code_of_conduct.md
Awesome Lists containing this project
README
# plop-utils
[](https://github.com/hadenlabs/plop-utils/releases) [](https://github.com/hadenlabs/plop-utils/actions) [](https://github.com/hadenlabs/plop-utils/issues) [](https://github.com/hadenlabs/plop-utils/releases)
plop-utils configuration
## Installation
### [yarn](https://yarnpkg.com)
If you're using [yarn](https://yarnpkg.com)
```shell
yarn add --dev @hadenlabs/plop-utils
```
### [npm](https://www.npmjs.com)
If you're using [npm](https://www.npmjs.com)
```shell
npm i --save-dev @hadenlabs/plop-utils
```
## Usage
1. Install the [@hadenlabs/plop-utils](https://www.npmjs.com/package/@hadenlabs/plop-utils) package as a dev dependency.
```shell
yarn add --dev @hadenlabs/plop-utils
```
2. Create a `plopfile.ts` in the root of your project and setup initial generators.
```ts
import { setupPlop } from '@hadenlabs/plop-utils'
import { NodePlopAPI } from 'plop'
export default function plopGenerator(plop: NodePlopAPI): void {
setupPlop(plop)
}
```
3. Run the generator and follow the instructions that appear in the terminal.
```shell
yarn plop
```
## Examples
### basic
```ts
import { setupPlop } from '@hadenlabs/plop-utils
import { NodePlopAPI } from 'plop'
export default function plopGenerator(plop: NodePlopAPI): void {
setupPlop(plop)
}
```
## Help
**Got a question?**
File a GitHub [issue](https://github.com/hadenlabs/plop-utils/issues).
## Contributing
### Bug Reports & Feature Requests
Please use the [issue tracker](https://github.com/hadenlabs/plop-utils/issues) to report any bugs or file feature requests.
### Development
In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.
1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull Request** so that we can review your changes
**NOTE:** Be sure to rebase the latest changes from "upstream" before making a pull request!
## Module Versioning
This Module follows the principles of [Semantic Versioning (SemVer)](https://semver.org/).
Using the given version number of `MAJOR.MINOR.PATCH`, we apply the following constructs:
1. Use the `MAJOR` version for incompatible changes.
1. Use the `MINOR` version when adding functionality in a backwards compatible manner.
1. Use the `PATCH` version when introducing backwards compatible bug fixes.
### Backwards compatibility in `0.0.z` and `0.y.z` version
- In the context of initial development, backwards compatibility in versions `0.0.z` is **not guaranteed** when `z` is increased. (Initial development)
- In the context of pre-release, backwards compatibility in versions `0.y.z` is **not guaranteed** when `y` is increased. (Pre-release)
## Copyright
Copyright © 2018-2021 [Hadenlabs](https://hadenlabs.com)
## Trademarks
All other trademarks referenced herein are the property of their respective owners.
## License
The code and styles are licensed under the LGPL-3.0 license [See project license.](LICENSE).
## Don't forget to 🌟 Star 🌟 the repo if you like plop-utils
[Your feedback is appreciated](https://github.com/hadenlabs/plop-utils/issues)