Forbid re-exports of non-importable variables (#9)

Author: mozisan

src/__tests__/fixtures/project/src/reexport4/filenameLoophole/sub.ts

@@ -0,0 +1 @@
+export { subFoo } from "./sub/foo";

src/__tests__/fixtures/project/src/reexport4/filenameLoophole/sub/foo.ts

@@ -0,0 +1,4 @@
+/**
+ * @package
+ */
+export const subFoo = "hello!";

src/__tests__/fixtures/project/src/reexport4/filenameLoophole/sub2.ts

@@ -0,0 +1 @@
+export { subFoo } from "./sub/foo";

src/__tests__/fixtures/project/src/reexport4/indexLoophole/reexportFromSubFoo.ts

@@ -0,0 +1 @@
+export { subFoo } from "./sub/foo";

src/__tests__/fixtures/project/src/reexport4/indexLoophole/reexportFromSubIndex.ts

@@ -0,0 +1 @@
+export { subFoo } from "./sub/index";

src/__tests__/fixtures/project/src/reexport4/indexLoophole/sub/foo.ts

@@ -0,0 +1,4 @@
+/**
+ * @package
+ */
+export const subFoo = "hello!";

src/__tests__/fixtures/project/src/reexport4/indexLoophole/sub/index.ts

@@ -0,0 +1,4 @@
+/**
+ * @package
+ */
+export { subFoo } from "./foo";

src/__tests__/reexport.ts

@@ -43,6 +43,32 @@ Array [
 ]
 `);
   });
+  it("Cannot re-export a package-private variable", async () => {
+    const result = await tester.lintFile(
+      "src/reexport4/indexLoophole/reexportFromSubFoo.ts"
+    );
+    expect(result).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "column": 10,
+    "endColumn": 16,
+    "endLine": 1,
+    "line": 1,
+    "message": "Cannot re-export a package-private export 'subFoo'",
+    "messageId": "package:reexport",
+    "nodeType": "ExportSpecifier",
+    "ruleId": "import-access/jsdoc",
+    "severity": 2,
+  },
+]
+`);
+  });
+  it("Can re-export a variable exported from index.ts", async () => {
+    const result = await tester.lintFile(
+      "src/reexport4/indexLoophole/reexportFromSubIndex.ts"
+    );
+    expect(result).toMatchInlineSnapshot(`Array []`);
+  });
   describe("indexLoophole = false", () => {
     it("Cannot import a package-private variable from sub/index.ts", async () => {
       const result = await tester.lintFile("src/reexport/useFoo.ts", {
@@ -75,6 +101,31 @@ Array [
     "severity": 2,
   },
 ]
+`);
+    });
+    it("Cannot re-export a package-private variable", async () => {
+      const result = await tester.lintFile(
+        "src/reexport4/indexLoophole/reexportFromSubIndex.ts",
+        {
+          jsdoc: {
+            indexLoophole: false,
+          },
+        }
+      );
+      expect(result).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "column": 10,
+    "endColumn": 16,
+    "endLine": 1,
+    "line": 1,
+    "message": "Cannot re-export a package-private export 'subFoo'",
+    "messageId": "package:reexport",
+    "nodeType": "ExportSpecifier",
+    "ruleId": "import-access/jsdoc",
+    "severity": 2,
+  },
+]
 `);
     });
   });
@@ -100,6 +151,44 @@ Array [
     "severity": 2,
   },
 ]
