Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oyeharry/modugen
Simple micro generator for simple needs!
https://github.com/oyeharry/modugen
api cli file files generate generator micro modugen module scaffolding simple
Last synced: 3 months ago
JSON representation
Simple micro generator for simple needs!
- Host: GitHub
- URL: https://github.com/oyeharry/modugen
- Owner: oyeharry
- License: mit
- Created: 2020-05-01T10:45:28.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T15:34:15.000Z (almost 2 years ago)
- Last Synced: 2024-10-07T07:47:44.326Z (3 months ago)
- Topics: api, cli, file, files, generate, generator, micro, modugen, module, scaffolding, simple
- Language: JavaScript
- Size: 307 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# modugen [](https://github.com/oyeharry/modugen/actions?query=workflow%3Amodugen-master)
> Simple micro generator for simple needs!
## Usage
1. Add modugen to your project
```
yarn add modugen --dev
```
2. Create `templates/CoreModule.[pascalCase].js` file at root of your project. `templates` directory is the default home for your all module templates.
```javascript
import React from 'react';
function $[pascalCase](props) {
return $[titleCase];
}
export default $[pascalCase];
```
3. Execute following command and your `BaseButton.js` module will be generated at your project root.
```
yarn run modugen CoreModule.BaseButton
```
## Install Globally
Install modugen globally for easy access.
```
npm i modugen -g
```
## Generating module directory
1. Create a module template directory structure like the following. Now your CoreModule template directory is inside src directory including all the related files.
```
├── templates
│ └── src
│ └── CoreModule.[dashCase]
│ ├── [camelCase].todo
│ ├── [pascalCase].jsx
│ ├── [pascalCase].test.js
│ └── index.js
```
2. Run following command to generate `BaseButton` module.
```
modugen src.CoreModule.BaseButton
```
The `BaseButton` module will be generated at your project root `src` directory like following.
```
│── src
│ └── base-button
│ ├── baseButton.todo
│ ├── BaseButton.jsx
│ ├── BaseButton.test.js
│ └── index.js
```
## Supported Case Formats
- **camelCase**: exampleFormatOfThis
- **snakeCase**: example_format_of_this
- **dashCase/hyphenatedCase/kebabCase**: example-format-of-this
- **dotCase**: example.format.of.this
- **pascalCase/properCase**: ExampleFormatOfThis
- **lowerCase**: example format of this
- **constantCase**: EXAMPLE_FORMAT_OF_THIS
- **titleCase**: Example Format Of This
## CLI Usage
```
Usage
$ modugen .
Options
--cwd current working directory
--templateFilesDir templates directory to look for. Default is ./templates
--destPath destination directory for output.
Examples
Look for template file name starting with 'CoreModule' inside 'templates/' and generate BaseButton module.
$ modugen CoreModule.BaseButton
Look for template file name starting with 'CoreModule' inside 'templates/src/' and generate BaseButton module.
$ modugen src.CoreModule.BaseButton
Look for template file name starting with 'PageModule' inside 'templates/src/pages' and generate HomePage module at 'src/pages/'.
$ modugen src.pages.PageModule.HomePage
```
## API Usage
```javascript
import modugen from 'modugen';
/* Look for template file name starting with 'CoreModule'
* inside './templates/' and generate BaseButton module.
*/
await modugen('CoreModule.BaseButton');
// With options to override defaultOptions
await modugen('CoreModule.BaseButton', {
templateFilesDir: './my-module-templates',
destPath: './modules',
});
```
#### options
Type: `object`
##### templateFilesDir
Type: `string`
Default: `./templates`
templates directory to look for.
##### destPath
Type: `string`
Default: ``
Output destination.
## License
MIT ©