Rename package

Author: tclindner

CONTRIBUTING.md

@@ -31,14 +31,14 @@ Run `node src/cli.js`
 
 ### JS
 
-package json lint utilizes both JSHint and JSCS to enforce JavaScript standards. Please see the `.jshintrc` file for JSHint config and `.jscsrc` for JSCS config.
+npm package json lint utilizes both JSHint and JSCS to enforce JavaScript standards. Please see the `.jshintrc` file for JSHint config and `.jscsrc` for JSCS config.
 
 * [grunt-contrib-jshint](https://github.com/gruntjs/grunt-contrib-jshint)
 * [grunt-jscs](https://github.com/jscs-dev/grunt-jscs)
 
 #### JSON
 
-package json lint utilizes JSON Lint to ensure JSON files are valid.
+npm package json lint utilizes JSON Lint to ensure JSON files are valid.
 
 * [grunt-jsonlint](https://github.com/brandonramirez/grunt-jsonlint)
 

README.md

@@ -1,10 +1,10 @@
-# package json lint
+# npm package json lint
 
 A package.json linter for Node projects
 
 ## What is package json lint?
 
-package json lint helps enforce standards for your package.json file.
+npm package json lint helps enforce standards for your package.json file.
 Currently it can check for:
 
 * validity of data types in nodes. Ex: `name` should always be a string.
@@ -36,7 +36,7 @@ First thing first, let's make sure you have the necessary pre-requisites.
 | pjl-cli --version | -v | Lists the current version number |
 | pjl-cli --file <file path> | --f | File path including name. Defaults to package.json |
 | pjl-cli --rule <rule name> | --r | Valid rule name to check. Defaults to nothing |
-| pjl-cli --rules-file <file path> | --c | File path of .packagejsonlintrc |
+| pjl-cli --rules-file <file path> | --c | File path of .npmpackagejsonlintrc |
 | pjl-cli --ignore-warnings | --w | Ignore warnings |
 
 ### Examples
@@ -47,23 +47,23 @@ Run a specific rule, author-valid-values, on a file relative to the current work
 Run a specific rule, author-valid-values, ignoring warnings on a file relative to the current working directory.
 `pjl-cli -f "../relative-path/package.json" -r "author-valid-values: true" --ignore-warnings`
 
-Run using the config in `.packagejsonlintrc` on a file relative to the current working directory.
-`pjl-cli -f "../relative-path/package.json" -c "./.packagejsonlintrc"`
+Run using the config in `.npmpackagejsonlintrc` on a file relative to the current working directory.
+`pjl-cli -f "../relative-path/package.json" -c "./.npmpackagejsonlintrc"`
 
 Run using the default config on a file relative to the current working directory
 `pjl-cli -f "../relative-path/package.json"`
 
 ## Lint Rules
 
-package json lint has a configurable set of rules. Each rule contains the following properties:
+npm package json lint has a configurable set of rules. Each rule contains the following properties:
 
   1. ID - example: author-required
   2. Type - error or warning
   3. Node - example: author
   4. Message - example: author is required
   5. Rule Type - example: required
 
-As mentioned in the "Commands and configuration" section there are two ways to specify rule sets. The first is using `--rule` to specify a given rule. This will run package json lint with just this rule. The second is using `--rules-file` to specify a JSON file, named `.packagejsonlintrc`, to run a set of rules. If neither of the options above are specified then package json lint looks for a global `.packagejsonlintrc` file in the root of your user directory. Finally, if a global `.packagejsonlintrc` file doesn't exist then all rules are enabled by [default](src/defaultConfig.js).
+As mentioned in the "Commands and configuration" section there are two ways to specify rule sets. The first is using `--rule` to specify a given rule. This will run package json lint with just this rule. The second is using `--rules-file` to specify a JSON file, named `.npmpackagejsonlintrc`, to run a set of rules. If neither of the options above are specified then package json lint looks for a global `.npmpackagejsonlintrc` file in the root of your user directory. Finally, if a global `.npmpackagejsonlintrc` file doesn't exist then all rules are enabled by [default](src/defaultConfig.js).
 
 ## Contributing
 

grunt/jsonlint.js

@@ -9,7 +9,7 @@ module.exports = function(grunt) {
         "*.json",
         ".jscsrc",
         ".jshintrc",
-        ".packagejsonlintrc"
+        ".npmpackagejsonlintrc"
       ]
     }
   });

package.json

@@ -21,7 +21,7 @@
   "bin": {
     "pjl-cli": "src/cli.js"
   },