+`);
+    });
+    it("Can re-export from sub directory of same name", async () => {
+      const result = await tester.lintFile(
+        "src/reexport4/filenameLoophole/sub.ts",
+        {
+          jsdoc: {
+            indexLoophole: false,
+            filenameLoophole: true,
+          },
+        }
+      );
+      expect(result).toMatchInlineSnapshot(`Array []`);
+    });
+    it("Cannot re-export from sub directory of different name", async () => {
+      const result = await tester.lintFile(
+        "src/reexport4/filenameLoophole/sub2.ts",
+        {
+          jsdoc: {
+            indexLoophole: false,
+            filenameLoophole: true,
+          },
+        }
+      );
+      expect(result).toMatchInlineSnapshot(`
+Array [
+  Object {
+    "column": 10,
+    "endColumn": 16,
+    "endLine": 1,
+    "line": 1,
+    "message": "Cannot re-export a package-private export 'subFoo'",
+    "messageId": "package:reexport",
+    "nodeType": "ExportSpecifier",
+    "ruleId": "import-access/jsdoc",
+    "severity": 2,
+  },
+]
 `);
     });
   });

src/rules/jsdoc.ts

@@ -4,7 +4,11 @@ import { checkSymbolImportability } from "../core/checkSymbolmportability";
 import { getImmediateAliasedSymbol } from "../utils/getImmediateAliasedSymbol";
 import { PackageOptions } from "../utils/isInPackage";
 
-type MessageId = "package" | "private";
+type MessageId =
+  | "package"
+  | "package:reexport"
+  | "private"
+  | "private:reexport";
 
 export type JSDocRuleOptions = {
   /**
@@ -34,7 +38,11 @@ const jsdocRule: Omit<
     },
     messages: {
       package: "Cannot import a package-private export '{{ identifier }}'",
+      "package:reexport":
+        "Cannot re-export a package-private export '{{ identifier }}'",
       private: "Cannot import a private export '{{ identifier }}'",
+      "private:reexport":
+        "Cannot re-export a private export '{{ identifier }}'",
     },
     schema: [
       {
@@ -102,6 +110,29 @@ const jsdocRule: Omit<
           checkSymbol(context, packageOptions, checker, node, tsNode, symbol);
         }
       },
+      ExportSpecifier(node) {
+        const shouldSkip = shouldSkipSymbolCheck(node);
+        if (shouldSkip) {
+          return;
+        }
+
+        const checker = parserServices.program.getTypeChecker();
+
+        const tsNode = parserServices.esTreeNodeToTSNodeMap.get(node);
+
+        const symbol = checker.getSymbolAtLocation(tsNode.name);
+        if (symbol) {
+          checkSymbol(
+            context,
+            packageOptions,
+            checker,
+            node,
+            tsNode,
+            symbol,
+            true
+          );
+        }
+      },
     };
   },
 };
@@ -120,12 +151,28 @@ export function jsDocRuleDefaultOptions(
 }
 
 function shouldSkipSymbolCheck(
-  node: TSESTree.ImportSpecifier | TSESTree.ImportDefaultSpecifier
-) {
-  if (node.parent?.type === "ImportDeclaration") {
-    const packageName = node.parent.source.value;
-    return isNodeBuiltinModule(packageName) || willBeImportedFromNodeModules(packageName);
+  node:
+    | TSESTree.ImportSpecifier
+    | TSESTree.ImportDefaultSpecifier
+    | TSESTree.ExportSpecifier
+): boolean {
+  if (!node.parent) {
+    return true;
   }
+  if (
+    node.parent.type !== "ImportDeclaration" &&
+    node.parent.type !== "ExportNamedDeclaration"
+  ) {
+    return true;
+  }
+  const packageName = node.parent.source?.value;
+  if (!packageName) {
+    return true;
+  }
+  return (
+    isNodeBuiltinModule(packageName) ||
+    willBeImportedFromNodeModules(packageName)
+  );
 }
 
 function isNodeBuiltinModule(importPath: string) {
@@ -163,7 +210,8 @@ function checkSymbol(
   checker: TypeChecker,
   originalNode: TSESTree.Node,
   tsNode: Node,
-  symbol: Symbol
+  symbol: Symbol,
+  reexport = false
 ) {
   const exsy = getImmediateAliasedSymbol(checker, symbol);
   if (!exsy) {
@@ -179,7 +227,7 @@ function checkSymbol(
     case "package": {
       context.report({
         node: originalNode,
-        messageId: "package",
+        messageId: reexport ? "package:reexport" : "package",
         data: {
           identifier: exsy.name,
         },
@@ -189,7 +237,7 @@ function checkSymbol(
     case "private": {
       context.report({
         node: originalNode,
-        messageId: "private",
+        messageId: reexport ? "private:reexport" : "private",
         data: {
           identifier: exsy.name,
         },