feat(rules): add rules for tense-checking

Author: marionebl

documentation/rules.md

@@ -53,6 +53,23 @@ Rule configurations are either of type `array` residing on a key with the rule's
   0
 ```
 
+#### body-tense
+* **condition**: `body` is verbalized in tense present in `value`
+* **rule**: `always`
+* **value**
+```js
+  ['present-imperative']
+```
+* **possible values**
+```js
+  [
+    'past-tense', // did
+    'present-imperative', // do
+    'present-participle', // doing
+    'present-third-person' // does
+  ]
+```
+
 #### footer-leading-blank
 * **condition**: `footer` begins with blank line
 * **rule**: `always`
@@ -73,6 +90,23 @@ Rule configurations are either of type `array` residing on a key with the rule's
   0
 ```
 
+#### footer-tense
+* **condition**: `footer` is verbalized in tense present in `value`
+* **rule**: `always`
+* **value**
+```js
+  ['present-imperative']
+```
+* **possible values**
+```js
+  [
+    'past-tense', // did
+    'present-imperative', // do
+    'present-participle', // doing
+    'present-third-person' // does
+  ]
+```
+
 #### header-max-length
 * **condition**: `header` has `value` or less characters
 * **rule**: `always`
@@ -143,6 +177,14 @@ Rule configurations are either of type `array` residing on a key with the rule's
 * **condition**: `subject` is empty
 * **rule**: `never`
 
+#### subject-full-stop
+* **condition**: `subject` ends with `value`
+* **rule**: `never`
+* **value**
+```js
+  '.'
+```
+
 #### subject-max-length
 * **condition**: `subject` has `value` or less characters
 * **rule**: `always`
@@ -159,12 +201,21 @@ Rule configurations are either of type `array` residing on a key with the rule's
   0
 ```
 
-#### subject-full-stop
-* **condition**: `subject` ends with `value`
-* **rule**: `never`
+#### subject-tense
+* **condition**: `subject` is verbalized in tense present in `value`
+* **rule**: `always`
 * **value**
 ```js
-  '.'
+  ['present-imperative']
+```
+* **possible values**
+```js
+  [
+    'past-tense', // did
+    'present-imperative', // do
+    'present-participle', // doing
+    'present-third-person' // does
+  ]
 ```
 
 #### type-enum

package.json

@@ -70,9 +70,10 @@
     "franc": "1.1.2",
     "get-stdin": "5.0.1",
     "git-raw-commits": "1.0.0",
-    "lodash.merge": "4.1.0",
-    "lodash.pick": "4.0.1",
-    "meow": "3.7.0"
+    "lodash": "4.5.1",
+    "meow": "3.7.0",
+    "pos": "0.3.0",
+    "rc": "1.1.6"
   },
   "config": {
     "commitizen": {

source/cli.js

@@ -5,7 +5,7 @@ import 'babel-polyfill';
 // npm modules
 import chalk from 'chalk';
 import meow from 'meow';
-import pick from 'lodash.pick';
+import {pick} from 'lodash';
 import stdin from 'get-stdin';
 
 // local modules

source/library/ensure-tense.js

@@ -0,0 +1,49 @@
+import {Lexer, Tagger} from 'pos';
+
+const lexer = new Lexer();
+const tagger = new Tagger();
+
+const tenses = {
+	'past-tense': ['VB', 'VBD'],
+	'present-imperative': ['VB', 'VBN', 'VBP'],
+	'present-participle': ['VB', 'VBG'],
+	'present-third-person': ['VB', 'VBZ']
+};
+
+export default (input, allowed) => {
+	const lemmata = lexer.lex(input);
+	const tagged = tagger.tag(lemmata);
+	const verbs = tagged.filter(tag => tag[1][0] === 'V');
+	const tags = allowed.reduce((registry, name) => {
+		return [
+			...registry,
+			...(tenses[name] || [])
+		];
+	}, []);
+
+	const offending = verbs
+		.filter(verb => {
+			const [, tag] = verb;
+			return tags.length > 0 && tags.indexOf(tag) === -1;
+		})
+		.filter(Boolean)
+		.map(verb => {
+			const [lemma, tag] = verb;
+			const tense = Object.entries(tenses)
+				.filter(item => {
+					const [, tags] = item;
+					return tags.indexOf(tag) > -1;
+				})
+				.map(item => item[0])[0];
+
+			return {
+				lemma,
+				tense
+			};
+		});
+
+	return {
+		matches: offending.length === 0,
+		offending
+	};
+};

source/library/get-configuration.js

@@ -1,5 +1,4 @@
-import merge from 'lodash.merge';
-import pick from 'lodash.pick';
+import {merge, pick} from 'lodash';
 import rc from 'rc';
 
 const defaults = {

source/rules/body-tense.js

@@ -0,0 +1,20 @@
+import ensureTense from '../library/ensure-tense';
+
+export default (parsed, when, value) => {
+	const negated = when === 'never';
+	const {matches, offending} = ensureTense(parsed.body, value);
+	const offenders = offending
+		.map(item => [item.lemma, item.tense].join(' - '))
+		.join(',');
+
+	return [
+		negated ? !matches : matches,
+		[
+			`tense of body must`,
+			negated ? `not` : null,
+			`be ${value}. Verbs in other tenses: ${offenders}`
+		]
+		.filter(Boolean)
+		.join(' ')
+	];
+};

source/rules/footer-tense.js

@@ -0,0 +1,20 @@
+import ensureTense from '../library/ensure-tense';
+
+export default (parsed, when, value) => {
+	const negated = when === 'never';
+	const {matches, offending} = ensureTense(parsed.footer, value);
+	const offenders = offending
+		.map(item => [item.lemma, item.tense].join(' - '))
+		.join(',');
+
+	return [
+		negated ? !matches : matches,
+		[
+			`tense of footer must`,
+			negated ? `not` : null,
+			`be ${value}. Verbs in other tenses: ${offenders}`
+		]
+		.filter(Boolean)
+		.join(' ')
+	];
+};

source/rules/subject-tense.js

@@ -0,0 +1,20 @@
+import ensureTense from '../library/ensure-tense';
+
+export default (parsed, when, value) => {
+	const negated = when === 'never';
+	const {matches, offending} = ensureTense(parsed.subject, value);
+	const offenders = offending
+		.map(item => [item.lemma, item.tense].join(' - '))
+		.join(',');
+
+	return [
+		negated ? !matches : matches,
+		[
+			`tense of message must`,
+			negated ? `not` : null,
+			`be ${value}. Verbs in other tenses: ${offenders}`
+		]
+		.filter(Boolean)
+		.join(' ')
+	];
+};