Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emyann/matron
A Domain Specific Language à-la Dockerfile with a CLI to scaffold your projects.
https://github.com/emyann/matron
angular cli command-line es6 jasmine javascript jest karma nodejs npm parcel react schematics typescript webpack
Last synced: about 1 month ago
JSON representation
A Domain Specific Language à-la Dockerfile with a CLI to scaffold your projects.
- Host: GitHub
- URL: https://github.com/emyann/matron
- Owner: emyann
- Created: 2018-12-25T20:15:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-05T09:27:37.000Z (over 1 year ago)
- Last Synced: 2024-07-27T07:33:11.297Z (about 1 month ago)
- Topics: angular, cli, command-line, es6, jasmine, javascript, jest, karma, nodejs, npm, parcel, react, schematics, typescript, webpack
- Language: TypeScript
- Homepage:
- Size: 2.19 MB
- Stars: 11
- Watchers: 5
- Forks: 0
- Open Issues: 24
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# Matron
> A Domain Specific Language à-la Dockerfile with a CLI to scaffold your projects.
[](https://www.npmjs.com/package/matron) [](https://npm-stat.com/charts.html?package=matron) [](https://circleci.com/gh/emyann/matron)
- [Matron](#matron)
- [Installation](#installation)
- [Quick start](#quick-start)
- [Commands](#commands)
- [`matron create`](#matron-create)
- [Matron File](#matron-file)
- [Schema](#schema)
- [Environments variables](#environments-variables)
- [Dynamic variables](#dynamic-variables)
- [Dotenv variables](#dotenv-variables)
## Installation
**Using `npx`**
If you don't prefer to install the CLI, you can use it through `npx` this way
```sh
npx matron --help
```
**Install with `npm`**
You can also install the CLI globally
```sh
npm i -g matron
matron --help
```
## Quick start
The minimal setup required to use matron and scaffold a new project is a **`matron.yml`** file.
Let's start with the example below:
📄 **`matron.yml`**
```yml
jobs:
create-folder:
name: Create project folder
steps:
- RUN: npx mkdirp ${PROJECT_PATH}
init-project:
name: Initialize package.json
steps:
- WORKDIR: ${PROJECT_PATH}
- RUN: npm init -y
add-typescript:
name: Add TypeScript
steps:
- RUN: yarn add -D typescript
```
▶️ **matron command**
```sh
matron create --matron-file=./matron.yml --project my-project
```
Let's break down each steps:
1. **Create project folder**
1. `RUN: npx mkdirp ${PROJECT_PATH}`: With the `RUN` command you can execute any command that is possible to execute on your shell.
2. Here we are using [`mkdirp`](https://www.npmjs.com/package/mkdirp) to create a folder at the path `my-project`.
3. `${PROJECT_PATH}` is a default environment variable provided when you specify the option `--project`.
2. **Initialize package.json**
1. `WORKDIR: ${PROJECT_PATH}`: With the `WORKDIR` command, all the subsequent `RUN` commands will be executed in the specified path, in this case `${PROJECT_PATH}` equals `my-project`.
2. `RUN: npm init -y`: This will create a minimal `package.json` file.
3. **Add TypeScript**
1. `RUN: yarn add -D typescript`: Add TypeScript as dev dependencies.
When executed, this will result in the following file tree:
```sh
my-project
├── node_modules
├── package.json
└── yarn.lock
```
💡**You can learn more about the available commands [here](#commands).**
💡**You can learn more about matron file schema [here](#matron-file).**
## Commands
### `matron create`
> Create a project using a matron file
```sh
matron create [--matron-file] [--project] [--template] [--env-folder]
```
**Options**
Name | Alias | Description
------------------|-------|----------------------------------------------
**--matron-file** | -f | Matron file path.
**--project** | -p | Name or Path of the project to create.
**--template** | -t | Folder containing at least a matron.yml file.
**--env-folder** | | .env files folder.
**--help** | | Show help
**Examples**
```sh
# Creates a project at ./my-project using ./matron.yml file
matron create --matron-file=./matron.yml --project my-project
# Creates a project at path/to/ts-project using a template folder containing a matron.yml file and/or a .env file
matron create --template ./matron-templates/typescript --project path/to/ts-project
```
## Matron File
### Schema
### Environments variables
#### Dynamic variables
#### Dotenv variables