Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/moonwalker/mrm-presets

mrm presets for :moon: :walking:
https://github.com/moonwalker/mrm-presets

generator mrm-preset react

Last synced: 8 days ago
JSON representation

mrm presets for :moon: :walking:

Host: GitHub
URL: https://github.com/moonwalker/mrm-presets
Owner: moonwalker
License: mit
Created: 2018-04-16T07:16:25.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-10-29T09:33:33.000Z (18 days ago)
Last Synced: 2024-10-29T11:43:35.188Z (18 days ago)
Topics: generator, mrm-preset, react
Language: JavaScript
Homepage:
Size: 87.9 KB
Stars: 0
Watchers: 9
Forks: 0
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# [mrm](https://github.com/sapegin/mrm) presets for :moon: :walking:

[![](https://img.shields.io/npm/v/@moonwalker/mrm-presets.svg)](https://www.npmjs.com/package/@moonwalker/mrm-presets)
[![](https://badges.renovateapi.com/github/moonwalker/mrm-presets)](https://app.renovatebot.com/dashboard#github/moonwalker/mrm-presets)

## Install

```shell
# Install mrm globally if need it
npm i -g mrm

# Install presets package
npm i -g @moonwalker/mrm-presets

```

## Presets

- [`react-component`](#react-component)
- `orbit-ui-component`
- [`release-it`](#release-it)
- [`pre-flight-check`](#pre-flight-check)

## react-component

Generate React component folder

```shell
mrm react-component --preset @moonwalker/mrm-presets --config:slug top-navigation --config:prefix components/signup

// Running react-component...
// Create src/components/signup/top-navigation/index.js
// Create src/components/signup/top-navigation/top-navigation.component.js
// Create src/components/signup/top-navigation/top-navigation.stories.js
// Create src/components/signup/top-navigation/top-navigation.styl
```

Run the generator in the current dirrectory:

```shell
cd src/components
mrm react-component --preset @moonwalker/mrm-presets --config:slug top-navigation --config:cwd . --config:prefix signup

## release-it

Custom release flow based on [release-it](https://github.com/release-it/release-it).

Usage:
```shell
yarn bump
```

or
```shell
npm run bump
```

### How is working

When running `bump` command, `release-it` will do the following steps locally:

1. set a new package version
- on master, a new semver version will be inferred based on [Angular conventional changelog format](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-angular/README.md)
- on a branch, a new beta tag will be generated

The version can be manually set by choosing the custom version option.

2. tag the commit
3. push the code & tags
4. create a Github release(`GITHUB_TOKEN` required)

CI will run the publish flow for tagged commits.

## pre-flight-check

Add linting & formatting configs for [@moonwalker/pre-flight-check](https://github.com/moonwalker/pre-flight-check)

#### How is working
[lint-staged](https://www.npmjs.com/package/lint-staged) is running [Prettier](https://www.npmjs.com/package/prettier) and [Eslint](https://www.npmjs.com/package/eslint) before commit. If there are eslint errors, the commit will stop.

To skip the check entirely, you can use `git commit --no-verify`.