feat: Add module eslint-config-zillow-typescript

Author: evocateur

package-lock.json

@@ -13,7 +13,7 @@
     "lint:rules:jest": "eslint-find-rules --unused packages/eslint-config-zillow-base/jest.js --no-core",
     "lint:rules:main": "eslint-find-rules --unused packages/eslint-config-zillow/index.js",
     "lint:rules:mocha": "eslint-find-rules --unused packages/eslint-config-zillow-base/mocha.js --no-core",
-    "lint:rules:typescript": "eslint-find-rules --unused packages/eslint-config-zillow-base/typescript.js --no-core",
+    "lint:rules:typescript": "eslint-find-rules --unused packages/eslint-config-zillow-typescript/index.js --no-core",
     "lint:prettier": "eslint --print-config packages/eslint-config-zillow/index.js | eslint-config-prettier-check",
     "pretest": "lerna run prepare --loglevel error && npm run --silent lint",
     "test": "jest",
@@ -121,6 +121,7 @@
     "babel-preset-zillow": "file:packages/babel-preset-zillow",
     "eslint-config-zillow": "file:packages/eslint-config-zillow",
     "eslint-config-zillow-base": "file:packages/eslint-config-zillow-base",
+    "eslint-config-zillow-typescript": "file:packages/eslint-config-zillow-typescript",
     "eslint-plugin-zillow": "file:packages/eslint-plugin-zillow",
     "prettier-config-zillow": "file:packages/prettier-config-zillow",
     "zillow-browser-shims": "file:packages/zillow-browser-shims",

package.json

@@ -0,0 +1,4 @@
+# override root to minimize conflicts with upstream
+
+[*.js]
+indent_size = 2

packages/eslint-config-zillow-typescript/.editorconfig

@@ -0,0 +1,3 @@
+---
+  rules:
+    prettier/prettier: [error, { tabWidth: 2 }]

packages/eslint-config-zillow-typescript/.eslintrc.yaml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Zillow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/eslint-config-zillow-typescript/LICENSE.md

@@ -0,0 +1,62 @@
+# eslint-config-zillow-typescript
+
+> Zillow's ESLint config for TypeScript, following our code conventions
+
+[![npm version](https://img.shields.io/npm/v/eslint-config-zillow-typescript.svg)](https://www.npmjs.com/package/eslint-config-zillow-typescript)
+[![Build Status](https://travis-ci.org/zillow/javascript.svg?branch=latest)](https://travis-ci.org/zillow/javascript)
+
+## Usage
+
+Note: Unlike other Zillow eslint config plugins, this module is designed to be used in tandem with another extended config such as [eslint-config-zillow](https://npmjs.com/eslint-config-zillow).
+
+To install with all necessary `peerDependencies`, use [install-peerdeps](https://github.com/nathanhleung/install-peerdeps#usage):
+
+```sh
+npx install-peerdeps --dev eslint-config-zillow eslint-config-zillow-typescript
+```
+
+All exported configs should be added to your [ESlint configuration file](https://eslint.org/docs/user-guide/configuring#extending-configuration-files) `extends`.
+For example, in a JSON `.eslintrc`:
+
+```json
+{
+  "extends": ["zillow", "zillow-typescript"]
+}
+```
+
+### Project Config
+
+All flavors of this config expect your `tsconfig.json` to be in the current working directory (relative to your eslint config), which is extremely common. If it is elsewhere (say, a monorepo leaf), you will need to override various [`parserOptions`](https://github.com/typescript-eslint/typescript-eslint/blob/master/docs/getting-started/linting/TYPED_LINTING.md):
+
+```js
+// .eslintrc.js
+module.exports = {
+  extends: ['zillow', 'zillow-typescript'],
+  parserOptions: {
+    tsconfigRootDir: __dirname,
+    project: ['./tsconfig.eslint.json', './packages/*/tsconfig.json'],
+  },
+};
+```
+
+### `prettier` Editor Plugin Integration
+
+Unfortunately, super-useful editor plugins like `prettier-atom` and `prettier-vscode` do not load Prettier settings from ESLint config, which is where we load our Prettier options from. To workaround this, add a `.prettierrc.js` or `prettier.config.js` file to your repo root with the following content:
+
+```js
+module.exports = require('prettier-config-zillow');
+```
+
+## Related
+
+  - [Zillow's overarching ESLint config](https://npmjs.com/eslint-config-zillow)
+  - [Zillow's Prettier config](https://npmjs.com/prettier-config-zillow)
+  - [Zillow's Javascript code conventions](https://github.com/zillow/javascript)
+
+## Development
+
+Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?
+
+You can run tests (from the repo root) with `npm test`.
+
+You can make sure this module lints with itself using `npm run lint` (from the repo root).

packages/eslint-config-zillow-typescript/README.md

@@ -0,0 +1,22 @@
+module.exports = {
+  extends: [
+    './rules/prettier',
+    './rules/eslint-recommended',
+    './rules/recommended',
+    './rules/recommended-requiring-type-checking',
+    './rules/all-remaining',
+    './rules/other-plugin-overrides',
+  ].map(require.resolve),
+
+  parser: require.resolve('@typescript-eslint/parser'),
+
+  parserOptions: {
+    ecmaVersion: 2018,
+    sourceType: 'module',
+    project: ['./tsconfig.json'],
+  },
+
+  plugins: ['@typescript-eslint'],
+
+  rules: {},
+};

packages/eslint-config-zillow-typescript/index.js

@@ -0,0 +1,43 @@
+{
+  "name": "eslint-config-zillow-typescript",
+  "version": "0.0.0-alpha.0",
+  "description": "Zillow's ESLint config for TypeScript, following our code conventions",
+  "main": "index.js",
+  "files": [
+    "index.js",
+    "prettier.config.js",
+    "rules"
+  ],
+  "scripts": {
+    "test": "echo \"Run tests from root\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zillow/javascript"
+  },
+  "keywords": [
+    "eslint",
+    "eslintconfig",
+    "config",
+    "zillow",
+    "typescript",
+    "code conventions"
+  ],
+  "author": "Daniel Stockman <[email protected]> (https://twitter.com/@evocateur)",
+  "license": "MIT",
+  "homepage": "https://github.com/zillow/javascript/tree/latest/packages/eslint-config-zillow-typescript#readme",
+  "engines": {
+    "node": ">= 10.17"
+  },
+  "peerDependencies": {
+    "@typescript-eslint/eslint-plugin": "^4.2.0",
+    "@typescript-eslint/parser": "^4.2.0",
+    "eslint": ">=7.0.0",
+    "eslint-plugin-prettier": "^3.1.4",
+    "prettier": "^2.1.2",
+    "typescript": "^4.0.3"
+  },
+  "dependencies": {
+    "prettier-config-zillow": "file:../prettier-config-zillow"
+  }
+}

packages/eslint-config-zillow-typescript/package.json

@@ -0,0 +1 @@
+module.exports = require('prettier-config-zillow');