Add rule to main rules page (#184)

* Rename rule

* Add rule to main rules page

Author: tclindner

docs/rules.md

@@ -145,6 +145,7 @@ Rules allow npm-package-json-lint to be fully customizable. npm-package-json-lin
 > Generates an error if the package.json properties fail to meet the desired requirements
 
 * [prefer-property-order](rules/package-json-properties/prefer-property-order.md)
+* [no-duplicate-properties](rules/package-json-properties/no-duplicate-properties.md)
 
 
 ## Disallowed node rules

docs/rules/dependencies/no-dup-fields.md renamed to docs/rules/package-json-properties/no-duplicate-properties.md

@@ -1,16 +1,16 @@
 ---
-id: no-dup-fields
-title: no-dup-fields
+id: no-duplicate-properties
+title: no-duplicate-properties
 ---
 
-Enabling this rule will result in an error being generated if package.json has duplicate fields in block section.
+Enabling this rule will result in an error being generated if package.json has duplicate properties in block section.
 
 ## Example .npmpackagejsonlintrc configuration
 
 ```json
 {
   "rules": {
-    "no-dup-fields": "error"
+    "no-duplicate-properties": "error"
   }
 }
 ```
@@ -41,7 +41,7 @@ Enabling this rule will result in an error being generated if package.json has d
 ```json
 {
   "rules": {
-    "no-dup-fields": "off"
+    "no-duplicate-properties": "off"
   }
 }
 ```

src/rules/no-dup-fields.js renamed to src/rules/no-duplicate-properties.js

@@ -1,8 +1,8 @@
 const Parser = require('../Parser');
 const {findDuplicatePropNames} = require('../validators/property');
-const LintIssue = require('./../LintIssue');
+const LintIssue = require('../LintIssue');
 
-const lintId = 'no-duplicate-fields';
+const lintId = 'no-duplicate-properties';
 const nodeName = '';
 const ruleType = 'standard';
 
@@ -15,7 +15,7 @@ const lint = (packageJsonData, severity) => {
   const dupProps = findDuplicatePropNames(source);
 
   if (dupProps.length) {
-    const message = `You have duplicate field names: ${dupProps.join(', ')}. Please remove duplicates.`;
+    const message = `Duplicate properties detected. Please remove duplicates for: ${dupProps.join(', ')}.`;
 
     return new LintIssue(lintId, severity, nodeName, message);
   }

test/unit/rules/no-dup-fields.test.js renamed to test/unit/rules/no-duplicate-properties.test.js

@@ -1,4 +1,4 @@
-const ruleModule = require('./../../../src/rules/no-dup-fields');
+const ruleModule = require('../../../src/rules/no-duplicate-properties');
 const Parser = require('../../../src/Parser');
 
 const {lint, ruleType} = ruleModule;
@@ -11,28 +11,28 @@ const parsePackageJson = source => {
   return json;
 };
 
-describe('no-dup-fields Unit Tests', () => {
+describe('no-duplicate-properties Unit Tests', () => {
   describe('a rule type value should be exported', () => {
     test('it should equal "standard"', () => {
       expect(ruleType).toStrictEqual('standard');
     });
   });
 
-  describe('when package.json has duplicate fields', () => {
+  describe('when package.json has duplicate properties', () => {
     test('LintIssue object should be returned', () => {
       const packageJsonData = parsePackageJson(`{
         "name": "package1",
         "name": "package2"
       }`);
       const response = lint(packageJsonData, 'error');
 
-      expect(response.lintId).toStrictEqual('no-duplicate-fields');
+      expect(response.lintId).toStrictEqual('no-duplicate-properties');
       expect(response.severity).toStrictEqual('error');
-      expect(response.lintMessage).toStrictEqual('You have duplicate field names: name. Please remove duplicates.');
+      expect(response.lintMessage).toStrictEqual('Duplicate properties detected. Please remove duplicates for: name.');
     });
   });
 
-  describe('when package.json has nested duplicate fields', () => {
+  describe('when package.json has nested duplicate properties', () => {
     test('LintIssue object should be returned', () => {
       const packageJsonData = parsePackageJson(`{
         "name": "package",
@@ -44,9 +44,9 @@ describe('no-dup-fields Unit Tests', () => {
       }`);
       const response = lint(packageJsonData, 'error');
 
-      expect(response.lintId).toStrictEqual('no-duplicate-fields');
+      expect(response.lintId).toStrictEqual('no-duplicate-properties');
       expect(response.severity).toStrictEqual('error');
-      expect(response.lintMessage).toStrictEqual('You have duplicate field names: eslint. Please remove duplicates.');
+      expect(response.lintMessage).toStrictEqual('Duplicate properties detected. Please remove duplicates for: eslint.');
     });
   });
 

website/versioned_docs/version-4.5.0/rules.md

@@ -0,0 +1,160 @@
+---
+id: version-4.5.0-rules
+title: Rules
+original_id: rules
+---
+
+Rules allow npm-package-json-lint to be fully customizable. npm-package-json-lint will only run the rules supplied. As of v2.7.0, there are multiple ways to supply [configuration](configuration.md). One of the easiest way is via a [.npmpackagejsonlintrc.json](rcfile-example.md) file. Please see the default config module, [npm-package-json-lint-config-default](https://github.com/tclindner/npm-package-json-lint-config-default) instead.
+
+## Require node rules
+
+> Generates an error if node is missing from package.json file
+
+* [require-author](rules/required-node/require-author.md)
+* [require-bin](rules/required-node/require-bin.md)
+* [require-bugs](rules/required-node/require-bugs.md)
+* [require-bundledDependencies](rules/required-node/require-bundledDependencies.md)
+* [require-config](rules/required-node/require-config.md)
+* [require-contributors](rules/required-node/require-contributors.md)
+* [require-cpu](rules/required-node/require-cpu.md)
+* [require-dependencies](rules/required-node/require-dependencies.md)
+* [require-description](rules/required-node/require-description.md)
+* [require-devDependencies](rules/required-node/require-devDependencies.md)
+* [require-directories](rules/required-node/require-directories.md)
+* [require-engines](rules/required-node/require-engines.md)
+* [require-files](rules/required-node/require-files.md)
+* [require-homepage](rules/required-node/require-homepage.md)
+* [require-keywords](rules/required-node/require-keywords.md)
+* [require-license](rules/required-node/require-license.md)
+* [require-main](rules/required-node/require-main.md)
+* [require-man](rules/required-node/require-man.md)
+* [require-module](rules/required-node/require-module.md)
+* [require-name](rules/required-node/require-name.md)
+* [require-optionalDependencies](rules/required-node/require-optionalDependencies.md)
+* [require-os](rules/required-node/require-os.md)
+* [require-peerDependencies](rules/required-node/require-peerDependencies.md)
+* [require-preferGlobal](rules/required-node/require-preferGlobal.md)
+* [require-private](rules/required-node/require-private.md)
+* [require-publishConfig](rules/required-node/require-publishConfig.md)
+* [require-repository-directory](rules/required-node/require-repository-directory.md)
+* [require-repository](rules/required-node/require-repository.md)
+* [require-scripts](rules/required-node/require-scripts.md)
+* [require-types](rules/required-node/require-types.md)
+* [require-typings](rules/required-node/require-typings.md)
+* [require-version](rules/required-node/require-version.md)
+
+## Type rules
+
+> Generates an error if node's value doesn't have the correct data type
+
+* [bin-type](rules/type/bin-type.md)
+* [bundledDependencies-type](rules/type/bundledDependencies-type.md)
+* [config-type](rules/type/config-type.md)
+* [cpu-type](rules/type/cpu-type.md)
+* [dependencies-type](rules/type/dependencies-type.md)
+* [description-type](rules/type/description-type.md)
+* [devDependencies-type](rules/type/devDependencies-type.md)
+* [directories-type](rules/type/directories-type.md)
+* [engines-type](rules/type/engines-type.md)
+* [files-type](rules/type/files-type.md)
+* [homepage-type](rules/type/homepage-type.md)
+* [keywords-type](rules/type/keywords-type.md)
+* [license-type](rules/type/license-type.md)
+* [main-type](rules/type/main-type.md)
+* [man-type](rules/type/man-type.md)
+* [name-type](rules/type/name-type.md)
+* [optionalDependencies-type](rules/type/optionalDependencies-type.md)
+* [os-type](rules/type/os-type.md)
+* [peerDependencies-type](rules/type/peerDependencies-type.md)
+* [preferGlobal-type](rules/type/preferGlobal-type.md)
+* [private-type](rules/type/private-type.md)
+* [repository-type](rules/type/repository-type.md)
+* [scripts-type](rules/type/scripts-type.md)
+* [version-type](rules/type/version-type.md)
+
+
+## Valid value rules
+
+> Generates an error if node's value doesn't match one of the values in the supplied array
+
+* [valid-values-author](rules/valid-values/valid-values-author.md)
+* [valid-values-engines](rules/valid-values/valid-values-engines.md)
+* [valid-values-license](rules/valid-values/valid-values-license.md)
+* [valid-values-name-scope](rules/valid-values/valid-values-name-scope.md)
+* [valid-values-private](rules/valid-values/valid-values-private.md)
+* [valid-values-publishConfig](rules/valid-values/valid-values-publishConfig.md)
+
+## Dependency rules
+
+> Generates an error if dependencies fail to meet the rules requirements
+
+* [no-repeated-dependencies](rules/dependencies/no-repeated-dependencies.md)
+
+* dependencies
+  * [no-absolute-version-dependencies](rules/dependencies/no-absolute-version-dependencies.md)
+  * [no-archive-dependencies](rules/dependencies/no-archive-dependencies.md)
+  * [no-caret-version-dependencies](rules/dependencies/no-caret-version-dependencies.md)
+  * [no-file-dependencies](rules/dependencies/no-file-dependencies.md)
+  * [no-git-dependencies](rules/dependencies/no-git-dependencies.md)
+  * [no-restricted-dependencies](rules/dependencies/no-restricted-dependencies.md)
+  * [no-restricted-pre-release-dependencies](rules/dependencies/no-restricted-pre-release-dependencies.md)
+  * [no-tilde-version-dependencies](rules/dependencies/no-tilde-version-dependencies.md)
+  * [prefer-absolute-version-dependencies](rules/dependencies/prefer-absolute-version-dependencies.md)
+  * [prefer-alphabetical-dependencies](rules/dependencies/prefer-alphabetical-dependencies.md)
+  * [prefer-caret-version-dependencies](rules/dependencies/prefer-caret-version-dependencies.md)
+  * [prefer-no-version-zero-dependencies](rules/dependencies/prefer-no-version-zero-dependencies.md)
+  * [prefer-tilde-version-dependencies](rules/dependencies/prefer-tilde-version-dependencies.md)
+* devDependencies
+  * [no-absolute-version-devDependencies](rules/dependencies/no-absolute-version-devDependencies.md)
+  * [no-archive-devDependencies](rules/dependencies/no-archive-devDependencies.md)
+  * [no-caret-version-devDependencies](rules/dependencies/no-caret-version-devDependencies.md)
+  * [no-file-devDependencies](rules/dependencies/no-file-devDependencies.md)
+  * [no-git-devDependencies](rules/dependencies/no-git-devDependencies.md)
+  * [no-restricted-devDependencies](rules/dependencies/no-restricted-devDependencies.md)
+  * [no-restricted-pre-release-devDependencies](rules/dependencies/no-restricted-pre-release-devDependencies.md)
+  * [no-tilde-version-devDependencies](rules/dependencies/no-tilde-version-devDependencies.md)
+  * [prefer-no-version-zero-devDependencies](rules/dependencies/prefer-no-version-zero-devDependencies.md)
+  * [prefer-absolute-version-devDependencies](rules/dependencies/prefer-absolute-version-devDependencies.md)
+  * [prefer-alphabetical-devDependencies](rules/dependencies/prefer-alphabetical-devDependencies.md)
+  * [prefer-caret-version-devDependencies](rules/dependencies/prefer-caret-version-devDependencies.md)
+  * [prefer-no-version-zero-devDependencies](rules/dependencies/prefer-no-version-zero-devDependencies.md)
+  * [prefer-tilde-version-devDependencies](rules/dependencies/prefer-tilde-version-devDependencies.md)
+* bundledDependencies
+  * [prefer-alphabetical-bundledDependencies](rules/dependencies/prefer-alphabetical-bundledDependencies.md)
+* optionalDependencies
+  * [prefer-alphabetical-optionalDependencies](rules/dependencies/prefer-alphabetical-optionalDependencies.md)
+* peerDependencies
+  * [prefer-alphabetical-peerDependencies](rules/dependencies/prefer-alphabetical-peerDependencies.md)
+
+## Scripts rules
+
+> Generates an error if scripts fail to meet the rules requirements
+
+* [prefer-alphabetical-scripts](rules/scripts/prefer-alphabetical-scripts.md)
+
+## Format rules
+
+> Generates an error if node's value fails to meet the format requirements
+
+* [description-format](rules/format/description-format.md)
+* [name-format](rules/format/name-format.md)
+* [version-format](rules/format/version-format.md)
+
+
+## Package.json property rules
+
+> Generates an error if the package.json properties fail to meet the desired requirements
+
+* [prefer-property-order](rules/package-json-properties/prefer-property-order.md)
+* [no-duplicate-properties](rules/package-json-properties/no-duplicate-properties.md)
+
+
+## Disallowed node rules
+
+> Generates an error if the node is present
+
+* [prefer-no-engineStrict](rules/disallowed-nodes/prefer-no-engineStrict)
+* [prefer-no-dependencies](rules/disallowed-nodes/prefer-no-dependencies)
+* [prefer-no-devDependencies](rules/disallowed-nodes/prefer-no-devDependencies)
+* [prefer-no-optionalDependencies](rules/disallowed-nodes/prefer-no-optionalDependencies)
+* [prefer-no-peerDependencies](rules/disallowed-nodes/prefer-no-peerDependencies)

website/versioned_docs/version-4.5.0/rules/dependencies/no-dup-fields.md renamed to website/versioned_docs/version-4.5.0/rules/package-json-properties/no-duplicate-properties.md

@@ -1,17 +1,17 @@
 ---
-id: version-4.5.0-no-dup-fields
-title: no-dup-fields
-original_id: no-dup-fields
+id: version-4.5.0-no-duplicate-properties
+title: no-duplicate-properties
+original_id: no-duplicate-properties
 ---
 
-Enabling this rule will result in an error being generated if package.json has duplicate fields in block section.
+Enabling this rule will result in an error being generated if package.json has duplicate properties in block section.
 
 ## Example .npmpackagejsonlintrc configuration
 
 ```json
 {
   "rules": {
-    "no-dup-fields": "error"
+    "no-duplicate-properties": "error"
   }
 }
 ```
@@ -42,7 +42,7 @@ Enabling this rule will result in an error being generated if package.json has d
 ```json
 {
   "rules": {
-    "no-dup-fields": "off"
+    "no-duplicate-properties": "off"
   }
 }
 ```