A package.json linter for Node projects
npm-package-json-lint helps enforce standards for your package.json file. This helps to ensure that your files are of the highest standard and quality. It is also customisable to match your specific project guidline requirements/desires. It has support for both command line and programmatic usage. Currently it can check for:
name
should always be a string.Please see the website for a list of rules.
First thing first, let's make sure you have the necessary pre-requisites.
npm install npm-package-json-lint -g
npm install npm-package-json-lint
npx npm-package-json-lint
. This will go through the process of linting/validating
your code to meet your desired specifications.The linter can also be used as a module in the program and the output be displayed via a log message. Adding the following code to your file can accomplish this.
const npmPackageJsonLint = require("npm-package-json-lint");
const result = npmPackageJsonLint.lintFiles(["package.json"]);
console.log(result);
npm-package-json-lint has the ability to be constomly configured to match your desires. To configure the linter navigate to the .npmpackagejsonlintrc file in the repository and add in or remove your desired rules.
Follow these steps to get your local environement set up to allow you to contribute to the repository
git clone https://github.com/tclindner/npm-package-json-lint.git
Quick links
CLI commands and configuration | Node.js API | Integrations
Please see the migration guide.
Please see the migration guide.
Please see the migration guide.
Please see the migration guide.
Please see the migration guide.
Please see the migration guide.
Please see the migration guide.
Please see CONTRIBUTING.md.
Please see CHANGELOG.md.
Copyright (c) 2016-2023 Thomas Lindner. Licensed under the MIT license.