feat: Support TypeScript (#93)

* add @typescript-eslint/eslint-plugin

* add typescript into devDeps and peerDeps

* add lib/typescript and presets/typescript

* update typescript-eslint rules

* add preset/typescript-prettier and preset/typescript-node-prettier

* add presets/react-typescript-prettier

* tweak presets and rules

* Add tsconfig.json only for testing TypeScript rules

* add tests for lib/typescript

* add tests for lib/react-typescript

* add tests for presets/node-typescript-prettier

* add tests for presets/react-typescript-prettier

* add tests for presets/react-typescript

* add tests for presets/typescript-prettier

* disable `no-useless-constructor` in lib/typescript

* add tests for presets/typescript

* fix file name

* add typescript preset for README.md

* chore updat README

* set timeout option for mocha

Author: koba04

README.md

@@ -73,70 +73,21 @@ module.exports = {
 
 ## Support rule set
 
-### `@cybozu`
-
-This rule set is a basic rules for Cybozu, which supports ES2017 and parse your sources as Modules.
-
-```js
-module.exports = {
-  extends: "@cybozu"
-};
-```
-
-### `@cybozu/eslint-config/node`
-
-This rule set is for projects running on a Node environment.
-
-```js
-module.exports = {
-  extends: "@cybozu/eslint-config/presets/node"
-};
-```
-
-### [Experimental] `@cybozu/eslint-config/presets/react`
-
-This rule set is for projects using React, which has JSX support and rules related React provided by `eslint-plugin-react` and `eslint-plugin-jsx-ally`.
-This rule set includes `@cybozu`.
-
-```js
-module.exports = {
-  extends: "@cybozu/eslint-config/presets/react"
-};
-```
-
-If you use React and Flow we recommend to use `@cybozu/eslint-config/react-flowtype` instead.
-
-### [Experimental] `@cybozu/eslint-config/presets/flowtype`
-
-This rule set is for projects using Flow, which has Flow support, which is using `eslint-plugin-flowtype`.
-
-```js
-module.exports = {
-  extends: "@cybozu/eslint-config/presets/flowtype"
-};
-```
-
-If you use React and Flow we recommend to use `@cybozu/eslint-config/react-flowtype` instead.
-
-### [Experimental] `@cybozu/eslint-config/presets/react-flowtype`
-
-This rule set is for projects using React and Flow, which has Flow support in addition to `@cybozu/eslint-config/react`.
-
-```js
-module.exports = {
-  extends: "@cybozu/eslint-config/presets/react-flowtype"
-};
-```
-
-### `@cybozu/eslint-config/presets/es5`
-
-This rule set is for projects using ES5.
-
-```js
-module.exports = {
-  extends: "@cybozu/eslint-config/presets/es5"
-};
-```
+- `@cybozu`
+  - This is included in the all following presets
+- `@cybozu/eslint-config/presets/node`
+  - Including `eslint-plugin-node`
+- `@cybozu/eslint-config/presets/typescript`
+  - Including `@typescript-eslint/eslint-plugin`
+- `@cybozu/eslint-config/presets/react`
+  - Including `eslint-plugin-react` and `eslint-plugin-jsx-ally`
+- `@cybozu/eslint-config/presets/react-typescript`
+  - Including `@cybozu/eslint-config/presets/typescript` and `@cybozu/eslint-config/presets/react`
+- `@cybozu/eslint-config/presets/flowtype`
+  - Including `eslint-plugin-flowtype`
+- `@cybozu/eslint-config/presets/react-flowtype`
+  - Including `@cybozu/eslint-config/presets/react` and `eslint-plugin-flowtype`
+- `@cybozu/eslint-config/presets/es5`
 
 ## Prettier Support
 
@@ -146,7 +97,6 @@ Prettier is used widely for a code formatter for JavaScript.
 It's an opinionated tool but with Prettier, we don't have to discuss code styles in code review.
 (No more bikeshed)
 
-`@cybozu/eslint-config` has presets to support Prettier as an experimental.
 The presets disable all rules conflicting with Prettier and treat the difference as errors.
 You can fix the errors by `--fix` option so you don't have to fix the errors manually.
 
@@ -158,6 +108,9 @@ In order to this, you have to install `prettier` and choose a preset from the fo
 
 - `@cybozu/eslint-config/presets/prettier`
 - `@cybozu/eslint-config/presets/node-prettier`
+- `@cybozu/eslint-config/presets/node-typescript-prettier`
+- `@cybozu/eslint-config/presets/typescript-prettier`
+- `@cybozu/eslint-config/presets/react-typescript-prettier`
 - `@cybozu/eslint-config/presets/react-prettier`
 - `@cybozu/eslint-config/presets/react-flowtype-prettier`
 - `@cybozu/eslint-config/presets/es5-prettier`
@@ -175,3 +128,4 @@ module.exports = {
 ```
 
 We also provide `@cybozu/eslint-config/presets/kintone-customize-es5-prettier` to use it with `prettier`.
+

lib/node-typescript.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    "node/no-unsupported-features/es-syntax": "off"
+  }
+};

lib/prettier-typescript.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["prettier/@typescript-eslint"]
+};

lib/react-typescript.js

@@ -0,0 +1,5 @@
+module.exports = {
+  rules: {
+    "react/jsx-filename-extension": ["error", { extensions: [".tsx"] }]
+  }
+};

lib/react.js

@@ -44,6 +44,7 @@ module.exports = {
     "react/void-dom-elements-no-children": "error",
 
     "react/jsx-filename-extension": "error",
+
     // react/jsx-key
     // react/jsx-no-duplicate-props
     // react/jsx-no-target-blank

lib/typescript.js

@@ -0,0 +1,35 @@
+module.exports = {
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  extends: ["plugin:@typescript-eslint/recommended"],
+  parserOptions: {
+    project: "./tsconfig.json"
+  },
+  rules: {
+    "@typescript-eslint/array-type": ["error", "array-simple"],
+    "@typescript-eslint/no-for-in-array": "error",
+
+    "no-useless-constructor": "off",
+    "@typescript-eslint/no-useless-constructor": "warn",
+    "@typescript-eslint/type-annotation-spacing": "warn",
+    "@typescript-eslint/unified-signatures": "warn",
+    "@typescript-eslint/no-unnecessary-type-assertion": "warn",
+    "@typescript-eslint/indent": ["warn", 2, { SwitchCase: 1 }],
+
+    "@typescript-eslint/camelcase": "off",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/explicit-member-accessibility": "off",
+    "@typescript-eslint/interface-name-prefix": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/no-inferrable-types": "off",
+    // FIXME use NonNullable<T> instead
+    "@typescript-eslint/no-non-null-assertion": "off",
+    "@typescript-eslint/no-object-literal-type-assertion": "off",
+    "@typescript-eslint/no-triple-slash-reference": "off",
+    "@typescript-eslint/no-unused-vars": "off",
+    "@typescript-eslint/no-use-before-define": "off",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/prefer-interface": "off",
+    "@typescript-eslint/prefer-namespace-keyword": "off"
+  }
+};

package-lock.json

@@ -19,24 +19,28 @@
     "lint": "eslint **/*.js",
     "release": "npm-run-all -p lint test && standard-version",
     "release:dryrun": "standard-version --dry-run",
-    "test": "mocha"
+    "test": "mocha --timeout 5000"
   },
   "keywords": [
     "eslint"
   ],
   "author": "cybozu",
   "license": "MIT",
   "devDependencies": {
+    "@types/react": "^16.8.10",
     "eslint": "^5.15.3",
     "mocha": "^6.0.2",
     "npm-run-all": "^4.1.5",
     "prettier": "^1.16.4",
-    "standard-version": "^5.0.2"
+    "standard-version": "^5.0.2",
+    "typescript": "^3.3.4000"
   },
   "peerDependencies": {
-    "eslint": "^5.3.0"
+    "eslint": "^5.3.0",
+    "typescript": "^3.3.3333"
   },
   "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^1.5.0",
     "babel-eslint": "^9.0.0",
     "eslint-config-prettier": "^4.1.0",
     "eslint-plugin-flowtype": "^3.4.2",

package.json

@@ -0,0 +1,10 @@
+module.exports = {
+  extends: [
+    "../lib/base.js",
+    "../lib/node.js",
+    "../lib/typescript.js",
+    "../lib/node-typescript.js",
+    "../lib/prettier.js",
+    "../lib/prettier-typescript.js"
+  ]
+};

presets/node-typescript-prettier.js

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: [
+    "../lib/base.js",
+    "../lib/react.js",
+    "../lib/react-typescript.js",
+    "../lib/typescript.js",
+    "../lib/prettier.js",
+    "../lib/prettier-react.js",
+    "../lib/prettier-typescript.js"
+  ]
+};