typescript-eslint · JamesHenry · Jan 17, 2019 · Jan 17, 2019 · Dec 28, 2016 · Dec 28, 2016
diff --git a/.github/ISSUE_TEMPLATE/eslint-plugin-tslint.md b/.github/ISSUE_TEMPLATE/eslint-plugin-tslint.md
@@ -0,0 +1,26 @@
+---
+name: eslint-plugin-tslint
+about: Report an issue with the eslint-plugin-tslint package
+---
+
+**What version of Node.js and npm are you using?**
+
+- Node: <!-- Please fill in -->
+- npm: <!-- Please fill in -->
+
+**What version of the following packages are you using?**
+
+- eslint-plugin-tslint: <!-- Please fill in -->
+- @typescript-eslint/parser: <!-- Please fill in -->
+- TypeScript: <!-- Please fill in -->
+- ESLint: <!-- Please fill in -->
+
+**What code were you trying to parse?**
+
+```ts
+// Please put code here
+```
+
+**What did you expect to happen?**
+
+**What actually happened?**
diff --git a/README.md b/README.md
@@ -28,8 +28,6 @@ This repo contains several packages which allow ESLint users to lint their TypeS
 
 - `eslint-plugin-tslint` - An ESLint-specific plugin which runs an instance of TSLint within your ESLint setup to allow for users to more easily migrate from TSLint to ESLint.
 
-  - PENDING MIGRATION TO MONOREPO
-
 ## Supported TypeScript Version
 
 We will always endeavor to support the latest stable version of TypeScript.

