eslint-plugin-package-json 0.2.0 → 0.3.0

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

@@ -9,7 +9,7 @@
 //------------------------------------------------------------------------------
 const path = require('path');
 var rule = require('../../../lib/rules/valid-local-dependency'),
-    RuleTester = require('eslint').RuleTester;
+    { ruleTester } = require('./ruleTester');
 
 //------------------------------------------------------------------------------
 // Tests
@@ -19,11 +19,10 @@ const fileName = partialPath => {
     return path.join(process.cwd(), partialPath);
 };
 
-var ruleTester = new RuleTester();
 ruleTester.run('valid-local-dependency', rule, {
     valid: [
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -32,7 +31,7 @@ ruleTester.run('valid-local-dependency', rule, {
             filename: fileName('package.json')
         },
         {
-            code: `module.exports = {
+            code: `{
                     "peerDependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -41,7 +40,7 @@ ruleTester.run('valid-local-dependency', rule, {
             filename: fileName('package.json')
         },
         {
-            code: `module.exports = {
+            code: `{
                     "devDependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -50,7 +49,7 @@ ruleTester.run('valid-local-dependency', rule, {
             filename: fileName('package.json')
         },
         {
-            code: `module.exports = {
+            code: `{
                     "name": "pandages",
                     "version": "1.0.0",
                     "description": "",
@@ -62,7 +61,7 @@ ruleTester.run('valid-local-dependency', rule, {
             filename: fileName('package.json')
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-other-package": "some-other-package"
                     }
@@ -70,7 +69,7 @@ ruleTester.run('valid-local-dependency', rule, {
             filename: fileName('package.json')
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/Valid-local-dependency",
                     }
@@ -78,7 +77,7 @@ ruleTester.run('valid-local-dependency', rule, {
             filename: fileName('not-package.json')
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "link:../valid-local-dependency"
                     }
@@ -88,7 +87,7 @@ ruleTester.run('valid-local-dependency', rule, {
             )
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "file:./tests/lib/__fixtures__/valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -97,7 +96,7 @@ ruleTester.run('valid-local-dependency', rule, {
             filename: fileName('package.json')
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "file:./tests/lib/__fixtures__/valid-local-dependency/gotcha/package.json/gotcha",
                         "some-other-package": "some-other-package"
@@ -108,7 +107,7 @@ ruleTester.run('valid-local-dependency', rule, {
     ],
     invalid: [
         {
-            code: `module.exports = {
+            code: `{
                         "license": "ISC",
                         "dependencies": {
                             "some-package": "link:./tests/lib/__fixtures__/Valid-local-dependency",
@@ -124,7 +123,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                     "peerDependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/Valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -139,7 +138,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                     "devDependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/Valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -154,7 +153,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/dependency",
                         "some-other-package": "some-other-package"
@@ -169,7 +168,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                         "dependencies": {
                         "some-package": "link:./tests/lib/__fixtures__/Valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -192,7 +191,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                             "dependencies": {
                                 "some-package": "link:./tests/lib/__fixtures__/Valid-local-dependency",
                                 "another-path": "link:./tests/lib/__fixtures__/valid-local-dependency",
@@ -208,7 +207,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "link:../Valid-local-dependency"
                     }
@@ -224,7 +223,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "file:./tests/lib/__fixtures__/Valid-local-dependency",
                         "some-other-package": "some-other-package"
@@ -239,7 +238,7 @@ ruleTester.run('valid-local-dependency', rule, {
             ]
         },
         {
-            code: `module.exports = {
+            code: `{
                     "dependencies": {
                         "some-package": "file:./tests/lib/__fixtures__/Valid-local-dependency/gotcha/package.json/gotcha",
                         "some-other-package": "some-other-package"

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

@@ -5,17 +5,16 @@
 //------------------------------------------------------------------------------
 
 var rule = require('../../../lib/rules/valid-package-def'),
-    RuleTester = require('eslint').RuleTester;
+    { ruleTester } = require('./ruleTester');
 
 //------------------------------------------------------------------------------
 // Tests
 //------------------------------------------------------------------------------
 
-var ruleTester = new RuleTester();
 ruleTester.run('valid-package-def', rule, {
     valid: [
         {
-            code: `module.exports = {
+            code: `{
   "name": "pandages",
   "version": "1.0.0",
   "description": "",
@@ -27,7 +26,7 @@ ruleTester.run('valid-package-def', rule, {
             filename: 'package.json'
         },
         {
-            code: `module.export = {
+            code: `{
   "name": "pandages-subpackage",
   "version": "1.0.0",
   "description": "",
@@ -47,7 +46,7 @@ ruleTester.run('valid-package-def', rule, {
 
     invalid: [
         {
-            code: `module.exports = { "nmae": "invalid-package" }`,
+            code: `{ "nmae": "invalid-package" }`,
 
             filename: 'package.json',
             errors: [
@@ -60,7 +59,7 @@ ruleTester.run('valid-package-def', rule, {
             ]
         },
         {
-            code: `module.exports = { "verison": "wireless" }`,
+            code: `{ "verison": "wireless" }`,
 
             filename: 'packages/nested/package.json',
             errors: [

package/lib/processors/PackageJsonProcessor.js

@@ -1,63 +0,0 @@
-const parseErrors = {};
-
-const isPackageJson = filePath => /(?:^|[/\\])package.json$/.test(filePath);
-
-const forPackageJsonOnly = fn => (source, filePath) =>
-    isPackageJson(filePath) ? fn(source, filePath) : [];
-
-const leader = `module.exports = `;
-
-// turn package.json into a legal JS file
-function preprocess(source, filePath) {
-    try {
-        JSON.parse(source);
-    } catch (e) {
-        let line = 0;
-        let column = 0;
-        const posDescription = e.message.match(/position\s+(\d+)/);
-        if (posDescription) {
-            const pos = Number(posDescription[1]);
-            const lines = source.slice(0, pos).split('\n');
-            line += lines.length;
-            const previousLinesLength = lines.slice(0, -1).join('\n').length;
-            column = pos - previousLinesLength;
-        }
-        parseErrors[filePath] = {
-            ruleId: 'package-json/valid-package-def',
-            severity: 2,
-            message: e.message,
-            line,
-            column,
-            nodeType: 'Program'
-        };
-
-        // so eslint can point to the line in its own message, put the invalid
-        // JSON in a comment (escaping comment-closing characters!)
-        return ['/*' + source.replace(/\*\//g, '*\\/') + '*/'];
-    }
-    return [leader + source.trim() + ';'];
-}
-
-// the reverse of preprocess: extract AST node representing package object
-function extractPackageObjectFromAST(ast) {
-    return ast.body[0].expression.right;
-}
-
-function postprocess(errors, filePath) {
-    if (parseErrors[filePath]) {
-        return [parseErrors[filePath]];
-    }
-    const flat = [].concat(...errors);
-    flat.forEach(({ fix }) => {
-        if (fix) {
-            fix.range = fix.range.map(i => i - leader.length);
-        }
-    });
-    return flat;
-}
-
-module.exports.preprocess = forPackageJsonOnly(preprocess);
-module.exports.postprocess = forPackageJsonOnly(postprocess);
-module.exports.supportsAutofix = true;
-module.exports.isPackageJson = isPackageJson;
-module.exports.extractPackageObjectFromAST = extractPackageObjectFromAST;

package/tests/lib/index.js

@@ -1,157 +0,0 @@
-const assert = require('assert');
-const { CLIEngine } = require('eslint');
-const { includes, keys } = require('lodash');
-const path = require('path');
-
-const plugin = require('../../lib');
-
-function execute(scenario, rules, options) {
-    const cli = new CLIEngine(
-        Object.assign(
-            {
-                extensions: ['.json'],
-                baseConfig: {
-                    rules
-                },
-                ignore: false,
-                useEslintrc: false
-            },
-            options
-        )
-    );
-    cli.addPlugin('eslint-plugin-package-json', plugin);
-    return cli.executeOnFiles([
-        path.join(__dirname, '__fixtures__', scenario, 'package.json')
-    ]);
-}
-
-describe('plugin exports', () => {
-    it('should define json processor', () => {
-        const extensions = keys(plugin.processors);
-        assert(includes(extensions, '.json'));
-    });
-
-    describe('should define rules', () => {
-        it('catches unalphabetized collections', () => {
-            const { errorCount, fixableErrorCount, results } = execute(
-                'unalphabetized-collections',
-                {
-                    'package-json/sort-collections': 'error'
-                }
-            );
-            assert.equal(errorCount, 2, 'errorCount === 2');
-            assert.equal(fixableErrorCount, 2, 'fixableErrorCount === 2');
-            assert.equal(results.length, 1);
-            const { messages } = results[0];
-            const [scriptsMessage, depsMessage] = messages;
-            assert.equal(
-                scriptsMessage.ruleId,
-                'package-json/sort-collections'
-            );
-            assert.equal(
-                scriptsMessage.message,
-                'Package scripts are not alphabetized'
-            );
-            assert(scriptsMessage.fix);
-            assert.equal(depsMessage.ruleId, 'package-json/sort-collections');
-            assert.equal(
-                depsMessage.message,
-                'Package dependencies are not alphabetized'
-            );
-            assert(depsMessage.fix);
-        });
-        it('autofixes unalphabetized collections', () => {
-            const { errorCount, fixableErrorCount, results } = execute(
-                'unalphabetized-collections',
-                {
-                    'package-json/sort-collections': 'error'
-                },
-                { fix: true }
-            );
-            assert.equal(errorCount, 0, 'errorCount === 0');
-            assert.equal(fixableErrorCount, 0, 'fixableErrorCount === 0');
-            let fixed;
-            assert.doesNotThrow(() => {
-                fixed = JSON.parse(results[0].output);
-            });
-            const scriptsOrder = Object.keys(fixed.scripts);
-            const scriptsDesiredOrder = scriptsOrder.slice().sort();
-            assert.deepEqual(scriptsOrder, scriptsDesiredOrder);
-            const depsOrder = Object.keys(fixed.dependencies);
-            const depsDesiredOrder = depsOrder.slice().sort();
-            assert.deepEqual(depsOrder, depsDesiredOrder);
-        });
-        it('sorts top-level properties by convention', () => {
-            const { errorCount, fixableErrorCount, results } = execute(
-                'invalid-top-level-property-order',
-                {
-                    'package-json/order-properties': 'error'
-                }
-            );
-            assert.equal(errorCount, 1, 'errorCount === 1');
-            assert.equal(fixableErrorCount, 1, 'fixableErrorCount === 1');
-            assert.equal(results.length, 1);
-            const { ruleId, message, fix } = results[0].messages[0];
-            assert.equal(ruleId, 'package-json/order-properties');
-            assert(
-                new RegExp(`Package top\\-level properties are not ordered in the NPM standard way:
-
- \\{
-   "name": "invalid\\-top\\-level\\-property\\-order",
-.*\\+  "scripts": \\{.*
-.*\\+    "test": "tape".*
-.*\\+  \\},.*
-   "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"
-   \\}
-`).test(message),
-                'Matches error message: ' + message
-            );
-            assert(fix);
-        });
-        it('autofixes out-of-order top-level properties', () => {
-            const { errorCount, fixableErrorCount, results } = execute(
-                'invalid-top-level-property-order',
-                {
-                    'package-json/order-properties': 'error'
-                },
-                {
-                    fix: true
-                }
-            );
-            assert.equal(errorCount, 0, 'errorCount === 0');
-            assert.equal(fixableErrorCount, 0, 'fixableErrorCount === 0');
-            let fixedString = results[0].output;
-            assert.doesNotThrow(() => {
-                JSON.parse(fixedString);
-            });
-            assert.equal(
-                fixedString,
-                JSON.stringify(
-                    {
-                        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'
-                        }
-                    },
-                    null,
-                    2
-                ) + '\n'
-            );
-        });
-    });
-});

package/tests/lib/processors/PackageJsonProcessor.js

@@ -1,159 +0,0 @@
-const assert = require('assert');
-
-const processor = require('../../../lib/processors/PackageJsonProcessor');
-
-const { preprocess, postprocess } = processor;
-
-describe('isPackageJson', () => {
-    for (const [input, expected] of [
-        ['', false],
-        ['-', false],
-        ['other', false],
-        ['package.js', false],
-        ['package.jsx', false],
-        ['-package.json', false],
-        ['prefix-package.json', false],
-        ['package.json.json', false],
-        ['package.package.json', false],
-        ['package.json.package.json', false],
-        ['package.json-package.json', false],
-        ['package.json', true],
-        ['/package.json', true],
-        ['\\package.json', true],
-        ['prefix/package.json', true],
-        ['prefix\\package.json', true],
-        ['mixed\\prefix/package.json', true],
-        ['mixed/prefix\\package.json', true]
-    ]) {
-        it(input, () => {
-            assert.equal(processor.isPackageJson(input), expected);
-        });
-    }
-});
-
-describe('preprocess', () => {
-    it('only returns lintable strings when filename is package.json', () => {
-        const result = preprocess('{ "nmae": "invalid" }', 'package-lock.json');
-        assert.deepEqual(result, []);
-    });
-
-    it('should turn root package.json file into JS file exporting object', () => {
-        const json = '{ "nmae": "invalid" }';
-        const expected = ['module.exports = { "nmae": "invalid" };'];
-        const result = preprocess(json, 'package.json');
-        assert.deepEqual(result, expected);
-    });
-
-    it('should turn deeply nested package.json file into JS file exporting object', () => {
-        const json = '{ "nmae": "invalid" }';
-        const expected = ['module.exports = { "nmae": "invalid" };'];
-        const result = preprocess(json, '/packages/subpackage/package.json');
-        assert.deepEqual(result, expected);
-    });
-});
-
-describe('postprocess', () => {
-    it('should return informative validity errors on unparseable json', () => {
-        const badJson = `{
-        "florp": [],
-        "glorp": [
-            "foon",
-            "zune",
-            {
-                "rune"
-
-          ],
-        "spoon": 4
-    }`;
-        const commented = preprocess(badJson, 'package.json')[0];
-        assert(
-            commented.startsWith('/*') && commented.endsWith('*/'),
-            `unparseable JSON wrapped in multiline comment: ${commented}`
-        );
-        assert.deepEqual(postprocess([], 'package.json'), [
-            {
-                ruleId: 'package-json/valid-package-def',
-                severity: 2,
-                message: 'Unexpected token ] in JSON at position 130',
-                line: 9,
-                column: 11,
-                nodeType: 'Program'
-            }
-        ]);
-
-        preprocess('{', 'nested/package.json');
-        assert.deepEqual(postprocess([], 'nested/package.json'), [
-            {
-                ruleId: 'package-json/valid-package-def',
-                severity: 2,
-                message: 'Unexpected end of JSON input',
-                line: 0,
-                column: 0,
-                nodeType: 'Program'
-            }
-        ]);
-    });
-
-    it('should pass flattened error collection if there were no parse errors', () => {
-        const errors2d = [
-            [
-                {
-                    ruleId: 'package-json/order-properties',
-                    severity: 2,
-                    message: 'Whatever',
-                    line: 0,
-                    column: 0,
-                    nodeType: 'Property'
-                },
-                {
-                    ruleId: 'package-json/order-properties',
-                    severity: 2,
-                    message: 'And Ever',
-                    line: 16,
-                    column: 0,
-                    nodeType: 'Property'
-                }
-            ],
-            [
-                {
-                    ruleId: 'package-json/sort-collections',
-                    severity: 2,
-                    message: 'whomever',
-                    line: 15,
-                    column: 4,
-                    nodeType: 'Program'
-                }
-            ]
-        ];
-        const errors1d = [
-            {
-                ruleId: 'package-json/order-properties',
-                severity: 2,
-                message: 'Whatever',
-                line: 0,
-                column: 0,
-                nodeType: 'Property'
-            },
-            {
-                ruleId: 'package-json/order-properties',
-                severity: 2,
-                message: 'And Ever',
-                line: 16,
-                column: 0,
-                nodeType: 'Property'
-            },
-            {
-                ruleId: 'package-json/sort-collections',
-                severity: 2,
-                message: 'whomever',
-                line: 15,
-                column: 4,
-                nodeType: 'Program'
-            }
-        ];
-        assert.deepEqual(
-            postprocess(errors2d, 'further/nested/package.json'),
-            errors1d
-        );
-    });
-});