feature(putout) add @putout/plugin-npmignore

coderaiser · coderaiser · commit 8b093626fd16 · 2020-12-23T15:38:01.000+02:00
diff --git a/.npmignore b/.npmignore
@@ -1,2 +1 @@
-.madrun.js
-
+.*
diff --git a/README.md b/README.md
@@ -1087,6 +1087,7 @@ Next packages not bundled with `putout` but can be installed separately.
 | [`@putout/plugin-add-return-await`](/packages/plugin-add-return-await) | [![npm](https://img.shields.io/npm/v/@putout/plugin-add-return-await.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-add-return-await) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-add-return-await)](https://david-dm.org/coderaiser/putout?path=packages/plugin-add-return-await) |
 | [`@putout/plugin-promises`](/packages/plugin-promises) | [![npm](https://img.shields.io/npm/v/@putout/plugin-promises.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-promises) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-promises)](https://david-dm.org/coderaiser/putout?path=packages/plugin-promises) |
 | [`@putout/plugin-gitignore`](/packages/plugin-gitignore) | [![npm](https://img.shields.io/npm/v/@putout/plugin-gitignore.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-gitignore) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-gitignore)](https://david-dm.org/coderaiser/putout?path=packages/plugin-gitignore) |
+| [`@putout/plugin-npmignore`](/packages/plugin-npmignore) | [![npm](https://img.shields.io/npm/v/@putout/plugin-npmignore.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-npmignore) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-npmignore)](https://david-dm.org/coderaiser/putout?path=packages/plugin-npmignore) |
 | [`@putout/plugin-travis`](/packages/plugin-travis) | [![npm](https://img.shields.io/npm/v/@putout/plugin-travis.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-travis) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-travis)](https://david-dm.org/coderaiser/putout?path=packages/plugin-travis) |
 | [`@putout/plugin-regexp`](/packages/plugin-regexp) | [![npm](https://img.shields.io/npm/v/@putout/plugin-regexp.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-regexp) | [![Dependency Status](https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-regexp)](https://david-dm.org/coderaiser/putout?path=packages/plugin-regexp) |
 
diff --git a/packages/plugin-npmignore/.eslintrc.json b/packages/plugin-npmignore/.eslintrc.json
@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "plugin:node/recommended",
+        "plugin:putout/recommended"
+    ],
+    "plugins": [
+        "node",
+        "putout"
+    ]
+}
diff --git a/packages/plugin-npmignore/.gitignore b/packages/plugin-npmignore/.gitignore
@@ -0,0 +1,6 @@
+node_modules
+.nyc_output
+*.swp
+yarn-error.log
+
+.putoutcache
diff --git a/packages/plugin-npmignore/.madrun.js b/packages/plugin-npmignore/.madrun.js
@@ -0,0 +1,13 @@
+'use strict';
+
+const {run} = require('madrun');
+
+module.exports = {
+    'test': () => `tape 'test/*.js' 'lib/**/*.spec.js'`,
+    'watch:test': async () => `nodemon -w lib -x ${await run('test')}`,
+    'lint': () => `putout .`,
+    'fix:lint': () => run('lint', '--fix'),
+    'coverage': async () => `nyc ${await run('test')}`,
+    'report': () => `nyc report --reporter=text-lcov | coveralls || true`,
+};
+
diff --git a/packages/plugin-npmignore/.npmignore b/packages/plugin-npmignore/.npmignore
@@ -0,0 +1,7 @@
+.*
+*.spec.js
+test
+fixture
+yarn-error.log
+
+madrun.js
diff --git a/packages/plugin-npmignore/.putout.json b/packages/plugin-npmignore/.putout.json
@@ -0,0 +1,7 @@
+{
+    "match": {
+        "lib/index.js": {
+            "remove-useless-spread/object": "off"
+        }
+    }
+}
diff --git a/packages/plugin-npmignore/LICENSE b/packages/plugin-npmignore/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/plugin-npmignore/README.md b/packages/plugin-npmignore/README.md
@@ -0,0 +1,39 @@
+# @putout/plugin-npmignore [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+
+[NPMIMGURL]:                https://img.shields.io/npm/v/@putout/plugin-npmignore.svg?style=flat&longCache=true
+[NPMURL]:                   https://npmjs.org/package/@putout/plugin-npmignore"npm"
+
+[DependencyStatusURL]:      https://david-dm.org/coderaiser/putout?path=packages/plugin-npmignore
+[DependencyStatusIMGURL]:   https://david-dm.org/coderaiser/putout.svg?path=packages/plugin-npmignore
+
+`putout` plugin helps with `putout` plugins development.
+
+## Install
+
+```
+npm i @putout/plugin-npmignore -D
+```
+
+## Rules
+
+```json
+{
+    "rules": {
+        "npmignore/add-dot-files": "on"
+    }
+}
+```
+
+## Add dot files
+
+Adds `.*` into .npmignore.
+
+```diff
++.*
+test
+```
+
+## License
+
+MIT
+
diff --git a/packages/plugin-npmignore/lib/add-dot-files/fixture/npmignore-fix.js b/packages/plugin-npmignore/lib/add-dot-files/fixture/npmignore-fix.js
@@ -0,0 +1 @@
+__putout_processor_ignore(['.*', 'test']);
diff --git a/packages/plugin-npmignore/lib/add-dot-files/fixture/npmignore.js b/packages/plugin-npmignore/lib/add-dot-files/fixture/npmignore.js
@@ -0,0 +1,3 @@
+__putout_processor_ignore([
+    'test'
+]);
diff --git a/packages/plugin-npmignore/lib/add-dot-files/fixture/present.js b/packages/plugin-npmignore/lib/add-dot-files/fixture/present.js
@@ -0,0 +1,4 @@
+__putout_processor_ignore([
+    '.*',
+    'test',
+]);
diff --git a/packages/plugin-npmignore/lib/add-dot-files/index.js b/packages/plugin-npmignore/lib/add-dot-files/index.js
@@ -0,0 +1,22 @@
+'use strict';
+
+const {types} = require('putout');
+const {StringLiteral} = types;
+const getValue = ({value}) => value;
+
+module.exports.report = () => '.* should be added to .npmignore';
+
+module.exports.match = () => ({
+    '__putout_processor_ignore(__a)': ({__a}) => {
+        const list = __a.elements.map(getValue);
+        return !list.includes('.*');
+    },
+});
+
+module.exports.replace = () => ({
+    '__putout_processor_ignore(__a)': ({__a}, path) => {
+        __a.elements.unshift(StringLiteral('.*'));
+        return path;
+    },
+});
+
diff --git a/packages/plugin-npmignore/lib/add-dot-files/index.spec.js b/packages/plugin-npmignore/lib/add-dot-files/index.spec.js
@@ -0,0 +1,20 @@
+'use strict';
+
+const test = require('@putout/test')(__dirname, {
+    npmignore: require('..'),
+});
+
+test('plugin-npmignore: report', (t) => {
+    t.report('npmignore', '.* should be added to .npmignore');
+});
+
+test('plugin-npmignore: transform', (t) => {
+    t.transform('npmignore');
+    t.end();
+});
+
+test('plugin-npmignore: no transform: present', (t) => {
+    t.noTransform('present');
+    t.end();
+});
+
diff --git a/packages/plugin-npmignore/lib/index.js b/packages/plugin-npmignore/lib/index.js
@@ -0,0 +1,10 @@
+'use strict';
+
+const getRule = (a) => ({
+    [a]: require(`./${a}`),
+});
+
+module.exports.rules = {
+    ...getRule('add-dot-files'),
+};
+
diff --git a/packages/plugin-npmignore/package.json b/packages/plugin-npmignore/package.json
@@ -0,0 +1,56 @@
+{
+  "name": "@putout/plugin-npmignore",
+  "version": "1.0.0",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "putout plugin helps whith .npmignore",
+  "homepage": "http://github.com/coderaiser/putout",
+  "main": "lib/index.js",
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/coderaiser/putout.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage"
+  },
+  "nyc": {
+    "exclude": [
+      "*/**/*.spec.js",
+      "test"
+    ]
+  },
+  "dependencies": {},
+  "keywords": [
+    "putout",
+    "putout-plugin",
+    "plugin",
+    "npmignore"
+  ],
+  "devDependencies": {
+    "@putout/test": "^3.0.0",
+    "coveralls": "^3.0.0",
+    "eslint": "^7.6.0",
+    "eslint-plugin-node": "^11.0.0",
+    "eslint-plugin-putout": "^6.0.0",
+    "lerna": "^3.8.5",
+    "madrun": "^8.0.1",
+    "nodemon": "^2.0.1",
+    "nyc": "^15.0.1"
+  },
+  "peerDependencies": {
+    "putout": ">=12"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=12"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}
diff --git a/packages/plugin-npmignore/test/fixture/npmignore-fix.js b/packages/plugin-npmignore/test/fixture/npmignore-fix.js
@@ -0,0 +1 @@
+__putout_processor_ignore(['.*', 'test']);
diff --git a/packages/plugin-npmignore/test/fixture/npmignore.js b/packages/plugin-npmignore/test/fixture/npmignore.js
@@ -0,0 +1,3 @@
+__putout_processor_ignore([
+    'test'
+]);
diff --git a/packages/plugin-npmignore/test/npmignore.js b/packages/plugin-npmignore/test/npmignore.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const test = require('@putout/test')(__dirname, {
+    npmignore: require('..'),
+});
+
+test('plugin-putout: transform', (t) => {
+    t.transform('npmignore');
+    t.end();
+});
+
diff --git a/packages/putout/package.json b/packages/putout/package.json
@@ -95,6 +95,7 @@
     "@putout/plugin-merge-destructuring-properties": "^5.0.0",
     "@putout/plugin-merge-duplicate-imports": "^3.0.0",
     "@putout/plugin-merge-if-statements": "^3.0.0",
+    "@putout/plugin-npmignore": "^1.0.0",
     "@putout/plugin-promises": "^4.0.0",
     "@putout/plugin-putout": "^5.0.0",
     "@putout/plugin-putout-config": "^1.0.0",
diff --git a/packages/putout/putout.json b/packages/putout/putout.json
@@ -44,6 +44,9 @@
         ".gitignore": {
             "gitignore": "on"
         },
+        ".npmignore": {
+            "npmignore": "on"
+        },
         "webpack.config.js": {
             "webpack": "on"
         },
@@ -106,6 +109,7 @@
         "madrun": "off",
         "webpack": "off",
         "gitignore": "off",
+        "npmignore": "off",
         "travis": "off",
         "tape": "off",
         "strict-mode": "off",
@@ -185,6 +189,7 @@
         "putout-config",
         "promises",
         "gitignore",
+        "npmignore",
         "regexp",
         "travis",
         "tape"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+__putout_processor_ignore(['.*', 'test']);`