Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ledevnovice/nestjs-module-cloner
An npm package for cloning and renaming NestJS modules and their associated resources.
https://github.com/ledevnovice/nestjs-module-cloner
nestjs npm npm-package typescript
Last synced: about 9 hours ago
JSON representation
An npm package for cloning and renaming NestJS modules and their associated resources.
- Host: GitHub
- URL: https://github.com/ledevnovice/nestjs-module-cloner
- Owner: LeDevNovice
- Created: 2024-07-14T19:56:44.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-08-03T18:23:59.000Z (5 months ago)
- Last Synced: 2024-11-09T04:09:00.020Z (about 2 months ago)
- Topics: nestjs, npm, npm-package, typescript
- Language: TypeScript
- Homepage:
- Size: 72.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Nestjs Module Cloner
A command-line tool for cloning and renaming NestJS modules and their associated resources. This tool helps streamline the development process by automating the copying and renaming of modules, resources, and their references within a NestJS project.
## Table of Contents
- [Nestjs Module Cloner](#nestjs-module-cloner)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
## Features
- Clone existing NestJS modules and their resources.
- Automatically rename files and update references.
- Recursively handles nested directories and files.
- Simple command-line interface.
## Installation
To install the package, run the following command:
```bash
npm install nestjs-module-cloner -g
```
## Usage
To use the tool, navigate to the root of your NestJS project in the terminal and run the following command:
```bash
nmc
```
- sourceModule : The name of the existing module you want to clone.
- sourceResourceName : The name of the resource you want to rename.
- newModule : The name for the new module being created.
- newResourceName : The new name for the resource.
```bash
nmc products product articles article
```
## Contributing
Contributions are welcome! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch.
- Make your changes and commit them.
- Push to the branch.
- Open a pull request on the develop branch.