Merge branch 'feature/tslint-to-eslint' into develop

Author: wimpyprogrammer

.eslintignore

@@ -0,0 +1,3 @@
+/coverage/
+/demo/demo.js
+/lib/

.eslintrc.json

@@ -0,0 +1,27 @@
+{
+	"parser": "@typescript-eslint/parser",
+	"extends": [
+		"airbnb-base",
+		"plugin:jest/recommended",
+		"plugin:@typescript-eslint/eslint-recommended",
+		"plugin:@typescript-eslint/recommended",
+		"prettier",
+		"prettier/@typescript-eslint"
+	],
+	"parserOptions": {
+		"ecmaVersion": 2018
+	},
+	"rules": {
+		"import/prefer-default-export": "off"
+	},
+	"settings": {
+		"import/parsers": {
+			"@typescript-eslint/parser": [
+				".ts"
+			]
+		},
+		"import/resolver": {
+			"typescript": {}
+		}
+	}
+}

package.json

@@ -20,7 +20,7 @@
     "build-demo": "webpack --config demo/webpack.config.js",
     "clean": "rimraf lib/*",
     "format": "prettier --write 'src/**'",
-    "lint": "tsc; tslint -p ./",
+    "lint": "tsc; eslint . --report-unused-disable-directives --ext .js,.ts",
     "precommit": "pretty-quick --staged",
     "test": "jest --coverage",
     "travisci": "npm run lint && npm run test"
@@ -50,14 +50,21 @@
     "@babel/preset-typescript": "^7.0.0-beta.54",
     "@types/es6-shim": "^0.31.37",
     "@types/jest": "^23.3.1",
+    "@typescript-eslint/eslint-plugin": "^2.2.0",
+    "@typescript-eslint/parser": "^2.2.0",
+    "eslint": "6.1.0",
+    "eslint-config-airbnb-base": "14.0.0",
+    "eslint-config-prettier": "^6.3.0",
+    "eslint-import-resolver-typescript": "^1.1.1",
+    "eslint-plugin-import": "^2.18.2",
+    "eslint-plugin-jest": "^22.17.0",
     "husky": "^0.14.3",
     "jest": "^23.4.1",
     "prettier": "^1.13.7",
     "pretty-quick": "^1.6.0",
     "rimraf": "^2.6.2",
     "ts-jest": "^23.0.1",
     "ts-loader": "^5.0.0",
-    "tslint": "^5.11.0",
     "typescript": "^2.9.2",
     "webpack": "^4.17.2",
     "webpack-command": "^0.4.1"

src/demo.ts

@@ -24,7 +24,7 @@ function generatePattern(
 }
 
 let clearSuccessIndicatorHandle: number;
