eslint-plugin-package-json 0.3.0 → 0.3.2

package/lib/rules/valid-local-dependency.js

@@ -1,75 +1,56 @@
-/**
- * @fileoverview Checks existence of local dependencies in the package.json
- * @author Kendall Gassner
- */
-'use strict';
-const path = require('path');
-const { createRule } = require('../createRule');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
+const createRule_js_1 = require("../createRule.js");
 //------------------------------------------------------------------------------
 // Rule Definition
 //------------------------------------------------------------------------------
-
-module.exports = createRule({
+exports.default = (0, createRule_js_1.createRule)({
     meta: {
         docs: {
-            description:
-                'Checks existence of local dependencies in the package.json',
+            description: 'Checks existence of local dependencies in the package.json',
             category: 'Best Practices',
             recommended: true
         }
     },
-
-    create: function(context) {
+    create: function (context) {
         return {
             'Program:exit'() {
                 const original = JSON.parse(context.sourceCode.text);
-                const {
-                    dependencies,
-                    peerDependencies,
-                    devDependencies
-                } = original;
-
+                const { dependencies, peerDependencies, devDependencies } = original;
                 const depObjs = [
                     Object.entries(dependencies || {}),
                     Object.entries(peerDependencies || {}),
                     Object.entries(devDependencies || {})
                 ];
-
-                depObjs.forEach(obj =>
-                    obj.forEach(([key, value]) => {
-                        const response = localPath => {
-                            const filePath = path.join(
-                                context
-                                    .getFilename()
-                                    .replace(/package\.json/g, '/'),
-                                value.replace(new RegExp(localPath, 'g'), ''),
-                                '/package.json'
-                            );
-
-                            try {
-                                if (!require.resolve(filePath)) {
-                                    context.report({
-                                        node: context.sourceCode.ast,
-                                        message: `The package ${key} does not exist given the specified path: ${value}.`
-                                    });
-                                }
-                            } catch (e) {
+                depObjs.forEach(obj => obj.forEach(([key, value]) => {
+                    const response = (localPath) => {
+                        const filePath = path_1.default.join(context.filename.replace(/package\.json/g, '/'), value.replace(new RegExp(localPath, 'g'), ''), '/package.json');
+                        try {
+                            if (!require.resolve(filePath)) {
                                 context.report({
                                     node: context.sourceCode.ast,
                                     message: `The package ${key} does not exist given the specified path: ${value}.`
                                 });
                             }
-                        };
-
-                        if (value.startsWith('link:')) {
-                            response('link:');
                         }
-                        if (value.startsWith('file:')) {
-                            response('file:');
+                        catch (e) {
+                            context.report({
+                                node: context.sourceCode.ast,
+                                message: `The package ${key} does not exist given the specified path: ${value}.`
+                            });
                         }
-                    })
-                );
+                    };
+                    if (value.startsWith('link:')) {
+                        response('link:');
+                    }
+                    if (value.startsWith('file:')) {
+                        response('file:');
+                    }
+                }));
             }
         };
     }

package/lib/rules/valid-package-def.d.ts

@@ -0,0 +1,6 @@
+declare const _default: {
+    create(context: import("../createRule.js").PackageJsonRuleContext): import("jsonc-eslint-parser").RuleListener;
+    meta: import("eslint").Rule.RuleMetaData;
+};
+export default _default;
+//# sourceMappingURL=valid-package-def.d.ts.map

package/lib/rules/valid-package-def.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-package-def.d.ts","sourceRoot":"","sources":["../../src/rules/valid-package-def.ts"],"names":[],"mappings":";;;;AAgBA,wBA4BG"}

package/lib/rules/valid-package-def.js

@@ -1,11 +1,7 @@
 'use strict';
-const { PJV: PackageValidator } = require('package-json-validator');
-const { createRule } = require('../createRule');
-
-//------------------------------------------------------------------------------
-// Rule Definition
-//------------------------------------------------------------------------------
-
+Object.defineProperty(exports, "__esModule", { value: true });
+const package_json_validator_1 = require("package-json-validator");
+const createRule_js_1 = require("../createRule.js");
 // package-json-validator does not correctly recognize shorthand for repositories and alternate dependency statements, so we discard those values.
 // it also enforces a stricter code for NPM than is really appropriate,
 // so we disable some other errors here.
@@ -14,35 +10,24 @@ const unusedErrorPatterns = [
     /^Invalid version range for .+?: file:/i,
     /^author field should have name/i
 ];
-
-const isUsableError = errorText =>
-    unusedErrorPatterns.every(pattern => !pattern.test(errorText));
-
-module.exports = createRule({
+const isUsableError = (errorText) => unusedErrorPatterns.every(pattern => !pattern.test(errorText));
+exports.default = (0, createRule_js_1.createRule)({
     meta: {
         docs: {
-            description:
-                'Enforce that package.json has all properties required by NPM spec',
+            description: 'Enforce that package.json has all properties required by NPM spec',
             category: 'Best Practices',
             recommended: true
         }
     },
-
-    create: function(context) {
+    create: function (context) {
         return {
             'Program:exit'() {
-                const { errors } = PackageValidator.validate(
-                    context.sourceCode.text
-                );
-
-                (errors || []).filter(isUsableError).forEach(
-                    message =>
-                        message &&
-                        context.report({
-                            node: context.sourceCode.ast,
-                            message
-                        })
-                );
+                const validation = package_json_validator_1.PJV.validate(context.sourceCode.text);
+                validation.errors?.filter(isUsableError).forEach(message => message &&
+                    context.report({
+                        node: context.sourceCode.ast,
+                        message
+                    }));
             }
         };
     }

package/lib/tests/rules/order-properties.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=order-properties.test.d.ts.map

package/lib/tests/rules/order-properties.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"order-properties.test.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/order-properties.test.ts"],"names":[],"mappings":""}

package/lib/tests/rules/order-properties.test.js

@@ -0,0 +1,223 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const order_properties_1 = __importDefault(require("../../rules/order-properties"));
+const ruleTester_1 = require("./ruleTester");
+ruleTester_1.ruleTester.run('order-properties', order_properties_1.default, {
+    invalid: [
+        {
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            output: `{
+  "name": "invalid-top-level-property-order",
+  "version": "1.0.0",
+  "description": "npm made me this way",
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  }
+}
+`
+        },
+        {
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            options: [{ order: 'legacy' }],
+            output: `{
+  "name": "invalid-top-level-property-order",
+  "version": "1.0.0",
+  "description": "npm made me this way",
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  }
+}
+`
+        },
+        {
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            options: [{ order: 'sort-package-json' }],
+            output: `{
+  "name": "invalid-top-level-property-order",
+  "version": "1.0.0",
+  "description": "npm made me this way",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  },
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  }
+}
+`
+        },
+        {
+            code: `{
+    "name": "invalid-top-level-property-order",
+    "scripts": {
+        "test": "tape"
+    },
+    "version": "1.0.0",
+    "description": "npm made me this way",
+    "main": "index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/fake/github.git"
+        }
+    }
+`,
+            errors: [
+                {
+                    message: 'Package top-level properties are not ordered in the npm standard way. Run the ESLint auto-fixer to correct.'
+                }
+            ],
+            filename: 'package.json',
+            options: [{ order: ['version', 'name', 'repository'] }],
+            output: `{
+  "version": "1.0.0",
+  "name": "invalid-top-level-property-order",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fake/github.git"
+  },
+  "description": "npm made me this way",
+  "main": "index.js",
+  "scripts": {
+    "test": "tape"
+  }
+}
+`
+        }
+    ],
+    valid: [
+        `{
+      "name": "treat-yo-self",
+      "version": "1.1.1",
+      "description": "Once a year.",
+      "keywords": [
+        "modern",
+        "master"
+      ]
+    }`,
+        `{
+      "name": "treat-yo-self",
+      "version": "0.1.0",
+      "private": true,
+      "description": "Once a year.",
+      "keywords": [
+        "modern",
+        "master"
+      ]
+    }
+    `,
+        {
+            code: `{
+      "version": "1.1.1",
+      "name": "treat-yo-self",
+      "description": "Once a year.",
+      "keywords": [
+        "modern",
+        "master"
+      ]
+    }
+    `,
+            options: [{ order: ['version', 'name'] }]
+        },
+        {
+            code: `{
+    "name": "treat-yo-self",
+    "version": "1.1.1",
+    "description": "Once a year.",
+    "keywords": [
+      "modern",
+      "master"
+    ],
+    "exports": {
+      "import": "./index.js",
+      "require": "./index.js"
+    },
+    "main": "index.js"
+    }`,
+            options: [{ order: 'sort-package-json' }]
+        },
+        {
+            code: `{
+    "name": "treat-yo-self",
+    "version": "1.1.1",
+    "description": "Once a year.",
+    "main": "index.js",
+    "exports": {
+    "import": "./index.js",
+    "require": "./index.js"
+    }
+    }`,
+            options: [{ order: 'legacy' }]
+        }
+    ]
+});

package/lib/tests/rules/ruleTester.d.ts

@@ -0,0 +1,10 @@
+import { RuleTester } from 'eslint';
+import { PackageJsonRuleModule } from '../../createRule';
+export type JsonRuleTester = RuleTester & {
+    run: (name: string, rule: PackageJsonRuleModule, tests: {
+        valid?: Array<string | RuleTester.ValidTestCase> | undefined;
+        invalid?: RuleTester.InvalidTestCase[] | undefined;
+    }) => void;
+};
+export declare const ruleTester: JsonRuleTester;
+//# sourceMappingURL=ruleTester.d.ts.map

package/lib/tests/rules/ruleTester.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ruleTester.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/ruleTester.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,MAAM,MAAM,cAAc,GAAG,UAAU,GAAG;IACtC,GAAG,EAAE,CACD,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,qBAAqB,EAC3B,KAAK,EAAE;QACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,UAAU,CAAC,aAAa,CAAC,GAAG,SAAS,CAAC;QAC7D,OAAO,CAAC,EAAE,UAAU,CAAC,eAAe,EAAE,GAAG,SAAS,CAAC;KACtD,KACA,IAAI,CAAC;CACb,CAAC;AAEF,eAAO,MAAM,UAAU,gBAEH,CAAC"}

package/lib/tests/rules/ruleTester.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ruleTester = void 0;
+const eslint_1 = require("eslint");
+exports.ruleTester = new eslint_1.RuleTester({
+    parser: require.resolve('jsonc-eslint-parser')
+});

package/lib/tests/rules/sort-collections.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=sort-collections.test.d.ts.map

package/lib/tests/rules/sort-collections.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sort-collections.test.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/sort-collections.test.ts"],"names":[],"mappings":""}

package/lib/tests/rules/sort-collections.test.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const sort_collections_1 = __importDefault(require("../../rules/sort-collections"));
+const ruleTester_js_1 = require("./ruleTester.js");
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+ruleTester_js_1.ruleTester.run('sort-collections', sort_collections_1.default, {
+    valid: [
+        {
+            code: `{
+  "scripts": {
+    "build": "webpack",
+    "watch": "webpack-dev-server"
+  }
+}`,
+            filename: 'package.json'
+        },
+        // ignore if custom include rule
+        {
+            code: `{
+  "scripts": {
+    "build": "webpack",
+    "watch": "webpack-dev-server"
+  }
+}`,
+            filename: 'package.json',
+            options: [['devDependencies']]
+        },
+        {
+            code: `{
+        "scripts": { "watch": "out of order...", "build": "but okay" }
+}`,
+            filename: 'not-a-package.json',
+            options: [['devDependencies']]
+        }
+    ],
+    invalid: [
+        {
+            code: `{
+  "scripts": {
+    "watch": "webpack-dev-server",
+    "build": "webpack"
+  }
+}`,
+            filename: 'package.json',
+            errors: [
+                {
+                    message: 'Package scripts are not alphabetized',
+                    type: 'JSONProperty'
+                }
+            ],
+            output: `{
+  "scripts": {
+    "build": "webpack",
+    "watch": "webpack-dev-server"
+  }
+}`
+        }
+    ]
+});

package/lib/tests/rules/valid-local-dependency.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=valid-local-dependency.test.d.ts.map

package/lib/tests/rules/valid-local-dependency.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"valid-local-dependency.test.d.ts","sourceRoot":"","sources":["../../../src/tests/rules/valid-local-dependency.test.ts"],"names":[],"mappings":""}