@putout/plugin-package-json 1.0.0 → 2.0.0

package/README.md

@@ -1,11 +1,9 @@
-# @putout/plugin-package-json [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+# @putout/plugin-package-json [![NPM version][NPMIMGURL]][NPMURL]
 
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-package-json.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/plugin-package-json"npm"
-[DependencyStatusURL]: https://david-dm.org/coderaiser/package-json?path=packages/plugin-package-json
-[DependencyStatusIMGURL]: https://david-dm.org/coderaiser/package-json.svg?path=packages/plugin-package-json
 
-`putout` plugin helps to automate fixing `package-json` config.
+🐊[`Putout`](https://github.com/coderaiser/putout) plugin helps to automate fixing `package-json` config.
 
 ## Install
 
@@ -18,14 +16,15 @@ npm i @putout/plugin-package-json -D
 ```json
 {
     "rules": {
-        "package-json/remove-nyc": "on"
+        "package-json/remove-nyc": "on",
+        "package-json/add-type": "on"
     }
 }
 ```
 
 ## remove-nyc
 
-- additional fields in `package.json` produces more trafic then users of your package really need;
+- additional fields in `package.json` produces more traffic then users of your package really need;
 - [c8](https://github.com/bcoe/c8) uses [same config name and format](https://github.com/bcoe/c8/blob/v7.3.5/lib/parse-args.js#L8) so transition between tools will be much easier;
 
 ### ❌ Incorrect code example
@@ -35,8 +34,8 @@ npm i @putout/plugin-package-json -D
 ```json
 {
     "nyc": {
-        "check-coverage": true,
-        "all": true,
+        "check-coverage": "on",
+        "all": "on",
         "exclude": [
             "**/*.spec.js",
             "**/fixture",
@@ -57,8 +56,8 @@ File `.nycrc.json`:
 
 ```json
 {
-    "check-coverage": true,
-    "all": true,
+    "check-coverage": "on",
+    "all": "on",
     "exclude": [
         "**/*.spec.js",
         "**/fixture",
@@ -72,7 +71,18 @@ File `.nycrc.json`:
 }
 ```
 
+## add-type
+
+Add [`type`](https://nodejs.org/dist/latest-v17.x/docs/api/packages.html#type) field to `package.json`:
+
+```diff
+{
+    "name": "hello",
+    "version": "1.0.0",
++   "type": "commonjs"
+}
+```
+
 ## License
 
 MIT
-

package/lib/add-type/index.js

@@ -0,0 +1,36 @@
+'use strict';
+
+const {
+    operator,
+    types,
+} = require('putout');
+
+const {
+    ObjectProperty,
+    StringLiteral,
+} = types;
+
+const {findProperties} = operator;
+
+module.exports.report = () => `Add 'type' of module to 'package.json'`;
+
+module.exports.traverse = ({push}) => ({
+    '__putout_processor_json(__a)': (path) => {
+        const __aPath = path.get('arguments.0');
+        const {versionPath, typePath} = findProperties(__aPath, ['version', 'type']);
+        
+        if (typePath)
+            return;
+        
+        if (!versionPath)
+            return;
+        
+        push(versionPath);
+    },
+});
+
+module.exports.fix = (path) => {
+    const node = ObjectProperty(StringLiteral('type'), StringLiteral('commonjs'));
+    path.insertAfter(node);
+};
+

package/lib/index.js

@@ -6,5 +6,6 @@ const getRule = (a) => ({
 
 module.exports.rules = {
     ...getRule('remove-nyc'),
+    ...getRule('add-type'),
 };
 

package/lib/remove-nyc/index.js

@@ -1,28 +1,22 @@
 'use strict';
 
-const getValue = (a) => a.value;
-const isNYC = (a) => a.value === 'nyc';
+const {findProperties} = require('putout').operator;
 
-module.exports.report = () => 'Remove nyc section of package.json, use file .nycrc.json intead';
+module.exports.report = () => `Remove 'nyc' section of 'package.json', use file '.nycrc.json' intead`;
 
-module.exports.match = () => ({
-    '__putout_processor_json(__a)': ({__a}) => {
-        return __a.properties
-            .map(getValue)
-            .filter(isNYC);
-    },
-});
+module.exports.fix = (path) => {
+    path.remove();
+};
 
-module.exports.replace = () => ({
-    '__putout_processor_json(__a)': ({}, path) => {
-        const properties = path.get('arguments.0.properties');
+module.exports.traverse = ({push}) => ({
+    '__putout_processor_json(__a)': (path) => {
+        const __aPath = path.get('arguments.0');
+        const {nycPath} = findProperties(__aPath, ['nyc']);
         
-        for (const propPath of properties) {
-            if (propPath.get('key.value').node === 'nyc')
-                propPath.remove();
-        }
+        if (!nycPath)
+            return;
         
-        return path;
+        push(nycPath);
     },
 });
 

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "@putout/plugin-package-json",
-  "version": "1.0.0",
+  "version": "2.0.0",
+  "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "putout plugin for package.json",
-  "homepage": "http://github.com/coderaiser/putout",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/plugin-package-json#readme",
   "main": "lib/index.js",
   "release": false,
   "tag": false,
@@ -16,8 +17,11 @@
     "test": "madrun test",
     "watch:test": "madrun watch:test",
     "lint": "madrun lint",
+    "fresh:lint": "madrun fresh:lint",
+    "lint:fresh": "madrun lint:fresh",
     "fix:lint": "madrun fix:lint",
-    "coverage": "madrun coverage"
+    "coverage": "madrun coverage",
+    "report": "madrun report"
   },
   "dependencies": {},
   "keywords": [
@@ -27,22 +31,21 @@
     "package-json"
   ],
   "devDependencies": {
-    "@putout/test": "^3.0.0",
-    "coveralls": "^3.0.0",
-    "package-json": "^7.6.0",
-    "package-json-plugin-node": "^11.0.0",
-    "package-json-plugin-putout": "^6.0.0",
-    "lerna": "^3.8.5",
+    "@putout/test": "^4.0.0",
+    "c8": "^7.5.0",
+    "eslint": "^8.0.1",
+    "eslint-plugin-node": "^11.0.0",
+    "eslint-plugin-putout": "^12.0.0",
+    "lerna": "^4.0.0",
     "madrun": "^8.0.1",
-    "nodemon": "^2.0.1",
-    "nyc": "^15.0.1"
+    "nodemon": "^2.0.1"
   },
   "peerDependencies": {
-    "putout": ">=11"
+    "putout": ">=23"
   },
   "license": "MIT",
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   },
   "publishConfig": {
     "access": "public"