diff --git a/package.json b/package.json
@@ -11,10 +11,10 @@
     "url": "https://github.com/typescript-eslint/typescript-eslint/issues"
   },
   "scripts": {
-    "postinstall": "lerna bootstrap && lerna link",
-    "test": "lerna run test",
+    "postinstall": "lerna bootstrap && yarn build && lerna link",
+    "test": "lerna run test --parallel",
     "build": "lerna run build",
-    "clean": "lerna run clean",
+    "clean": "lerna clean && lerna run clean",
     "precommit": "yarn test && lint-staged",
     "cz": "git-cz",
     "commitmsg": "commitlint -E GIT_PARAMS",

diff --git a/packages/eslint-plugin-tslint/CHANGELOG.md b/packages/eslint-plugin-tslint/CHANGELOG.md
@@ -0,0 +1,27 @@
+# [3.1.0](https://github.com/JamesHenry/eslint-plugin-tslint/compare/v3.0.0...v3.1.0) (2018-10-19)
+
+### Bug Fixes
+
+- Tiny lint note elimination ([a731838](https://github.com/JamesHenry/eslint-plugin-tslint/commit/a731838))
+
+### Features
+
+- Support for tslint property ([18a4afb](https://github.com/JamesHenry/eslint-plugin-tslint/commit/18a4afb)), closes [#40](https://github.com/JamesHenry/eslint-plugin-tslint/issues/40)
+
+# [3.0.0](https://github.com/JamesHenry/eslint-plugin-tslint/compare/v2.1.0...v3.0.0) (2018-09-09)
+
+### Bug Fixes
+
+- Fixed bug when file not defined in tsconfig ([20b498b](https://github.com/JamesHenry/eslint-plugin-tslint/commit/20b498b))
+- Pass sourceText parameter to service getSource ([dd4c2f8](https://github.com/JamesHenry/eslint-plugin-tslint/commit/dd4c2f8))
+- Update program when sourceFile was updated ([0fe933c](https://github.com/JamesHenry/eslint-plugin-tslint/commit/0fe933c))
+- Updated typescript-service dependency ([2f4f434](https://github.com/JamesHenry/eslint-plugin-tslint/commit/2f4f434))
+
+### Features
+
+- **core:** Added support rules requires type information ([6bc1deb](https://github.com/JamesHenry/eslint-plugin-tslint/commit/6bc1deb)), closes [#32](https://github.com/JamesHenry/eslint-plugin-tslint/issues/32) [#34](https://github.com/JamesHenry/eslint-plugin-tslint/issues/34)
+- Post merge adapdation from tslint2 repository ([477c656](https://github.com/JamesHenry/eslint-plugin-tslint/commit/477c656)), closes [#32](https://github.com/JamesHenry/eslint-plugin-tslint/issues/32) [#34](https://github.com/JamesHenry/eslint-plugin-tslint/issues/34)
+
+### BREAKING CHANGES
+
+- New dependency
diff --git a/packages/eslint-plugin-tslint/LICENSE b/packages/eslint-plugin-tslint/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 James Henry
+
+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.
diff --git a/packages/eslint-plugin-tslint/README.md b/packages/eslint-plugin-tslint/README.md
@@ -0,0 +1,49 @@
+# ESLint Plugin TSLint
+
+[![Travis](https://img.shields.io/travis/JamesHenry/eslint-plugin-tslint.svg?style=flat-square)](https://travis-ci.org/JamesHenry/eslint-plugin-tslint)
+[![GitHub license](https://img.shields.io/npm/l/eslint-plugin-tslint.svg?style=flat-square)](https://github.com/JamesHenry/eslint-plugin-tslint/blob/master/LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/eslint-plugin-tslint.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-tslint)
+[![NPM Downloads](https://img.shields.io/npm/dt/eslint-plugin-tslint.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-tslint)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=flat-square)](https://github.com/semantic-release/semantic-release)
+[![greenkeeper.io](https://badges.greenkeeper.io/JamesHenry/mongoose-schema-to-typescript-interface.svg?style=flat-square)](https://greenkeeper.io)
+
+ESLint plugin wraps a TSLint configuration and lints the whole source using TSLint.
+
+## INSTALL
+
+```
+npm i -D eslint-plugin-tslint
+```
+
+## USAGE
+
+Configure in your eslint config file:
+
+```
+"plugins": [
+    "tslint"
+],
+"rules": {
+    "tslint/config": ["warn", {
+        lintFile: '/* path to tslint.json of your project */',
+        rules: { /* tslint rules (will be used if `lintFile` is not specified) */ },
+        rulesDirectory: [ /* array of paths to directories with rules, e.g. 'node_modules/tslint/lib/rules' (will be used if `lintFile` is not specified) */ ]
+    }],
+}
+```
+
+## RULES
+
+Plugin contains only single rule `tslint/config`.
+
+## EXAMPLES
+
+- [unlight/node-package-starter/.eslintrc.js](https://github.com/unlight/node-package-starter/blob/master/.eslintrc.js)
+
+### TSLint Plugins
+
+- https://github.com/Glavin001/tslint-clean-code
+- https://github.com/Microsoft/tslint-microsoft-contrib
+- https://github.com/SonarSource/SonarTS
+- https://github.com/ajafff/tslint-consistent-codestyle
diff --git a/packages/eslint-plugin-tslint/jest.config.js b/packages/eslint-plugin-tslint/jest.config.js
@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = {
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest'
+  },
+  testRegex: './tests/.+\\.spec\\.ts$',
+  collectCoverage: false,
+  collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  coverageReporters: ['text-summary', 'lcov']
+};
diff --git a/packages/eslint-plugin-tslint/package.json b/packages/eslint-plugin-tslint/package.json
@@ -0,0 +1,40 @@
+{
+  "name": "eslint-plugin-tslint",
+  "version": "3.1.0",
+  "main": "dist/index.js",
+  "typings": "src/index.ts",
+  "author": "James Henry <typescript-eslint@jameshenry.blog>",
+  "contributors": [
+    "Roman Vasilev (https://github.com/unlight)"
+  ],
+  "description": "TSLint wrapper plugin for ESLint",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "tslint"
+  ],
+  "repository": "typescript-eslint/typescript-eslint",
+  "bugs": {
+    "url": "https://github.com/typescript-eslint/typescript-eslint/issues"
+  },
+  "license": "MIT",
+  "scripts": {
+    "test": "jest --coverage",
+    "prebuild": "npm run clean",
+    "build": "tsc",
+    "clean": "rm -rf dist/"
+  },
+  "dependencies": {
+    "lodash.memoize": "^4.1.2"
+  },
+  "peerDependencies": {
+    "tslint": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/eslint": "^4.16.3",
+    "@types/lodash.memoize": "^4.1.4",
+    "@typescript-eslint/parser": "21.0.2",
+    "tslint": "^5.11.0"
+  }
+}
diff --git a/packages/eslint-plugin-tslint/src/custom-linter.ts b/packages/eslint-plugin-tslint/src/custom-linter.ts
@@ -0,0 +1,19 @@
+import { ILinterOptions, Linter, LintResult } from 'tslint';
+import { Program } from 'typescript';
+
+const TSLintLinter = Linter as any;
+
+export class CustomLinter extends TSLintLinter {
+  constructor(options: ILinterOptions, private program: Program) {
+    super(options, program);
+  }
+
+  getResult(): LintResult {
+    return super.getResult();
+  }
+
+  getSourceFile(fileName: string) {
+    const result = this.program.getSourceFile(fileName);
+    return result;
+  }
+}
diff --git a/packages/eslint-plugin-tslint/src/index.ts b/packages/eslint-plugin-tslint/src/index.ts
@@ -0,0 +1,168 @@
+import { Rule } from 'eslint';
+import memoize from 'lodash.memoize';
+import { Configuration, RuleSeverity } from 'tslint';
+import { Program } from 'typescript';
+import { CustomLinter } from './custom-linter';
+
+//------------------------------------------------------------------------------
+// Plugin Definition
+//------------------------------------------------------------------------------
+
+/**
+ * @todo share types between packages
+ */
+interface ParserServices {
+  program: Program | undefined;
+  esTreeNodeToTSNodeMap: WeakMap<object, any> | undefined;
+  tsNodeToESTreeNodeMap: WeakMap<object, any> | undefined;
+}
+
+type RawRuleConfig =
+  | null
+  | undefined
+  | boolean
+  | any[]
+  | {
+      severity?: RuleSeverity | 'warn' | 'none' | 'default';
+      options?: any;
+    };
+
+interface RawRulesConfig {
+  [key: string]: RawRuleConfig;
+}
+
+/**
+ * Construct a configFile for TSLint
+ */
+const tslintConfig = memoize(
+  (
+    lintFile: string,
+    tslintRules: RawRulesConfig,
+    tslintRulesDirectory: string[]
+  ) => {
+    if (lintFile != null) {
+      return Configuration.loadConfigurationFromPath(lintFile);
+    }
+    return Configuration.parseConfigFile({
+      rules: tslintRules || {},
+      rulesDirectory: tslintRulesDirectory || []
+    });
+  },
+  (lintFile: string | undefined, tslintRules = {}, tslintRulesDirectory = []) =>
+    `${lintFile}_${Object.keys(tslintRules).join(',')}_${
+      tslintRulesDirectory.length
+    }`
+);
+
+export const rules = {
+  /**
+   * Expose a single rule called "config", which will be accessed in the user's eslint config files
+   * via "tslint/config"
+   */
+  config: {
+    meta: {
+      docs: {
+        description:
+          'Wraps a TSLint configuration and lints the whole source using TSLint',
+        category: 'TSLint'
+      },
+      schema: [
+        {
+          type: 'object',
+          properties: {
+            rules: {
+              type: 'object',
+              /**
+               * No fixed schema properties for rules, as this would be a permanently moving target
+               */
+              additionalProperties: true
+            },
+            rulesDirectory: {
+              type: 'array',
+              items: {
+                type: 'string'
+              }
+            },
+            lintFile: {
+              type: 'string'
+            }
+          },
+          additionalProperties: false
+        }
+      ]
+    },
+    create: function(context: Rule.RuleContext) {
+      const fileName = context.getFilename();
+      const sourceCode = context.getSourceCode().text;
+      const parserServices: ParserServices | undefined = context.parserServices;
+
+      /**
+       * The user needs to have configured "project" in their parserOptions
+       * for @typescript-eslint/parser
+       */
+      if (!parserServices || !parserServices.program) {
+        throw new Error(
+          `You must provide a value for the "parserOptions.project" property for @typescript-eslint/parser`
+        );
+      }
+
+      /**
+       * The TSLint rules configuration passed in by the user
+       */
+      const {
+        rules: tslintRules,
+        rulesDirectory: tslintRulesDirectory,
+        lintFile
+      } = context.options[0];
+
+      const program: Program = parserServices.program;
+
+      /**
+       * Create an instance of TSLint
+       * Lint the source code using the configured TSLint instance, and the rules which have been
+       * passed via the ESLint rule options for this rule (using "tslint/config")
+       */
+      const tslintOptions = {
+        formatter: 'json',
+        fix: false
+      };
+      const tslint = new CustomLinter(tslintOptions, program);
+      const configuration = tslintConfig(
+        lintFile,
+        tslintRules,
+        tslintRulesDirectory
+      );
+      tslint.lint(fileName, sourceCode, configuration);
+
+      const result = tslint.getResult();
+
+      /**
+       * Format the TSLint results for ESLint
+       */
+      if (result.failures && result.failures.length) {
+        result.failures.forEach(failure => {
+          const start = failure.getStartPosition().getLineAndCharacter();
+          const end = failure.getEndPosition().getLineAndCharacter();
+          context.report({
+            message: `${failure.getFailure()} (tslint:${failure.getRuleName()})`,
+            loc: {
+              start: {
+                line: start.line + 1,
+                column: start.character
+              },
+              end: {
+                line: end.line + 1,
+                column: end.character
+              }
+            }
+          });
+        });
+      }
+
+      /**
+       * Return an empty object for the ESLint rule
+       */
+      return {};
+    }
+  }
+};