Support for entires order? about npm-package-json-lint

[tclindner]

Hey @moshest that isn't currently an option, but I think it is a great idea. I'll mark this issue as an enhancement and work on it as soon as I can!

[tclindner]

Hey @moshest thank you for the suggestion. v2.8.0 has been released with a new rule named prefer-property-order. Here is a link to the documentation. Let me know what you think.

[moshest]

Great!

I think that providing a default order for this role can help many users:

[
    'name',
    'version',
    'description',
    'keywords',
    'homepage',
    'bugs',
    'license',
    'author',
    'contributors',
    'files',
    'main',
    'module',
    'jsnext:main',
    'types',
    'typings',
    'style',
    'example',
    'examplestyle',
    'assets',
    'bin',
    'man',
    'directories',
    'repository',
    'scripts',
    'config',
    'pre-commit',
    'browser',
    'browserify',
    'babel',
    'eslintConfig',
    'stylelint',
    'dependencies',
    'devDependencies',
    'peerDependencies',
    'bundledDependencies',
    'bundleDependencies',
    'optionalDependencies',
    'engines',
    'engineStrict',
    'os',
    'cpu',
    'preferGlobal',
    'private',
    'publishConfig',
]

(Copied from sort-package-json module)

We also need to check that entries that missing from the package.json file but exists on the order list would not reject as an error.

For example:

{
  "rules": {
    "prefer-property-order": ["error", [
      "name",
      "version",
      "description"
    ]]
  }
}

Valid package.json:

{
  "name": "npm-package-json-lint",
  "version": "1.0.0"
}

Invalid package.json:

{
  "version": "1.0.0",
  "name": "npm-package-json-lint"
}

[tclindner]

Hi @moshest I've made these adjustments in v2.8.1. I updated the documentation too. Let me know what you think.

[moshest]

Great! 🎉