Comments (5)
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!
from npm-package-json-lint.
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.
from npm-package-json-lint.
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"
}
from npm-package-json-lint.
Hi @moshest I've made these adjustments in v2.8.1. I updated the documentation too. Let me know what you think.
from npm-package-json-lint.
Great! 🎉
from npm-package-json-lint.
Related Issues (20)
- feat: Check order of sub-properties
- Website not updated HOT 1
- Rule for allowing star w/ absolute version
- Update the command to run the CLI in the README file
- Unexpected behavior with the `--noConfigFiles` flag HOT 1
- [feat] no-absolute-version-peenDependencies
- Peer dep conflicts between npm-package-json-lint and the config-default package after latest update HOT 1
- overrides doesn't work with --configFile option HOT 1
- Types missing after upgrading from v5 to v6 HOT 3
- #595 release v6.0.2, please ! HOT 5
- [Enhancement Request] Improve messaging for `no-restricted-dependencies` HOT 1
- feat: add rule to disallow different versions of the same dependency in a mono-repo HOT 5
- feat: add scope for dependency rules HOT 1
- Website https://npmpackagejsonlint.org/ is down HOT 4
- feature request: "valid-values-scripts" rule HOT 1
- Rules link is broken HOT 1
- Feature request: `no-main` Rule
- Feature request: add whitelist for dependency rules
- Validating package.json againt its schema
- Export configuration type
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from npm-package-json-lint.