feat: migrate from TSLint to ESLint (#217)

Author: ybiquitous

index.ts

@@ -1,9 +1,9 @@
-type Options = {
+interface Options {
   elementDelimiter: string;
   modifierDelimiter: string;
   namespace: string | string[];
   namespaceDelimiter: string;
-};
+}
 
 type PartialOptions = Partial<Options>;
 
@@ -19,7 +19,7 @@ export function setup({
   modifierDelimiter,
   namespace,
   namespaceDelimiter,
-}: PartialOptions) {
+}: PartialOptions): void {
   if (elementDelimiter) {
     defaultOptions.elementDelimiter = elementDelimiter;
   }
@@ -34,11 +34,13 @@ export function setup({
   }
 }
 
-type Modifiers = {
+interface Modifiers {
   [key: string]: boolean | null | undefined;
-};
+}
+
+type BemBlockFunction = (elementOrModifiers?: string | Modifiers, modifiers?: Modifiers) => string;
 
-export default function bem(block: string, options: PartialOptions = {}) {
+export default function bem(block: string, options: PartialOptions = {}): BemBlockFunction {
   const { elementDelimiter, modifierDelimiter, namespace, namespaceDelimiter } = {
     ...defaultOptions,
     ...options,
@@ -51,7 +53,7 @@ export default function bem(block: string, options: PartialOptions = {}) {
 
   const baseBlock = `${namespaces}${block}`;
 
-  return function bemBlock(elementOrModifiers?: string | Modifiers, modifiers?: Modifiers) {
+  return function bemBlock(elementOrModifiers, modifiers) {
     let base = baseBlock;
 
     if (!elementOrModifiers) {

package-lock.json

@@ -27,7 +27,7 @@
     "test": "nyc tape -r ts-node/register test.ts",
     "test:coverage": "nyc report --reporter=html && opn coverage/index.html",
     "test:coverage:report": "nyc report --reporter=lcov && npx codecov",
-    "lint:ts": "tslint -p tsconfig.test.json",
+    "lint:ts": "eslint --ignore-path .gitignore --ext .ts .",
     "lint:ts:fix": "prettier --write \"**/*.ts\" && npm run lint:ts -- --fix",
     "lint:md": "remark . --frail",
     "lint:md:fix": "remark . --output",
@@ -41,14 +41,15 @@
   },
   "devDependencies": {
     "@types/tape": "^4.2.33",
+    "@typescript-eslint/eslint-plugin": "^1.4.2",
+    "eslint": "^5.14.1",
+    "eslint-config-prettier": "^4.0.0",
     "nyc": "^13.3.0",
     "opn-cli": "^4.0.0",
     "rimraf": "^2.6.3",
     "tape": "^4.10.1",
     "terser": "^3.16.1",
     "ts-node": "^8.0.2",
-    "tslint": "^5.13.0",
-    "tslint-config-prettier": "^1.18.0",
     "typescript": "^3.3.3333",
     "ybiq": "^7.3.0"
   },
@@ -61,7 +62,7 @@
   "lint-staged": {
     "linters": {
       "*.ts": [
-        "tslint --fix",
+        "eslint --ext .ts --fix",
         "git add"
       ],
       "*.md": [
@@ -152,5 +153,12 @@
         ]
       ]
     }
+  },
+  "eslintConfig": {
+    "extends": [
+      "plugin:@typescript-eslint/recommended",
+      "prettier",
+      "prettier/@typescript-eslint"
+    ]
   }
 }

package.json

@@ -1,3 +1,4 @@
 linter:
-  tslint:
+  eslint:
     npm_install: "development"
+    ext: ".ts"