mrm - npm Package Compare versions
Comparing version 0.1.0 to 0.1.1
| { | ||
| "name": "mrm", | ||
| "version": "0.1.0", | ||
| "version": "0.1.1", | ||
| "description": "Simplistic project dotfiles organizer", | ||
@@ -5,0 +5,0 @@ "author": { |
@@ -12,3 +12,3 @@ # Marmot (mrm) | ||
| * Has tools to work with JSON, YAML, INI, Markdown and text files | ||
| * Has bunch customizable taks (see the list below) | ||
| * Has bunch customizable tasks (see the list below) | ||
| * Easy to write your own tasks | ||
@@ -29,4 +29,6 @@ | ||
| * `mrm` — Print list of task | ||
| * `mrm <task>` — Run taks | ||
| * `mrm <task>` — Run tasks | ||
| (You will need a configuration file first.) | ||
| ## Configuration | ||
@@ -43,4 +45,4 @@ | ||
| "indent": "tab", // "tab" or number of spaces | ||
| "readme", "Readme.md", // Name of readme file | ||
| "license", "License.md", // Name of license file | ||
| "readme": "Readme.md", // Name of readme file | ||
| "license": "License.md", // Name of license file | ||
| "aliases": { // Aliases to run multiple tasks at once | ||
@@ -54,7 +56,7 @@ "node": ["license", "readme", "package", "editorconfig", "eslint", "gitignore"] | ||
| ## editorconfig | ||
| ### editorconfig | ||
| Adds `.editorconfig`. | ||
| ## eslint | ||
| ### eslint | ||
@@ -67,23 +69,23 @@ Adds `.eslintrc` and `.eslintignore`, adds npm script and inistalls dependencies. | ||
| ## gitignore | ||
| ### gitignore | ||
| Adds `.gitignore` with `node_modules`, logs and artifacts of popular code editors. | ||
| ## license | ||
| ### license | ||
| Adds MIT license file. | ||
| ## lintstaged | ||
| ### lintstaged | ||
| Adds lint-staged: creates `.lintstagedrc`, sets up pre-commit Git hook and inistalls dependencies. | ||
| ## package | ||
| ### package | ||
| Creates `package.json` and adds npm badge to Readme. | ||
| ## readme | ||
| ### readme | ||
| Creates readme file. | ||
| ## travis | ||
| ### travis | ||
@@ -102,5 +104,14 @@ Creates `.travis.yml`and adds Travis CI badge to Readme. | ||
| }; | ||
| module.exports.description = 'Taks description'; | ||
| module.exports.description = 'Task description'; | ||
| ``` | ||
| 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: | ||
| ```bash | ||
| cd ~/.mrm | ||
| # or: cd ~/dotfiles/mrm | ||
| npm init -y | ||
| npm install --save mrm-core | ||
| ``` | ||
| See [mrm-core](https://github.com/sapegin/mrm-core) library for useful functions for your tasks. | ||
@@ -107,0 +118,0 @@ |
@@ -47,3 +47,10 @@ 'use strict'; | ||
| ; | ||
| console.log(` | ||
| 1. Activate your repository on Travis CI: | ||
| ${url} | ||
| 2. Push your changes | ||
| `); | ||
| }; | ||
| module.exports.description = 'Adds Travis CI'; |
New alerts
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
Fixed alerts
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
Improved metrics
- Total package byte prevSize
- increased by2.32%
16860
- Lines of code
- increased by1.25%
405
- Number of lines in readme file
- increased by9.4%
128