-  "main": "src/PackageJsonLint.js",
+  "main": "src/NpmPackageJsonLint.js",
   "dependencies": {
     "chalk": "^1.1.1",
     "commander": "^2.9.0",

src/PackageJsonLint.js renamed to src/NpmPackageJsonLint.js

@@ -5,7 +5,7 @@ let Config = require("./Config");
 let isPlainObj = require("is-plain-obj");
 let Rules = require("./Rules");
 
-class PackageJsonLint {
+class NpmPackageJsonLint {
   /**
    * constructor
    * @param  {object}           packageJsonData   Valid package.json data
@@ -96,4 +96,4 @@ class PackageJsonLint {
   }
 }
 
-module.exports = PackageJsonLint;
+module.exports = NpmPackageJsonLint;

src/Parser.js

@@ -9,7 +9,7 @@ class Parser {
    * @return {object}          Valid JavaScript object
    */
   parse(fileName) {
-    // Make sure that a .packagejsonlint.rc is present
+    // Make sure that a .npmpackagejsonlintrc is present
     try {
       return this._readFile(fileName);
     } catch (e) {

src/cli.js

@@ -8,12 +8,12 @@ let fs = require("fs");
 let Parser = require("./Parser");
 let path = require("path");
 let pkg = require("./../package.json");
-let PackageJsonLint = require("./PackageJsonLint");
+let NpmPackageJsonLint = require("./NpmPackageJsonLint");
 let Reporter = require("./Reporter");
 let userHome = require("user-home");
 
 const DEFAULT_FILE_NAME = "./package.json";
-const PACKAGE_JSON_RC_FILE_NAME = ".packagejsonlintrc";
+const NPM_PACKAGE_JSON_RC_FILE_NAME = ".npmpackagejsonlintrc";
 
 function handleError(err) {
   console.log(chalk.red.bold(err));
@@ -25,7 +25,7 @@ cliApp.version(pkg.version);
 cliApp.usage(pkg.name);
 cliApp.option("-f, --file <filePath>", `File path including name. Defaults to ${DEFAULT_FILE_NAME}`, DEFAULT_FILE_NAME);
 cliApp.option("-r, --rule <rule name>", "Valid rule name to check. Defaults to nothing");
-cliApp.option("-c, --rules-file <filePath>", "File path of .packagejsonlintrc");
+cliApp.option("-c, --rules-file <filePath>", "File path of .npmpackagejsonlintrc");
 cliApp.option("-w, --ignore-warnings", "Ignore warnings");
 cliApp.parse(process.argv);
 
@@ -56,7 +56,7 @@ if (typeof cliApp.rulesFile !== "undefined") {
 // check if rules have been found. If no, then lets try to find a config file in
 // the user's home directory
 if (!rulesLoaded) {
-  let userHomeRcFile = path.join(userHome, PACKAGE_JSON_RC_FILE_NAME);
+  let userHomeRcFile = path.join(userHome, NPM_PACKAGE_JSON_RC_FILE_NAME);
 
   if (fs.existsSync(userHomeRcFile)) {
     rulesConfig = userHomeRcFile;
@@ -70,8 +70,8 @@ try {
   let parser = new Parser();
   fileData = parser.parse(filePath);
 
-  let packageJsonLint = new PackageJsonLint(fileData, rulesConfig, options);
-  let output = packageJsonLint.lint();
+  let npmPackageJsonLint = new NpmPackageJsonLint(fileData, rulesConfig, options);
+  let output = npmPackageJsonLint.lint();
 
   let reporter = new Reporter();
 

tests/unit/ConfigTest.js

@@ -31,9 +31,9 @@ describe("Config Unit Tests", function() {
     });
   });
 
-  context("when a relative path string to a .packagejsonlintrc file is passed", function() {
+  context("when a relative path string to a .npmpackagejsonlintrc file is passed", function() {
     it("the config object should return the parsed JSON as an object", function() {
-      let passedConfig = "./.packagejsonlintrc";
+      let passedConfig = "./.npmpackagejsonlintrc";
       let config = new Config(passedConfig);
       let obj = {
         "version-type": true
@@ -44,9 +44,9 @@ describe("Config Unit Tests", function() {
     });
   });
 
-  context("when an absolute path string to a .packagejsonlintrc file is passed", function() {
+  context("when an absolute path string to a .npmpackagejsonlintrc file is passed", function() {
     it("the config object should return the parsed JSON as an object", function() {
-      let passedConfig = "/Users/awesomeUser/.packagejsonlintrc";
+      let passedConfig = "/Users/awesomeUser/.npmpackagejsonlintrc";
       let config = new Config(passedConfig);
       let obj = {
         "version-type": true

tests/unit/PackageJsonLintTest.js renamed to tests/unit/NpmPackageJsonLintTest.js

@@ -4,9 +4,9 @@ let fs = require("fs");
 let should = require("should");
 let sinon = require("sinon");
 let requireHelper = require("../require_helper");
-let PackageJsonLint = requireHelper("PackageJsonLint");
+let NpmPackageJsonLint = requireHelper("NpmPackageJsonLint");
 
-describe("PackageJsonLint Unit Tests", function() {
+describe("NpmPackageJsonLint Unit Tests", function() {
   describe("lint method", function() {
     context("validate that errors and warnings are set", function() {
       it("two errors and zero warnings expected", function() {
@@ -21,14 +21,14 @@ describe("PackageJsonLint Unit Tests", function() {
         let options = {
           ignoreWarnings: false
         };
-        let packageJsonLint = new PackageJsonLint(packageJsonData, config, options);
+        let npmPackageJsonLint = new NpmPackageJsonLint(packageJsonData, config, options);
         let rules = {
           "description-type": "rules\\description-type.js",
           "name-format": "rules\\name-format.js"
         };
-        let rulesStub = sinon.stub(packageJsonLint, "_loadRules").returns(rules);
-        let configStub = sinon.stub(packageJsonLint, "_getConfig").returns(config);
-        let response = packageJsonLint.lint();
+        let rulesStub = sinon.stub(npmPackageJsonLint, "_loadRules").returns(rules);
+        let configStub = sinon.stub(npmPackageJsonLint, "_getConfig").returns(config);
+        let response = npmPackageJsonLint.lint();
         response.errors.length.should.equal(2);
         response.warnings.length.should.equal(0);
       });
@@ -46,14 +46,14 @@ describe("PackageJsonLint Unit Tests", function() {
         let options = {
           ignoreWarnings: false
         };
-        let packageJsonLint = new PackageJsonLint(packageJsonData, config, options);
+        let npmPackageJsonLint = new NpmPackageJsonLint(packageJsonData, config, options);
         let rules = {
           "keywords-recommended": "rules\\keywords-recommended.js",
           "name-format": "rules\\name-format.js"
         };
-        let rulesStub = sinon.stub(packageJsonLint, "_loadRules").returns(rules);
-        let configStub = sinon.stub(packageJsonLint, "_getConfig").returns(config);
-        let response = packageJsonLint.lint();
+        let rulesStub = sinon.stub(npmPackageJsonLint, "_loadRules").returns(rules);
+        let configStub = sinon.stub(npmPackageJsonLint, "_getConfig").returns(config);
+        let response = npmPackageJsonLint.lint();
         response.errors.length.should.equal(1);
         response.warnings.length.should.equal(1);
       });
@@ -71,14 +71,14 @@ describe("PackageJsonLint Unit Tests", function() {
         let options = {
           ignoreWarnings: true
         };
-        let packageJsonLint = new PackageJsonLint(packageJsonData, config, options);
+        let npmPackageJsonLint = new NpmPackageJsonLint(packageJsonData, config, options);
         let rules = {
           "keywords-recommended": "rules\\keywords-recommended.js",
           "name-format": "rules\\name-format.js"
         };
-        let rulesStub = sinon.stub(packageJsonLint, "_loadRules").returns(rules);
-        let configStub = sinon.stub(packageJsonLint, "_getConfig").returns(config);
-        let response = packageJsonLint.lint();
+        let rulesStub = sinon.stub(npmPackageJsonLint, "_loadRules").returns(rules);
+        let configStub = sinon.stub(npmPackageJsonLint, "_getConfig").returns(config);
+        let response = npmPackageJsonLint.lint();
         response.errors.length.should.equal(1);
         response.hasOwnProperty("warnings").should.be.false();
       });
@@ -98,13 +98,13 @@ describe("PackageJsonLint Unit Tests", function() {
         let options = {
           ignoreWarnings: true
         };
-        let packageJsonLint = new PackageJsonLint(packageJsonData, config, options);
+        let npmPackageJsonLint = new NpmPackageJsonLint(packageJsonData, config, options);
         let rules = {
           "author-valid-values": "rules\\author-valid-values.js"
         };
-        let rulesStub = sinon.stub(packageJsonLint, "_loadRules").returns(rules);
-        let configStub = sinon.stub(packageJsonLint, "_getConfig").returns(config);
-        let response = packageJsonLint.lint();
+        let rulesStub = sinon.stub(npmPackageJsonLint, "_loadRules").returns(rules);
+        let configStub = sinon.stub(npmPackageJsonLint, "_getConfig").returns(config);
+        let response = npmPackageJsonLint.lint();
         response.errors.length.should.equal(1);
         response.hasOwnProperty("warnings").should.be.false();
       });