From 1de278ffa84b7c63397009439fa48cdee72ee51b Mon Sep 17 00:00:00 2001
From: Kanitkorn S <k.sujautra@gmail.com>
Date: Mon, 4 Feb 2019 01:24:13 +0900
Subject: [PATCH] feat(eslint-plugin): add new rule no-require-imports

Adds the equivalent of TSLint's [`no-require-imports`](https://palantir.github.io/tslint/rules/no-require-imports/) rule.
---
 packages/eslint-plugin/README.md              |  1 +
 packages/eslint-plugin/ROADMAP.md             |  7 +-
 .../docs/rules/no-require-imports.md          | 34 ++++++++
 .../lib/rules/no-require-imports.js           | 50 ++++++++++++
 .../tests/lib/rules/no-require-imports.js     | 81 +++++++++++++++++++
 5 files changed, 170 insertions(+), 3 deletions(-)
 create mode 100644 packages/eslint-plugin/docs/rules/no-require-imports.md
 create mode 100644 packages/eslint-plugin/lib/rules/no-require-imports.js
 create mode 100644 packages/eslint-plugin/tests/lib/rules/no-require-imports.js

diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md
index 1ec6df216048..7e72867c1375 100644
--- a/packages/eslint-plugin/README.md
+++ b/packages/eslint-plugin/README.md
@@ -118,6 +118,7 @@ Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-pre
 | [`@typescript-eslint/no-non-null-assertion`](./docs/rules/no-non-null-assertion.md)                       | Disallows non-null assertions using the `!` postfix operator (`no-non-null-assertion` from TSLint)                                                  | :heavy_check_mark: |          |
 | [`@typescript-eslint/no-object-literal-type-assertion`](./docs/rules/no-object-literal-type-assertion.md) | Forbids an object literal to appear in a type assertion expression (`no-object-literal-type-assertion` from TSLint)                                 | :heavy_check_mark: |          |
 | [`@typescript-eslint/no-parameter-properties`](./docs/rules/no-parameter-properties.md)                   | Disallow the use of parameter properties in class constructors. (`no-parameter-properties` from TSLint)                                             | :heavy_check_mark: |          |
+| [`@typescript-eslint/no-require-imports`](./docs/rules/no-require-imports.md)                             | Disallows invocation of `require()` (`no-require-imports` from TSLint)                                                                              | :heavy_check_mark: |          |
 | [`@typescript-eslint/no-this-alias`](./docs/rules/no-this-alias.md)                                       | Disallow aliasing `this` (`no-this-assignment` from TSLint)                                                                                         |                    |          |
 | [`@typescript-eslint/no-triple-slash-reference`](./docs/rules/no-triple-slash-reference.md)               | Disallow `/// <reference path="" />` comments (`no-reference` from TSLint)                                                                          | :heavy_check_mark: |          |
 | [`@typescript-eslint/no-type-alias`](./docs/rules/no-type-alias.md)                                       | Disallow the use of type aliases (`interface-over-type-literal` from TSLint)                                                                        |                    |          |
diff --git a/packages/eslint-plugin/ROADMAP.md b/packages/eslint-plugin/ROADMAP.md
index bd0480101cf1..2e3b152d9416 100644
--- a/packages/eslint-plugin/ROADMAP.md
+++ b/packages/eslint-plugin/ROADMAP.md
@@ -1,10 +1,10 @@
 # Roadmap
 
-✅ (29) = done<br>
+✅ (30) = done<br>
 🌟 (79) = in ESLint core<br>
 🔌 (33) = in another plugin<br>
 🌓 (16) = implementations differ or ESLint version is missing functionality<br>
-🛑 (68) = unimplemented
+🛑 (67) = unimplemented
 
 ## TSLint rules
 
@@ -114,7 +114,7 @@
 | [`no-default-export`]        | 🔌  | [`import/no-default-export`]                       |
 | [`no-duplicate-imports`]     | 🔌  | [`import/no-duplicates`]                           |
 | [`no-mergeable-namespace`]   | 🛑  | N/A                                                |
-| [`no-require-imports`]       | 🛑  | N/A                                                |
+| [`no-require-imports`]       | ✅  | [`@typescript-eslint/no-require-imports`]          |
 | [`object-literal-sort-keys`] | 🌓  | [`sort-keys`][sort-keys] <sup>[2]</sup>            |
 | [`prefer-const`]             | 🌟  | [`prefer-const`][prefer-const]                     |
 | [`prefer-readonly`]          | 🛑  | N/A                                                |
