eslint-plugin-package-json 0.3.2 → 0.5.0

package/src/tests/rules/order-properties.test.ts

@@ -1,223 +0,0 @@
-import rule from '../../rules/order-properties';
-import { ruleTester } from './ruleTester';
-
-ruleTester.run('order-properties', rule, {
-    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/src/tests/rules/ruleTester.ts

@@ -1,17 +0,0 @@
-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 const ruleTester = new RuleTester({
-    parser: require.resolve('jsonc-eslint-parser')
-}) as JsonRuleTester;

package/src/tests/rules/sort-collections.test.ts

@@ -1,62 +0,0 @@
-import rule from '../../rules/sort-collections';
-import { ruleTester } from './ruleTester.js';
-
-//------------------------------------------------------------------------------
-// Tests
-//------------------------------------------------------------------------------
-
-ruleTester.run('sort-collections', rule, {
-    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/src/tests/rules/valid-local-dependency.test.ts

@@ -1,244 +0,0 @@
-import path from 'path';
-
-import rule from '../../rules/valid-local-dependency';
-import { ruleTester } from './ruleTester.js';
-
-const fileName = (partialPath: string) => {
-    return path.join(process.cwd(), partialPath);
-};
-
-ruleTester.run('valid-local-dependency', rule, {
-    valid: [
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/valid-local-dependency",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json')
-        },
-        {
-            code: `{
-                    "peerDependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/valid-local-dependency",
-                        "some-other-package": "some-other-package"
-                    }
-                }`,
-            filename: fileName('package.json')
-        },
-        {
-            code: `{
-                    "devDependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/valid-local-dependency",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json')
-        },
-        {
-            code: `{
-                    "name": "pandages",
-                    "version": "1.0.0",
-                    "description": "",
-                    "main": "index.js",
-                    "keywords": [],
-                    "author": "me!",
-                    "license": "ISC"
-            }`,
-            filename: fileName('package.json')
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json')
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/Invalid-local-dependency",
-                    }
-            }`,
-            filename: fileName('not-package.json')
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "link:../valid-local-dependency"
-                    }
-            }`,
-            filename: fileName(
-                '/src/tests/__fixtures__/unalphabetized-collections/package.json'
-            )
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "file:./src/tests/__fixtures__/valid-local-dependency",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json')
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "file:./src/tests/__fixtures__/valid-local-dependency/gotcha/package.json/gotcha",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json')
-        }
-    ],
-    invalid: [
-        {
-            code: `{
-                        "license": "ISC",
-                        "dependencies": {
-                            "some-package": "link:./src/tests/__fixtures__/Invalid-local-dependency",
-                            "some-other-package": "some-other-package"
-                        }
-            }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: link:./src/tests/__fixtures__/Invalid-local-dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                    "peerDependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/Invalid-local-dependency",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: link:./src/tests/__fixtures__/Invalid-local-dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                    "devDependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/Invalid-local-dependency",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: link:./src/tests/__fixtures__/Invalid-local-dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/dependency",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: link:./src/tests/__fixtures__/dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                        "dependencies": {
-                        "some-package": "link:./src/tests/__fixtures__/Invalid-local-dependency",
-                        "some-other-package": "some-other-package"
-                        },
-                        "peerDependencies": {
-                            "peer-package": "link:./src/tests/__fixtures__/Invalid-local-dependency",
-                            "some-other-package": "some-other-package"
-                        }
-                    }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: link:./src/tests/__fixtures__/Invalid-local-dependency.'
-                },
-                {
-                    message:
-                        'The package peer-package does not exist given the specified path: link:./src/tests/__fixtures__/Invalid-local-dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                            "dependencies": {
-                                "some-package": "link:./src/tests/__fixtures__/Invalid-local-dependency",
-                                "another-path": "link:./src/tests/__fixtures__/valid-local-dependency",
-                                "some-other-package": "some-other-package"
-                            }
-            }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: link:./src/tests/__fixtures__/Invalid-local-dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "link:../Invalid-local-dependency"
-                    }
-            }`,
-            filename: fileName(
-                'src/tests/__fixtures__/unalphabetized-collections/package.json'
-            ),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: link:../Invalid-local-dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "file:./src/tests/__fixtures__/Invalid-local-dependency",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: file:./src/tests/__fixtures__/Invalid-local-dependency.'
-                }
-            ]
-        },
-        {
-            code: `{
-                    "dependencies": {
-                        "some-package": "file:./src/tests/__fixtures__/Invalid-local-dependency/gotcha/package.json/gotcha",
-                        "some-other-package": "some-other-package"
-                    }
-            }`,
-            filename: fileName('package.json'),
-            errors: [
-                {
-                    message:
-                        'The package some-package does not exist given the specified path: file:./src/tests/__fixtures__/Invalid-local-dependency/gotcha/package.json/gotcha.'
-                }
-            ]
-        }
-    ]
-});

package/src/tests/rules/valid-package-def.test.ts

@@ -1,65 +0,0 @@
-import rule from '../../rules/valid-package-def.js';
-import { ruleTester } from './ruleTester.js';
-
-ruleTester.run('valid-package-def', rule, {
-    valid: [
-        {
-            code: `{
-  "name": "pandages",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "keywords": [],
-  "author": "me!",
-  "license": "ISC"
-}`,
-            filename: 'package.json'
-        },
-        {
-            code: `{
-  "name": "pandages-subpackage",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "keywords": [],
-  "author": "me!",
-  "license": "ISC"
-}`,
-            filename: 'packages/nested/package.json'
-        },
-        {
-            code: `({ "whatever": "cuz its not a package file" })`,
-
-            filename: 'not-a-package.json'
-        }
-    ],
-
-    invalid: [
-        {
-            code: `{ "nmae": "invalid-package" }`,
-
-            filename: 'package.json',
-            errors: [
-                {
-                    message: 'Missing required field: name'
-                },
-                {
-                    message: 'Missing required field: version'
-                }
-            ]
-        },
-        {
-            code: `{ "verison": "wireless" }`,
-
-            filename: 'packages/nested/package.json',
-            errors: [
-                {
-                    message: 'Missing required field: name'
-                },
-                {
-                    message: 'Missing required field: version'
-                }
-            ]
-        }
-    ]
-});

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-    "compilerOptions": {
-        "declaration": true,
-        "declarationMap": true,
-        "esModuleInterop": true,
-        "module": "CommonJS",
-        "moduleResolution": "Node10",
-        "strict": true,
-        "target": "ES2021",
-        "outDir": "lib"
-    },
-    "include": ["src"]
-}

package/vitest.config.ts

@@ -1,15 +0,0 @@
-import { defineConfig } from 'vitest/config';
-
-export default defineConfig({
-    test: {
-        clearMocks: true,
-        coverage: {
-            all: true,
-            exclude: ['lib'],
-            include: ['src'],
-            reporter: ['html', 'lcov']
-        },
-        exclude: ['lib', 'node_modules'],
-        setupFiles: ['console-fail-test/setup', './src/tests/globalSetup.js']
-    }
-});