@agoric/eslint-plugin 0.1.1-dev.0 → 0.1.1-other-dev-d15096d.0.d15096d

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/package.json

@@ -1,36 +1,34 @@
 {
   "name": "@agoric/eslint-plugin",
-  "version": "0.1.1-dev.0",
-  "description": "Agoric-specific ESLint plugin",
+  "version": "0.1.1-other-dev-d15096d.0.d15096d",
+  "description": "ESLint plugin for Agoric best practices",
+  "main": "src/index.js",
+  "type": "commonjs",
+  "files": [
+    "src"
+  ],
   "keywords": [
     "eslint",
     "eslintplugin",
     "eslint-plugin"
   ],
-  "author": "Agoric",
-  "main": "lib/index.js",
   "scripts": {
-    "test": "exit 0",
     "build": "exit 0",
-    "lint-fix": "exit 0",
-    "lint-check": "exit 0"
+    "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
+    "lint:types": "yarn run -T tsc",
+    "test": "node --test **/*.test.*",
+    "test:xs": "exit 0"
   },
-  "dependencies": {
-    "requireindex": "~1.1.0"
+  "peerDependencies": {
+    "eslint": "^9.0.0"
   },
   "devDependencies": {
-    "eslint": "^6.8.0"
+    "eslint": "^9.0.0",
+    "eslint-plugin-eslint-plugin": "^7.2.0"
   },
+  "license": "Apache-2.0",
   "engines": {
-    "node": ">=0.10.0"
-  },
-  "publishConfig": {
-    "access": "public"
+    "node": "^20.9 || ^22.11"
   },
-  "prettier": {
-    "trailingComma": "all",
-    "singleQuote": true
-  },
-  "license": "Apache-2.0",
-  "gitHead": "6b1b4f605ab0fa22c6caba3eef347ec97f35b667"
+  "gitHead": "d15096dc4ff8b96e9b6cd11954c20d3a9efbb393"
 }

package/src/index.js

@@ -0,0 +1,34 @@
+const fs = require('node:fs');
+const path = require('path');
+
+const pkg = JSON.parse(
+  fs.readFileSync(path.join(__dirname, '../package.json'), 'utf8'),
+);
+
+// Import rules
+const noTypedefImport = require('./rules/no-typedef-import.js');
+const groupJsdocImports = require('./rules/group-jsdoc-imports.js');
+
+module.exports = {
+  meta: {
+    name: pkg.name,
+    version: pkg.version,
+  },
+
+  // Rule definitions
+  rules: {
+    'no-typedef-import': noTypedefImport,
+    'group-jsdoc-imports': groupJsdocImports,
+  },
+
+  // Recommended config
+  configs: {
+    recommended: {
+      plugins: ['@agoric'],
+      rules: {
+        '@agoric/no-typedef-import': 'error',
+        '@agoric/group-jsdoc-imports': 'warn',
+      },
+    },
+  },
+};

package/src/rules/group-jsdoc-imports.js

@@ -0,0 +1,311 @@
+/**
+ * ESLint rule: group-jsdoc-imports
+ *
+ * Moves inline JSDoc type imports (e.g. \@type {import('foo').Bar})
+ * into a top-level JSDoc block with \@import lines, then references the
+ * import by name (e.g. \@type {Bar}).
+ *
+ * Usage example in your .eslintrc.js:
+ *
+ *  {
+ *    "plugins": ["@agoric"],
+ *    "rules": {
+ *      "@agoric/group-jsdoc-imports": "warning"
+ *    }
+ *  }
+ *
+ * @type {import('eslint').Rule.RuleModule}
+ */
+/**
+ * ESLint rule: group-jsdoc-imports (one-fix-per-inline-import version)
+ */
+
+module.exports = {
+  meta: {
+    type: /** @type {const} */ ('suggestion'),
+    docs: {
+      description: 'Move inline type import to top-level JSDoc import block',
+      category: 'Stylistic Issues',
+      recommended: false,
+    },
+    fixable: /** @type {const} */ ('code'),
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          paths: {
+            type: 'array',
+            items: { type: 'string' },
+          },
+        },
+        additionalProperties: false,
+      },
+    ],
+    messages: {
+      moveInline: 'Move inline type import to top-level JSDoc import block',
+    },
+  },
+
+  create(context) {
+    const sourceCode = context.getSourceCode();
+    const { paths: allowedPaths = [] } = context.options[0] || {};
+
+    // Use the `g` flag so we can match multiple inline imports in one comment.
+    const INLINE_IMPORT_REGEX =
+      /import\(['"]([^'"]+)['"]\)\.([A-Za-z0-9_$]+(?:<[A-Za-z0-9_<>{},\s]+>)?)/g;
+
+    function isAllowedPath(importPath) {
+      if (
+        importPath.startsWith('./') ||
+        importPath.startsWith('../') ||
+        importPath === '.' ||
+        importPath === '..'
+      ) {
+        return true; // always allow relative paths
+      }
+      if (!allowedPaths.length) {
+        return true; // no filtering if no paths configured
+      }
+      return allowedPaths.some(prefix => importPath.startsWith(prefix));
+    }
+
+    /**
+     * Finds an existing top-level `@import` block comment (one that contains "@import")
+     * or returns `null` if none exists.
+     */
+    function findTopBlockComment(allComments) {
+      for (const comment of allComments) {
+        if (comment.type === 'Block') {
+          // Rebuild with the /* ... */ so we can search for "@import"
+          const text = `/*${comment.value}*/`;
+          if (text.includes('@import ')) {
+            return comment;
+          }
+        }
+      }
+      return null;
+    }
+
+    /**
+     * Checks if the doc block already imports a specific type from a path,
+     * returning `true` if found.
+     */
+    function alreadyHasImport(blockValue, typeName, importPath) {
+      // blockValue is the text inside /* ... */
+      // Look for lines like: @import {Type} from 'xyz'
+      // Possibly could handle multiple types in one line, but let's keep it simple:
+      const lines = blockValue.split('\n');
+      for (const line of lines) {
+        const m = line.match(/@import\s+{([^}]+)}\s+from\s+['"]([^'"]+)['"]/);
+        if (m) {
+          const importedTypes = m[1].split(',').map(s => s.trim());
+          const fromPath = m[2];
+          if (fromPath === importPath && importedTypes.includes(typeName)) {
+            return true; // Found a matching import already
+          }
+        }
+      }
+      return false;
+    }
+
+    const allComments = sourceCode.getAllComments();
+
+    const buildImportLine = (typeName, importPath) =>
+      ` * @import {${typeName}} from '${importPath}';\n`;
+
+    const buildNewBlock = (typeName, importPath) =>
+      ['/**', buildImportLine(typeName, importPath).trimEnd(), ' */', ''].join(
+        '\n',
+      );
+
+    const appendImportToComment = (commentNode, typeName, importPath) => {
+      const existingText = sourceCode.getText(commentNode);
+      const closingIndex = existingText.lastIndexOf('*/');
+      const importLine = buildImportLine(typeName, importPath);
+
+      if (closingIndex === -1) {
+        return `${existingText}\n${importLine}`;
+      }
+
+      const beforeCloseFull = existingText.slice(0, closingIndex);
+      const lastNewlineIndex = beforeCloseFull.lastIndexOf('\n');
+      let beforeClose = beforeCloseFull;
+      let closingIndent = '';
+
+      if (lastNewlineIndex !== -1) {
+        const tail = beforeCloseFull.slice(lastNewlineIndex + 1);
+        if (/^[\t ]*$/.test(tail)) {
+          closingIndent = tail;
+          beforeClose = beforeCloseFull.slice(0, lastNewlineIndex + 1);
+        }
+      } else {
+        beforeClose = beforeCloseFull.trimEnd();
+      }
+
+      const suffixIndent =
+        closingIndent !== ''
+          ? closingIndent
+          : existingText.startsWith('/*')
+            ? ' '
+            : '';
+      const suffix = `${suffixIndent}${existingText.slice(closingIndex)}`;
+      const needsNewline = beforeClose.endsWith('\n') ? '' : '\n';
+
+      return `${beforeClose}${needsNewline}${importLine}${suffix}`;
+    };
+
+    const advancePastWhitespaceNewline = startIndex => {
+      const match = sourceCode.text.slice(startIndex).match(/^[^\S\r\n]*\r?\n/);
+      if (match) {
+        return { matched: true, nextIndex: startIndex + match[0].length };
+      }
+      return { matched: false, nextIndex: startIndex };
+    };
+
+    const getNewBlockInsertPlacement = () => {
+      const programBody = sourceCode.ast.body || [];
+      const importNodes = programBody.filter(
+        node => node.type === 'ImportDeclaration',
+      );
+      const firstContentIndex = sourceCode.text.search(/\S/);
+      let insertIndex = firstContentIndex === -1 ? 0 : firstContentIndex;
+      let prefix = '';
+      let needsTrailingBlankLine = false;
+
+      if (importNodes.length) {
+        insertIndex = importNodes[importNodes.length - 1].range[1];
+
+        let step = advancePastWhitespaceNewline(insertIndex);
+        const hasNewlineAfterImports = step.matched;
+        insertIndex = step.nextIndex;
+
+        step = advancePastWhitespaceNewline(insertIndex);
+        const hasBlankLine = step.matched;
+        insertIndex = step.nextIndex;
+
+        if (!hasNewlineAfterImports) {
+          prefix += '\n';
+        }
+        if (!hasBlankLine) {
+          prefix += '\n';
+        } else {
+          needsTrailingBlankLine = true;
+        }
+      } else {
+        const blankLineMatch = /\r?\n[^\S\r\n]*\r?\n/.exec(sourceCode.text);
+        if (blankLineMatch) {
+          insertIndex = blankLineMatch.index + blankLineMatch[0].length;
+          needsTrailingBlankLine = true;
+        }
+      }
+
+      return { insertIndex, prefix, needsTrailingBlankLine };
+    };
+
+    // Walk all block comments and look for inline imports.
+    for (const comment of allComments) {
+      if (comment.type !== 'Block') {
+        continue;
+      }
+      const { value: commentText } = comment;
+
+      // We collect all matches in this comment for `import('...').SomeType`
+      const matches = [...commentText.matchAll(INLINE_IMPORT_REGEX)];
+      for (const match of matches) {
+        const [fullMatch, importPath, rawTypeName] = match;
+        if (!isAllowedPath(importPath)) {
+          continue; // skip if path is not in allowedPaths
+        }
+        const typeName =
+          typeof rawTypeName === 'string'
+            ? rawTypeName
+            : String(rawTypeName ?? '');
+        const importTypeName = typeName.includes('<')
+          ? typeName.slice(0, typeName.indexOf('<'))
+          : typeName;
+
+        // We have an inline import. We'll report exactly one error
+        // for *this* inline import. The fix will:
+        // 1) Insert/update the doc block
+        // 2) Remove inline usage from this comment
+        context.report({
+          loc: comment.loc,
+          messageId: 'moveInline',
+          fix: fixer => {
+            // We'll build a set of fix operations for both the doc block
+            // (somewhere in the file) and this inline usage.
+            const fixOps = [];
+
+            const inlineStart =
+              comment.range[0] +
+              2 +
+              (match.index ?? commentText.indexOf(fullMatch));
+            const inlineEnd = inlineStart + fullMatch.length;
+
+            // (a) We locate or create a top-level block
+            const topBlockComment = findTopBlockComment(allComments);
+            const topBlockIsSameAsComment =
+              topBlockComment &&
+              topBlockComment.range[0] === comment.range[0] &&
+              topBlockComment.range[1] === comment.range[1];
+
+            if (!topBlockComment) {
+              // If no block with @import found, create a new block at top
+              const {
+                insertIndex,
+                prefix: newBlockPrefix,
+                needsTrailingBlankLine,
+              } = getNewBlockInsertPlacement();
+              const trailingSpacer = needsTrailingBlankLine ? '\n' : '';
+              fixOps.push(
+                fixer.insertTextBeforeRange(
+                  [insertIndex, insertIndex],
+                  `${newBlockPrefix}${buildNewBlock(importTypeName, importPath)}${trailingSpacer}`,
+                ),
+              );
+            } else if (topBlockIsSameAsComment) {
+              fixOps.push(
+                fixer.insertTextBeforeRange(
+                  [comment.range[0], comment.range[0]],
+                  `${buildNewBlock(importTypeName, importPath)}\n`,
+                ),
+              );
+            } else {
+              // If we do have a block, ensure it includes `@import {typeName} from 'importPath'`
+              if (
+                !alreadyHasImport(
+                  topBlockComment.value,
+                  importTypeName,
+                  importPath,
+                )
+              ) {
+                fixOps.push(
+                  fixer.replaceTextRange(
+                    topBlockComment.range,
+                    appendImportToComment(
+                      topBlockComment,
+                      importTypeName,
+                      importPath,
+                    ),
+                  ),
+                );
+              }
+            }
+
+            // (b) Remove the inline usage from *this* comment
+            // Replace `import('...').Foo` → `Foo`
+            fixOps.push(
+              fixer.replaceTextRange([inlineStart, inlineEnd], typeName),
+            );
+
+            return fixOps;
+          },
+        });
+      }
+    }
+
+    // We do NOT do anything in Program:exit, because each inline usage
+    // is already handled in a single fix above.
+    return {};
+  },
+};

