Comparing version 0.3.1 to 0.3.2
{ | ||
"name": "mrm", | ||
"version": "0.3.1", | ||
"version": "0.3.2", | ||
"description": "Simplistic project dotfiles organizer", | ||
@@ -32,3 +32,2 @@ "author": { | ||
"chalk": "^1.1.3", | ||
"eslint-plugin-prettier": "^2.1.2", | ||
"glob": "^7.1.2", | ||
@@ -39,3 +38,2 @@ "lodash": "^4.17.4", | ||
"mrm-core": "^2.1.0", | ||
"prettier": "^1.4.4", | ||
"semver-utils": "^1.1.1", | ||
@@ -48,3 +46,5 @@ "update-notifier": "^2.2.0", | ||
"eslint-config-tamia": "^4.1.1", | ||
"eslint-plugin-prettier": "^2.1.2", | ||
"jest": "^20.0.4", | ||
"prettier": "^1.4.4", | ||
"semantic-release": "^6.3.6", | ||
@@ -51,0 +51,0 @@ "semantic-release-tamia": "^1.1.1" |
@@ -6,3 +6,3 @@ # Marmot (mrm) | ||
Command line tool to help you keep dotfiles (`.gitignore`, `.eslintrc`, etc.) of all your open source projects in sync. | ||
Command line tool to help you keep configuration (`package.json`, `.gitignore`, `.eslintrc`, etc.) of your open source projects in sync. | ||
@@ -13,8 +13,10 @@ ## Features | ||
* Has tools to work with JSON, YAML, INI, Markdown and text files | ||
* Has bunch of customizable tasks (see the [list below](#tasks)) | ||
* Easy to write your own tasks | ||
* Has bunch of [customizable tasks](#tasks) | ||
* Easy to write [your own tasks](#custom-tasks) | ||
![](https://d3vv6lp55qjaqc.cloudfront.net/items/1g0e2M3m2Y3j0m3B3n1t/Image%202017-06-20%20at%209.00.39%20PM.png) | ||
## Motivation | ||
Most of the available tools are template based. It works moderately well for new project generation but doesn’t work well for updating. Marmot’s approach is closer to codemods than templates. | ||
Most of the available tools are template based. Template approach works moderately well for new project generation but doesn’t work well for updating. Marmot’s approach is closer to [codemods](https://github.com/facebook/codemod) than templates. | ||
@@ -29,6 +31,6 @@ ## Installation | ||
* `mrm` — Print list of tasks | ||
* `mrm <task>` — Run tasks | ||
* `mrm` — print list of tasks | ||
* `mrm <task>` — run a task | ||
(You will need a configuration file first.) | ||
(You need to create a configuration file first — see below.) | ||
@@ -124,3 +126,3 @@ ## Configuration | ||
Create either `~/.mrm/<taskname>/index.js` or `~/dotfiles/mrm/<taskname>/index.js`. If `<taskname>` is the same as one of the internal tasks, then your task will override internal one: | ||
Create either `~/.mrm/<taskname>/index.js` or `~/dotfiles/mrm/<taskname>/index.js`. If `<taskname>` is the same as one of the internal tasks your task will override an internal one. | ||
@@ -136,7 +138,6 @@ ```js | ||
If your custom tasks have dependencies (such as `mrm-core`) you should initialize the mrm folder as an npm module, and set your dependencies there: | ||
If your custom tasks have dependencies (such as `mrm-core`) you should initialize the `mrm` folder as an npm module and list your dependencies there: | ||
```bash | ||
cd ~/.mrm | ||
# or: cd ~/dotfiles/mrm | ||
cd ~/.mrm # or cd ~/dotfiles/mrm | ||
npm init -y | ||
@@ -146,3 +147,3 @@ npm install --save mrm-core | ||
See [mrm-core](https://github.com/sapegin/mrm-core) library for useful functions for your tasks. | ||
[mrm-core](https://github.com/sapegin/mrm-core) is an utility library created to write Mrm tasks, it has function to work with common config files (JSON, YAML, INI, Markdown), npm dependencies, etc. | ||
@@ -149,0 +150,0 @@ You can find [some examples here](https://github.com/sapegin/dotfiles/tree/master/mrm) or check [code of internal tasks](https://github.com/sapegin/mrm/tree/master/src/tasks). |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
30457
9
159
7
- Removedeslint-plugin-prettier@^2.1.2
- Removedprettier@^1.4.4
- Removedeslint-plugin-prettier@2.7.0(transitive)
- Removedfast-diff@1.3.0(transitive)
- Removedjest-docblock@21.2.0(transitive)
- Removedprettier@1.19.1(transitive)