add eslint settings

Author: gfx

.eslintrc.js

@@ -0,0 +1,45 @@
+module.exports = {
+  extends: [
+    // https://eslint.org/docs/rules/
+    "eslint:recommended",
+    // https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/src/configs/recommended.json
+    "plugin:@typescript-eslint/recommended",
+    // https://prettier.io/docs/en/eslint.html
+    "plugin:prettier/recommended",
+  ],
+  // https://reactjs.org/docs/hooks-rules.html
+  plugins: [],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    project: "./tsconfig.json",
+  },
+  settings: {},
+  rules: {
+    "no-undef": "off", // useless in TypeScript
+    "no-constant-condition": ["warn", { checkLoops: false }],
+    "no-useless-escape": "warn",
+    "no-console": "warn",
+
+    "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_|^intl$" }],
+    "@typescript-eslint/array-type": ["error", "generic"],
+    "@typescript-eslint/camelcase": "warn",
+    "@typescript-eslint/class-name-casing": "warn", // to allow the initial underscore
+    "@typescript-eslint/no-non-null-assertion": "warn", // NOTE: pay attention to it because it may cause unexpected behavior
+    "@typescript-eslint/prefer-for-of": "warn",
+    "@typescript-eslint/prefer-includes": "warn",
+    "@typescript-eslint/prefer-string-starts-ends-with": "warn",
+    "@typescript-eslint/no-use-before-define": "warn",
+
+    "@typescript-eslint/indent": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-member-accessibility": "off",
+    "@typescript-eslint/no-object-literal-type-assertion": "off",
+    "@typescript-eslint/no-empty-interface": "off",
+    "@typescript-eslint/no-parameter-properties": "off",
+    "@typescript-eslint/no-var-requires": "off", // not a part of ECMA-262
+    "@typescript-eslint/prefer-interface": "off",
+
+    "prettier/prettier": "warn",
+  },
+};

package.json

@@ -9,6 +9,8 @@
     "prepublishOnly": "TEST_DIST=true npm run test",
     "test": "TS_NODE_FILES=true mocha 'test/**/*.test.ts'",
     "test:cover": "TS_NODE_FILES=true npx nyc mocha 'test/**/*.test.ts'",
+    "lint": "eslint --ext .ts src test",
+    "lint:fix": "eslint --fix --ext .ts src test && npm run format",
     "format": "prettier --write 'src/**/*.ts' 'test/**/*.ts'",
     "profile:encode": "rm -f isolate-*.log ; node --prof --require ts-node/register  -e 'require(\"./benchmark/profile-encode\")' && node --prof-process --preprocess -j isolate-*.log | npx flamebearer",
     "profile:decode": "rm -f isolate-*.log ; node --prof --require ts-node/register  -e 'require(\"./benchmark/profile-decode\")' && node --prof-process --preprocess -j isolate-*.log | npx flamebearer",
@@ -32,6 +34,11 @@
   "devDependencies": {
     "@types/mocha": "^5.2.6",
     "@types/node": "^11.13.8",
+    "@typescript-eslint/eslint-plugin": "^1.7.0",
+    "@typescript-eslint/parser": "^1.7.0",
+    "eslint": "^5.16.0",
+    "eslint-config-prettier": "^4.2.0",
+    "eslint-plugin-prettier": "^3.0.1",
     "ieee754": "^1.1.13",
     "mocha": "^6.1.4",
     "msgpack-lite": "^0.1.26",

test/msgpack-test-suite.test.ts

@@ -91,7 +91,7 @@ describe("msgpack-test-suite", () => {
     const SPECS = {
       FLOAT64_POSITIVE_INF: Number.POSITIVE_INFINITY,
       FLOAT64_NEGATIVE_INF: Number.NEGATIVE_INFINITY,
-      FLOAT64_NaN: Number.NaN,
+      FLOAT64_NAN: Number.NaN,
       STR16: "x".repeat(0x100),
       STR32: "x".repeat(0x10000),
       BIN16: new Uint8Array(0x100).fill(0xff),