Add require-types and require-typings (#112)

Author: tclindner

CHANGELOG.md

@@ -11,6 +11,13 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Removed
 
+## [3.7.0] - 2019-06-16
+### Added
+- New rule: [require-types](https://github.com/tclindner/npm-package-json-lint/wiki/require-types).
+- New rule: [require-typings](https://github.com/tclindner/npm-package-json-lint/wiki/require-typings).
+
+Addresses [#109](https://github.com/tclindner/npm-package-json-lint/issues/109) from @ceilfors.
+
 ## [3.6.1] - 2019-05-22
 ### Fixed
 - @lddubeau resolved an issue with how require.resolve was implemented. The issue was causing npm-package-json-lint to crash on Node 12.3.0. Please see #110 for more details.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "npm-package-json-lint",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "description": "Configurable linter for package.json files.",
   "keywords": [
     "lint",
@@ -34,30 +34,30 @@
     "test:ci": "jest --runInBand"
   },
   "dependencies": {
-    "ajv": "^6.9.2",
+    "ajv": "^6.10.0",
     "chalk": "^2.4.2",
-    "glob": "^7.1.3",
-    "ignore": "^5.0.5",
-    "is-path-inside": "^2.0.0",
+    "glob": "^7.1.4",
+    "ignore": "^5.1.2",
+    "is-path-inside": "^2.1.0",
     "is-plain-obj": "^1.1.0",
     "is-resolvable": "^1.1.0",
     "log-symbols": "^2.2.0",
     "meow": "^5.0.0",
-    "plur": "^3.0.1",
+    "plur": "^3.1.1",
     "semver": "^5.6.0",
     "strip-json-comments": "^2.0.1",
     "validator": "^10.11.0"
   },
   "devDependencies": {
-    "eslint": "^5.14.1",
-    "eslint-config-tc": "^6.0.0",
+    "eslint": "^5.16.0",
+    "eslint-config-tc": "^6.4.0",
     "eslint-formatter-pretty": "^2.1.1",
-    "eslint-plugin-import": "^2.16.0",
-    "eslint-plugin-prettier": "^3.0.1",
+    "eslint-plugin-import": "^2.17.3",
+    "eslint-plugin-prettier": "^3.1.0",
     "figures": "^2.0.0",
-    "jest": "^24.1.0",
+    "jest": "^24.8.0",
     "npm-package-json-lint-config-default": "^2.0.0",
-    "prettier": "^1.16.4"
+    "prettier": "^1.18.2"
   },
   "engines": {
     "node": ">=6.0.0",

src/rules/require-types.js

@@ -0,0 +1,17 @@
+const LintIssue = require('./../LintIssue');
+
+const lintId = 'require-types';
+const nodeName = 'types';
+const message = 'types is required';
+const ruleType = 'standard';
+
+const lint = (packageJsonData, severity) => {
+  if (!packageJsonData.hasOwnProperty(nodeName)) {
+    return new LintIssue(lintId, severity, nodeName, message);
+  }
+
+  return true;
+};
+
+module.exports.lint = lint;
+module.exports.ruleType = ruleType;

src/rules/require-typings.js

@@ -0,0 +1,17 @@
+const LintIssue = require('./../LintIssue');
+
+const lintId = 'require-typings';
+const nodeName = 'typings';
+const message = 'typings is required';
+const ruleType = 'standard';
+
+const lint = (packageJsonData, severity) => {
+  if (!packageJsonData.hasOwnProperty(nodeName)) {
+    return new LintIssue(lintId, severity, nodeName, message);
+  }
+
+  return true;
+};
+
+module.exports.lint = lint;
+module.exports.ruleType = ruleType;

test/unit/rules/require-types.test.js

@@ -0,0 +1,34 @@
+const ruleModule = require('./../../../src/rules/require-types');
+
+const {lint, ruleType} = ruleModule;
+
+describe('require-types Unit Tests', () => {
+  describe('a rule type value should be exported', () => {
+    test('it should equal "standard"', () => {
+      expect(ruleType).toStrictEqual('standard');
+    });
+  });
+
+  describe('when package.json has node', () => {
+    test('true should be returned', () => {
+      const packageJsonData = {
+        types: './lib/main.d.ts'
+      };
+      const response = lint(packageJsonData, 'error');
+
+      expect(response).toBeTruthy();
+    });
+  });
+
+  describe('when package.json does not have node', () => {
+    test('LintIssue object should be returned', () => {
+      const packageJsonData = {};
+      const response = lint(packageJsonData, 'error');
+
+      expect(response.lintId).toStrictEqual('require-types');
+      expect(response.severity).toStrictEqual('error');
+      expect(response.node).toStrictEqual('types');
+      expect(response.lintMessage).toStrictEqual('types is required');
+    });
+  });
+});

test/unit/rules/require-typings.test.js

@@ -0,0 +1,34 @@
+const ruleModule = require('./../../../src/rules/require-typings');
+
+const {lint, ruleType} = ruleModule;
+
+describe('require-typings Unit Tests', () => {
+  describe('a rule type value should be exported', () => {
+    test('it should equal "standard"', () => {
+      expect(ruleType).toStrictEqual('standard');
+    });
+  });
+
+  describe('when package.json has node', () => {
+    test('true should be returned', () => {
+      const packageJsonData = {
+        typings: './lib/main.d.ts'
+      };
+      const response = lint(packageJsonData, 'error');
+
+      expect(response).toBeTruthy();
+    });
+  });
+
+  describe('when package.json does not have node', () => {
+    test('LintIssue object should be returned', () => {
+      const packageJsonData = {};
+      const response = lint(packageJsonData, 'error');
+
+      expect(response.lintId).toStrictEqual('require-typings');
+      expect(response.severity).toStrictEqual('error');
+      expect(response.node).toStrictEqual('typings');
+      expect(response.lintMessage).toStrictEqual('typings is required');
+    });
+  });
+});