custom eslint plugin that fixes typedef imports

packages/agoric-cli/src/sdk-package-names.js

@@ -24,6 +24,7 @@ export default [
   "@agoric/deploy-script-support",
   "@agoric/ertp",
   "@agoric/eslint-config",
+  "@agoric/eslint-plugin",
   "@agoric/fast-usdc",
   "@agoric/governance",
   "@agoric/import-manager",

packages/eslint-plugin/eslint.config.js

@@ -0,0 +1,10 @@
+import eslintPluginEslintPlugin from 'eslint-plugin-eslint-plugin';
+
+export default [
+  {
+    plugins: {
+      'eslint-plugin': eslintPluginEslintPlugin,
+    },
+    extends: ['plugin:eslint-plugin/recommended'],
+  },
+];

packages/eslint-plugin/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@agoric/eslint-plugin",
+  "version": "0.1.0",
+  "description": "ESLint plugin for Agoric best practices",
+  "main": "src/index.js",
+  "type": "module",
+  "files": [
+    "src"
+  ],
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "scripts": {
+    "build": "exit 0",
+    "test": "node --test **/*.test.*"
+  },
+  "peerDependencies": {
+    "eslint": "^8.57.1"
+  },
+  "devDependencies": {
+    "eslint": "^8.57.1",
+    "eslint-plugin-eslint-plugin": "^6.3.2"
+  },
+  "license": "Apache-2.0"
+}

packages/eslint-plugin/src/index.js

@@ -0,0 +1,39 @@
+import fs from 'node:fs';
+import { fileURLToPath } from 'node:url';
+
+const pkg = JSON.parse(
+  fs.readFileSync(new URL('../package.json', import.meta.url), 'utf8'),
+);
+
+// Import rules
+import dollarSign from './rules/dollar-sign.js';
+
+const plugin = {
+  meta: {
+    name: pkg.name,
+    version: pkg.version,
+  },
+
+  // Rule definitions
+  rules: {
+    'dollar-sign': dollarSign,
+  },
+
+  // Recommended config
+  configs: {
+    recommended: [
+      {
+        plugins: {
+          // @ts-expect-error used before declaration
+          '@agoric': plugin,
+        },
+        rules: {
+          '@agoric/dollar-sign': 'error',
+          '@agoric/start-function-prelude': 'error',
+        },
+      },
+    ],
+  },
+};
+
+export default plugin;

packages/eslint-plugin/src/rules/dollar-sign.js

@@ -0,0 +1,24 @@
+/** @type {import('eslint').Rule.RuleModule} */
+export default {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'Example rule that checks for dollar signs',
+      recommended: true,
+    },
+    schema: [], // no options
+  },
+
+  create(context) {
+    return {
+      Identifier(node) {
+        if (node.name.includes('$')) {
+          context.report({
+            node,
+            message: 'Avoid using $ in identifiers',
+          });
+        }
+      },
+    };
+  },
+};

packages/eslint-plugin/tests/rules/dollar-sign.test.js

@@ -0,0 +1,19 @@
+import { RuleTester } from 'eslint';
+import rule from '../../src/rules/dollar-sign.js';
+
+const ruleTester = new RuleTester({
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+ruleTester.run('dollar-sign', rule, {
+  valid: [
+    { code: 'const myVar = 1;' },
+    { code: 'function test() { return true; }' },
+  ],
+  invalid: [
+    {
+      code: 'const my$Var = 1;',
+      errors: [{ message: 'Avoid using $ in identifiers' }],
+    },
+  ],
+});

packages/eslint-plugin/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {},
+  "include": [
+    "src",
+    "test",
+  ],
+}

packages/xsnap/package.json

@@ -20,9 +20,9 @@
     "postinstall": "npm run build:from-env",
     "clean": "rm -rf xsnap-native/xsnap/build",
     "lint": "yarn run -T run-s --continue-on-error 'lint:*'",
-    "lint:js": "eslint 'src/**/*.js' 'test/**/*.js' api.js",
+    "lint:eslint": "yarn run -T eslint 'src/**/*.js' 'test/**/*.js' api.js",
     "lint:types": "yarn run -T tsc",
-    "lint-fix": "eslint --fix 'src/**/*.js' 'test/**/*.js' api.js",
+    "lint-fix": "yarn lint:eslint --fix",
     "test": "ava",
     "test:c8": "c8 --all ${C8_OPTIONS:-} ava",
     "test:xs": "exit 0"