@@ -578,6 +578,7 @@ Relevant plugins: [`chai-expect-keywords`](https://github.com/gavinaiken/eslint-
 [`@typescript-eslint/no-use-before-define`]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-use-before-define.md
 [`@typescript-eslint/restrict-plus-operands`]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/restrict-plus-operands.md
 [`@typescript-eslint/indent`]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/indent.md
+[`@typescript-eslint/no-require-imports`]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/no-require-imports.md
 [`@typescript-eslint/array-type`]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/array-type.md
 [`@typescript-eslint/class-name-casing`]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/class-name-casing.md
 [`@typescript-eslint/interface-name-prefix`]: https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/interface-name-prefix.md
diff --git a/packages/eslint-plugin/docs/rules/no-require-imports.md b/packages/eslint-plugin/docs/rules/no-require-imports.md
new file mode 100644
index 000000000000..0d2b831a1acd
--- /dev/null
+++ b/packages/eslint-plugin/docs/rules/no-require-imports.md
@@ -0,0 +1,34 @@
+# Disallows invocation of `require()` (no-require-imports)
+
+Prefer the newer ES6-style imports over `require()`.
+
+## Rule Details
+
+Examples of **incorrect** code for this rule:
+
+```ts
+var lib = require('lib');
+let lib2 = require('lib2');
+var lib5 = require('lib5'),
+  lib6 = require('lib6');
+import lib8 = require('lib8');
+```
+
+Examples of **correct** code for this rule:
+
+```ts
+import { l } from 'lib';
+var lib3 = load('not_an_import');
+var lib4 = lib2.subImport;
+var lib7 = 700;
+import lib9 = lib2.anotherSubImport;
+import lib10 from 'lib10';
+```
+
+## When Not To Use It
+
+If you don't care about TypeScript module syntax, then you will not need this rule.
+
+## Compatibility
+
+- TSLint: [no-require-imports](https://palantir.github.io/tslint/rules/no-require-imports/)
diff --git a/packages/eslint-plugin/lib/rules/no-require-imports.js b/packages/eslint-plugin/lib/rules/no-require-imports.js
new file mode 100644
index 000000000000..82537a4dcdaa
--- /dev/null
+++ b/packages/eslint-plugin/lib/rules/no-require-imports.js
@@ -0,0 +1,50 @@
+/**
+ * @fileoverview Disallows invocation of `require()`.
+ * @author Kanitkorn Sujautra
+ */
+'use strict';
+
+const util = require('../util');
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'Disallows invocation of `require()`.',
+      extraDescription: [util.tslintRule('no-require-imports')],
+      category: 'TypeScript',
+      url: util.metaDocsUrl('no-require-imports'),
+      recommended: 'error'
+    },
+    schema: [],
+    messages: {
+      noRequireImports: 'A `require()` style import is forbidden.'
+    }
+  },
+  create(context) {
+    //----------------------------------------------------------------------
+    // Public
+    //----------------------------------------------------------------------
+
+    return {
+      CallExpression(node) {
+        if (node.callee.name === 'require') {
+          context.report({
+            node,
+            messageId: 'noRequireImports'
+          });
+        }
+      },
+      TSExternalModuleReference(node) {
+        context.report({
+          node,
+          messageId: 'noRequireImports'
+        });
+      }
+    };
+  }
+};
diff --git a/packages/eslint-plugin/tests/lib/rules/no-require-imports.js b/packages/eslint-plugin/tests/lib/rules/no-require-imports.js
new file mode 100644
index 000000000000..1eb40a59c34e
--- /dev/null
+++ b/packages/eslint-plugin/tests/lib/rules/no-require-imports.js
@@ -0,0 +1,81 @@
+/**
+ * @fileoverview Disallows invocation of `require()`.
+ * @author Kanitkorn Sujautra
+ */
+'use strict';
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/no-require-imports'),
+  RuleTester = require('eslint').RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parserOptions: {
+    sourceType: 'module'
+  },
+  parser: '@typescript-eslint/parser'
+});
+
+ruleTester.run('no-require-imports', rule, {
+  valid: [
+    "import {l} from 'lib'",
+    "var lib3 = load('not_an_import')",
+    'var lib4 = lib2.subImport',
+    'var lib7 = 700',
+    'import lib9 = lib2.anotherSubImport',
+    "import lib10 from 'lib10'"
+  ],
+  invalid: [
+    {
+      code: "var lib = require('lib')",
+      errors: [
+        {
+          message: 'A `require()` style import is forbidden.',
+          line: 1,
+          column: 11
+        }
+      ]
+    },
+    {
+      code: "let lib2 = require('lib2')",
+      errors: [
+        {
+          message: 'A `require()` style import is forbidden.',
+          line: 1,
+          column: 12
+        }
+      ]
+    },
+    {
+      code: "var lib5 = require('lib5'), lib6 = require('lib6')",
+      errors: [
+        {
+          message: 'A `require()` style import is forbidden.',
+          line: 1,
+          column: 12
+        },
+        {
+          message: 'A `require()` style import is forbidden.',
+          line: 1,
+          column: 36
+        }
+      ]
+    },
+    {
+      code: "import lib8 = require('lib8')",
+      errors: [
+        {
+          message: 'A `require()` style import is forbidden.',
+          line: 1,
+          column: 15
+        }
+      ]
+    }
+  ]
+});

<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'>
<html xmlns='http://www.w3.org/1999/xhtml'>
<head>
<title>pFad - Phonifier reborn</title>
<meta http-equiv='Content-Type' content='text/html; charset=utf-8' />
</head>
<body>
<h1>Pfad - The Proxy pFad of &#169; 2024 Garber Painting. All rights reserved.</h1>


<!-- Disclaimer -->
<p>Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.</p>
<br>
<p>Alternative Proxies:</p><p><a href="http://rainy.clevelandohioweatherforecast.com/php-proxy/index.php?q=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/199.patch" target="_blank">Alternative Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/199.patch" target="_blank">pFad Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v3index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/199.patch" target="_blank">pFad v3 Proxy</a></p><p><a href="http://rainy.clevelandohioweatherforecast.com/pFad/v4index.php?u=https://patch-diff.githubusercontent.com/raw/typescript-eslint/typescript-eslint/pull/199.patch" target="_blank">pFad v4 Proxy</a></p></body>
</html>