package/src/rules/no-typedef-import.js

@@ -0,0 +1,147 @@
+/**
+ * ESLint rule: no-typedef-import
+ *
+ * Finds inline `import()` expressions inside `@typedef` declarations and replaces
+ * them with a corresponding `@import` directive. This prevents generating new type aliases
+ * and unwittingly exporting them from the module.
+ *
+ * If the module should be exporting the types, `@typedef` is still the only way in JSDoc
+ * so disable this rule in those files.
+ *
+ * @see https://github.com/microsoft/typescript/issues/60831
+ */
+
+const LINE_REGEX =
+  /^(\s*\*?\s*)@typedef\s+\{\s*import\((['"])([^'"]+)\2\)\.([A-Za-z0-9_$]+)([^}]*)\}\s+([A-Za-z0-9_$]+)(.*)$/;
+
+const getConversionPlan = value => {
+  const lines = value.split('\n');
+  const convertible = [];
+
+  for (let index = 0; index < lines.length; index += 1) {
+    const line = lines[index];
+    const match = line.match(LINE_REGEX);
+    if (!match) {
+      continue;
+    }
+
+    const [
+      ,
+      indent,
+      quote,
+      importPath,
+      importedType,
+      rawSuffix = '',
+      ,
+      // typedefName (unused),
+      trailing = '',
+    ] = match;
+
+    if (rawSuffix && rawSuffix.trim() !== '') {
+      continue; // skip typedefs that add generics or other suffixes
+    }
+
+    convertible.push({
+      index,
+      indent,
+      quote,
+      importPath,
+      importedType,
+      trailing,
+    });
+  }
+
+  return { lines, convertible };
+};
+
+const transformCommentValue = value => {
+  const { lines, convertible } = getConversionPlan(value);
+  if (!convertible.length) {
+    return null;
+  }
+
+  for (const {
+    index,
+    indent,
+    quote,
+    importPath,
+    importedType,
+    trailing,
+  } of convertible) {
+    const trailingText = trailing || '';
+    lines[index] =
+      `${indent}@import {${importedType}} from ${quote}${importPath}${quote};${trailingText}`;
+  }
+
+  return lines.join('\n');
+};
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'Disallow inline import() expressions inside @typedef; prefer @import directives.',
+      recommended: false,
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      noTypedefImport:
+        'Use an @import directive instead of an inline import() inside @typedef.',
+    },
+  },
+
+  create(context) {
+    const sourceCode = context.getSourceCode();
+
+    return {
+      Program() {
+        for (const comment of sourceCode.getAllComments()) {
+          if (comment.type !== 'Block') {
+            continue;
+          }
+          if (!comment.value.includes('@typedef')) {
+            continue;
+          }
+
+          const { convertible } = getConversionPlan(comment.value);
+          if (!convertible.length) {
+            continue;
+          }
+
+          const { range, loc } = comment;
+          if (!range) {
+            continue;
+          }
+
+          const originalText = sourceCode.text.slice(range[0], range[1]);
+          const reportLoc = loc ?? {
+            start: sourceCode.getLocFromIndex(range[0]),
+            end: sourceCode.getLocFromIndex(range[1]),
+          };
+
+          const descriptor = {
+            loc: reportLoc,
+            messageId: 'noTypedefImport',
+            fix(fixer) {
+              const newValue = transformCommentValue(comment.value);
+              if (!newValue) {
+                return null;
+              }
+
+              const newCommentText = originalText.replace(
+                comment.value,
+                newValue,
+              );
+              return fixer.replaceTextRange(range, newCommentText);
+            },
+          };
+
+          context.report(descriptor);
+        }
+      },
+    };
+  },
+};

package/CHANGELOG.md

@@ -1,19 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.1.1-dev.0](https://github.com/Agoric/agoric-sdk/compare/@agoric/eslint-plugin@0.1.0...@agoric/eslint-plugin@0.1.1-dev.0) (2021-02-23)
-
-**Note:** Version bump only for package @agoric/eslint-plugin
-
-
-
-
-
-# 0.1.0 (2021-02-16)
-
-
-### Features
-
-* make @agoric/eslint-plugin deal with assert.fail as throw ([f23adee](https://github.com/Agoric/agoric-sdk/commit/f23adee512aec50788d9c9efed1cea9d774dfe8f))

package/README.md

@@ -1,51 +0,0 @@
-# eslint-plugin-agoric
-
-Agoric-specific plugin
-
-## Installation
-
-You'll first need to install [ESLint](http://eslint.org):
-
-```
-$ npm i eslint --save-dev
-```
-
-Next, install `eslint-plugin-agoric`:
-
-```
-$ npm install eslint-plugin-agoric --save-dev
-```
-
-**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-agoric` globally.
-
-## Usage
-
-Add `agoric` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
-
-```json
-{
-    "plugins": [
-        "agoric"
-    ]
-}
-```
-
-
-Then configure the rules you want to use under the rules section.
-
-```json
-{
-    "rules": {
-        "agoric/rule-name": 2
-    }
-}
-```
-
-## Supported Rules
-
-* Fill in provided rules here
-
-
-
-
-

package/lib/configs/recommended.js

@@ -1,6 +0,0 @@
-module.exports = {
-  plugins: ["@agoric"],
-  rules: {
-    "@agoric/assert-fail-as-throw": 2
-  },
-};

package/lib/index.js

@@ -1,20 +0,0 @@
-/**
- * @fileoverview Agoric-specific plugin
- * @author Agoric
- */
-"use strict";
-
-//------------------------------------------------------------------------------
-// Requirements
-//------------------------------------------------------------------------------
-
-var requireIndex = require("requireindex");
-
-//------------------------------------------------------------------------------
-// Plugin Definition
-//------------------------------------------------------------------------------
-
-
-// import all rules in lib/rules
-module.exports.rules = requireIndex(__dirname + "/rules");
-module.exports.configs = requireIndex(__dirname + "/configs");

package/lib/rules/assert-fail-as-throw.js

@@ -1,167 +0,0 @@
-/**
- * @author Toru Nagashima
- * See LICENSE file in root directory for full license.
- * 
- * Modified by Michael FIG <mfig@agoric.com> for Agoric's assert.fail.
- * (This file used to be github.com/mysticatea/eslint-plugin-node/.../process-exit-as-throw.js.)
- */
-"use strict"
-
-const CodePathAnalyzer = safeRequire(
-    "eslint/lib/linter/code-path-analysis/code-path-analyzer",
-    "eslint/lib/code-path-analysis/code-path-analyzer"
-)
-const CodePathSegment = safeRequire(
-    "eslint/lib/linter/code-path-analysis/code-path-segment",
-    "eslint/lib/code-path-analysis/code-path-segment"
-)
-const CodePath = safeRequire(
-    "eslint/lib/linter/code-path-analysis/code-path",
-    "eslint/lib/code-path-analysis/code-path"
-)
-
-const originalLeaveNode =
-    CodePathAnalyzer && CodePathAnalyzer.prototype.leaveNode
-
-/**
- * Imports a specific module.
- * @param {...string} moduleNames - module names to import.
- * @returns {object|null} The imported object, or null.
- */
-function safeRequire(...moduleNames) {
-    for (const moduleName of moduleNames) {
-        try {
-            return require(moduleName)
-        } catch (_err) {
-            // Ignore.
-        }
-    }
-    return null
-}
-
-/* istanbul ignore next */
-/**
- * Copied from https://github.com/eslint/eslint/blob/16fad5880bb70e9dddbeab8ed0f425ae51f5841f/lib/code-path-analysis/code-path-analyzer.js#L137
- *
- * @param {CodePathAnalyzer} analyzer - The instance.
- * @param {ASTNode} node - The current AST node.
- * @returns {void}
- */
-function forwardCurrentToHead(analyzer, node) {
-    const codePath = analyzer.codePath
-    const state = CodePath.getState(codePath)
-    const currentSegments = state.currentSegments
-    const headSegments = state.headSegments
-    const end = Math.max(currentSegments.length, headSegments.length)
-    let i = 0
-    let currentSegment = null
-    let headSegment = null
-
-    // Fires leaving events.
-    for (i = 0; i < end; ++i) {
-        currentSegment = currentSegments[i]
-        headSegment = headSegments[i]
-
-        if (currentSegment !== headSegment && currentSegment) {
-            if (currentSegment.reachable) {
-                analyzer.emitter.emit(
-                    "onCodePathSegmentEnd",
-                    currentSegment,
-                    node
-                )
-            }
-        }
-    }
-
-    // Update state.
-    state.currentSegments = headSegments
-
-    // Fires entering events.
-    for (i = 0; i < end; ++i) {
-        currentSegment = currentSegments[i]
-        headSegment = headSegments[i]
-
-        if (currentSegment !== headSegment && headSegment) {
-            CodePathSegment.markUsed(headSegment)
-            if (headSegment.reachable) {
-                analyzer.emitter.emit(
-                    "onCodePathSegmentStart",
-                    headSegment,
-                    node
-                )
-            }
-        }
-    }
-}
-
-/**
- * Checks whether a given node is `assert.fail()` or not.
- *
- * @param {ASTNode} node - A node to check.
- * @returns {boolean} `true` if the node is `assert.fail()`.
- */
-function isAssertFail(node) {
-    return (
-        node.type === "CallExpression" &&
-        node.callee.type === "MemberExpression" &&
-        node.callee.computed === false &&
-        node.callee.object.type === "Identifier" &&
-        node.callee.object.name === "assert" &&
-        node.callee.property.type === "Identifier" &&
-        node.callee.property.name === "fail"
-    )
-}
-
-/**
- * The function to override `CodePathAnalyzer.prototype.leaveNode` in order to
- * address `assert.fail()` as throw.
- *
- * @this CodePathAnalyzer
- * @param {ASTNode} node - A node to be left.
- * @returns {void}
- */
-function overrideLeaveNode(node) {
-    if (isAssertFail(node)) {
-        this.currentNode = node
-
-        forwardCurrentToHead(this, node)
-        CodePath.getState(this.codePath).makeThrow()
-
-        this.original.leaveNode(node)
-        this.currentNode = null
-    } else {
-        originalLeaveNode.call(this, node)
-    }
-}
-
-const visitor =
-    CodePathAnalyzer == null
-        ? {}
-        : {
-              Program: function installAssertFailAsThrow() {
-                  CodePathAnalyzer.prototype.leaveNode = overrideLeaveNode
-              },
-              "Program:exit": function restoreAssertFailAsThrow() {
-                  CodePathAnalyzer.prototype.leaveNode = originalLeaveNode
-              },
-          }
-
-module.exports = {
-    meta: {
-        docs: {
-            description:
-                "make `assert.fail()` expressions the same code path as `throw`",
-            category: "Possible Errors",
-            recommended: true,
-            url:
-                "https://github.com/Agoric/agoric-sdk/blob/master/packages/eslint-plugin/lib/rules/assert-fail-as-throw.js",
-        },
-        type: "problem",
-        fixable: null,
-        schema: [],
-        supported: true || CodePathAnalyzer != null,
-    },
-    create() {
-        return visitor
-    },
-}