-function displayPattern(pattern: string) {
+function displayPattern(pattern: string): void {
 	$output.value = pattern;
 
 	// Temporarily style the output box as valid
@@ -37,7 +37,7 @@ function displayPattern(pattern: string) {
 	);
 }
 
-function onClickGenerate() {
+function onClickGenerate(): void {
 	try {
 		if (!$form.reportValidity()) {
 			return;
@@ -66,7 +66,7 @@ document
 	.querySelector('.js-generate')
 	.addEventListener('click', onClickGenerate);
 
-(() => {
+((): void => {
 	const exampleInput =
 		'Alabama, Alaska, Arizona, Arkansas, California, ' +
 		'Colorado, Connecticut, Delaware, Florida, Georgia';

src/types/charTrie.ts

@@ -1,16 +1,11 @@
-interface ICharTrieData {
-	[prefix: string]: ICharTrieData;
+interface CharTrieData {
+	[prefix: string]: CharTrieData;
 }
 
 export type Char = string;
-export interface ICharTrie extends Map<Char, ICharTrie> {
-	[headChar: string]: any | ICharTrie;
-}
-
-export class CharTrie extends Map<Char, CharTrie> implements ICharTrie {
-	[headChar: string]: any | CharTrie;
 
-	public static create(trieData: ICharTrieData): CharTrie {
+export class CharTrie extends Map<Char, CharTrie> {
+	public static create(trieData: CharTrieData): CharTrie {
 		const trieDataPairs = Object.entries(trieData);
 
 		const trie = trieDataPairs.reduce(

src/utils/pattern.ts

@@ -1,4 +1,4 @@
-import { ICharTrie } from '../types/charTrie';
+import { CharTrie } from '../types/charTrie';
 
 /**
  * Generate a regular expression pattern that captures the strings
@@ -7,7 +7,7 @@ import { ICharTrie } from '../types/charTrie';
  * @param charTrie A character trie
  * @returns A regular expression pattern
  */
-export function build(charTrie: ICharTrie): string {
+export function build(charTrie: CharTrie): string {
 	const patternSegments = Array.from(
 		[...charTrie],
 		([head, suffixTrie]) => `${head}${build(suffixTrie)}`

src/utils/trie.ts

@@ -1,6 +1,6 @@
-import { Char, ICharTrie } from '../types/charTrie';
+import { Char, CharTrie } from '../types/charTrie';
 
-const leafNode = new Map() as ICharTrie;
+const leafNode = new Map() as CharTrie;
 
 function groupWordsByHeadChar(
 	words: string[],
@@ -30,13 +30,20 @@ function groupWordsByHeadChar(
  * @param tailGroup A character trie of suffixes to headChar
  * @returns A character trie with tailGroup branching from headChar
  */
-function mergeGroups(headChar: Char, tailGroup: ICharTrie): ICharTrie {
+function mergeGroups(headChar: Char, tailGroup: CharTrie): CharTrie {
 	if (tailGroup.size !== 1) {
-		return new Map([[headChar, tailGroup]]) as ICharTrie;
+		return new Map([[headChar, tailGroup]]) as CharTrie;
 	}
 
 	const [onlyTail, onBranch] = tailGroup.entries().next().value;
-	return new Map([[headChar + onlyTail, onBranch]]) as ICharTrie;
+	return new Map([[headChar + onlyTail, onBranch]]) as CharTrie;
+}
+
+/** @borrows buildUnique as build */
+export function build(words: string[]): CharTrie {
+	const uniqueWords = [...new Set(words)];
+	// eslint-disable-next-line @typescript-eslint/no-use-before-define
+	return buildUnique(uniqueWords);
 }
 
 /**
@@ -45,7 +52,7 @@ function mergeGroups(headChar: Char, tailGroup: ICharTrie): ICharTrie {
  * @param words A list of words to parse
  * @returns A trie of words grouped by the initial characters they share
  */
-function buildUnique(words: string[]): ICharTrie {
+function buildUnique(words: string[]): CharTrie {
 	if (words.length === 0) {
 		return leafNode;
 	}
@@ -56,7 +63,7 @@ function buildUnique(words: string[]): ICharTrie {
 		// End of the target word reached. Include an empty string to signify that
 		// a word ends at this spot, and group any remaining words in the trie.
 		const nonEmptyWords = words.filter(word => word !== '');
-		return new Map([['', leafNode], ...build(nonEmptyWords)]) as ICharTrie;
+		return new Map([['', leafNode], ...build(nonEmptyWords)]) as CharTrie;
 	}
 
 	// Begin a new trie containing all words starting with the same letter as wordToMatch
@@ -68,11 +75,5 @@ function buildUnique(words: string[]): ICharTrie {
 
 	const groupWithChildren = mergeGroups(charToMatch, tailsMatchedGrouped);
 
-	return new Map([...groupWithChildren, ...build(wordsMissed)]) as ICharTrie;
-}
-
-/** @borrows buildUnique as build */
-export function build(words: string[]): ICharTrie {
-	const uniqueWords = [...new Set(words)];
-	return buildUnique(uniqueWords);
+	return new Map([...groupWithChildren, ...build(wordsMissed)]) as CharTrie;
 }

src/utils/wordList.spec.ts

@@ -1,6 +1,6 @@
 import { parseString, WhitespaceHandling } from './wordList';
 
-interface ITestCase {
+interface TestCase {
 	delimiter: string;
 	inputString: string;
 }
@@ -9,7 +9,7 @@ const { Preserve, TrimLeadingAndTrailing } = WhitespaceHandling;
 
 describe('parseString', () => {
 	it('returns an empty array when input string is empty', () => {
-		function testInput(input: string) {
+		function testInput(input: string): void {
 			const wordList = parseString(input, ',', Preserve);
 			expect(wordList).toEqual([]);
 		}
@@ -18,7 +18,7 @@ describe('parseString', () => {
 	});
 
 	it('returns entire input string in array when delimiter is empty', () => {
-		function testDelimiter(delimiter: string) {
+		function testDelimiter(delimiter: string): void {
 			const wordList = parseString(' some input string ', delimiter, Preserve);
 			expect(wordList).toEqual([' some input string ']);
 		}
@@ -27,7 +27,7 @@ describe('parseString', () => {
 	});
 
 	it('returns entire input string in array when delimiter is not present in input string', () => {
-		function testDelimiter(delimiter: string) {
+		function testDelimiter(delimiter: string): void {
 			const wordList = parseString(' some input string ', delimiter, Preserve);
 			expect(wordList).toEqual([' some input string ']);
 		}
@@ -37,13 +37,13 @@ describe('parseString', () => {
 
 	it('splits input string by delimiter', () => {
 		const expectedResult = ['foo', 'Bar', ' b@z '];
-		const testCases: ITestCase[] = [
+		const testCases: TestCase[] = [
 			{ delimiter: ',', inputString: 'foo,Bar, b@z ' },
 			{ delimiter: '\t', inputString: 'foo	Bar	 b@z ' },
 			{ delimiter: 'aaa', inputString: 'fooaaaBaraaa b@z ' },
 		];
 
-		function testSplit({ delimiter, inputString }: ITestCase) {
+		function testSplit({ delimiter, inputString }: TestCase): void {
 			const wordList = parseString(inputString, delimiter, Preserve);
 			expect(wordList).toEqual(expectedResult);
 		}
@@ -53,12 +53,12 @@ describe('parseString', () => {
 
 	it('splits input string by whitespace delimiter', () => {
 		const expectedResult = ['foo', 'Bar', 'b@z', ''];
-		const testCases: ITestCase[] = [
+		const testCases: TestCase[] = [
 			{ delimiter: ' ', inputString: 'foo Bar b@z ' },
 			{ delimiter: '  ', inputString: 'foo  Bar  b@z  ' },
 		];
 
-		function testSplit({ delimiter, inputString }: ITestCase) {
+		function testSplit({ delimiter, inputString }: TestCase): void {
 			const wordList = parseString(inputString, delimiter, Preserve);
 			expect(wordList).toEqual(expectedResult);
 		}