@putout/plugin-gitignore 7.0.2 → 7.0.4

package/README.md

@@ -3,7 +3,11 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-gitignore.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/plugin-gitignore "npm"
 
-🐊[**Putout**](https://github.com/coderaiser/putout) plugin helps with 🐊[**Putout**](https://github.com/coderaiser/putout) plugins development.
+> A `.gitignore` file specifies intentionally untracked files that Git should ignore. Files already tracked by Git are not affected.
+>
+> (c) [git-scm.com](https://git-scm.com/docs/gitignore)
+
+🐊[**Putout**](https://github.com/coderaiser/putout) plugin helps with `.gitignore`.
 
 ## Install
 
@@ -13,48 +17,70 @@ npm i @putout/plugin-gitignore -D
 
 ## Rules
 
-By default, all files enabled, if you want disable some of them use `dismiss` property:
+- ✅ [add](#add);
+- ✅ [sort](#sort);
+
+## Config
 
 ```json
 {
     "rules": {
-        "gitignore": ["on", {
+        "gitignore/add": ["on", {
             "dismiss": [
                 "*.swp",
                 "coverage",
                 "*.lock",
                 "*.log"
             ]
-        }]
+        }],
+        "gitignore/sort": "on"
     }
 }
 ```
 
-## Add Putoutcache
+## add
 
-Adds `.putoutcache` into .gitignore.
+Adds `.putoutcache`, `*.swp`, `.idea`:
 
 ```diff
 node_modules
 +.putoutcache
++*.swp
++.idea
 ```
 
-## Add Vim Files
+## sort
 
-Adds `*.swp` into .gitignore.
+### ❌ Example of incorrect code
 
-```diff
-+*.swp
+```ignore
 node_modules
+*.swp
+yarn-error.log
+yarn.lock
+.idea
+.DS_Store
+deno.lock
+
+coverage
+.filesystem.json
 ```
 
-## Add `.idea` Files
+### ✅ Example of correct code
 
-Adds `*.swp` into .gitignore.
+```ignore
+.idea
+.filesystem.json
+.DS_Store
+
+*.swp
+
+yarn-error.log
+yarn.lock
+deno.lock
 
-```diff
-+.idea
 node_modules
+coverage# sort
 ```
 
 ## License

package/lib/index.js

@@ -0,0 +1,7 @@
+import * as add from './add/index.js';
+import * as sort from './sort/index.js';
+
+export const rules = {
+    add,
+    sort,
+};

package/lib/sort/index.js

@@ -0,0 +1,11 @@
+import {operator} from 'putout';
+
+const {sortIgnore} = operator;
+
+export const {
+    fix,
+    report,
+    traverse,
+} = sortIgnore({
+    name: '.gitignore',
+});

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@putout/plugin-gitignore",
-  "version": "7.0.2",
+  "version": "7.0.4",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin helps with .gitignore",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-gitignore#readme",
-  "main": "lib/gitignore.js",
+  "main": "lib/index.js",
   "release": false,
   "tag": false,
   "changelog": false,