Shared now lints itself

Author: nebrius

.github/workflows/shared.yaml

@@ -0,0 +1,34 @@
+name: Shared
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+  merge_group:
+
+jobs:
+  build-and-test:
+    name: Shared Build and Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Needed to copy the WASM file during build
+          lfs: true
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint
+        working-directory: ./packages/shared
+        run: npm run lint
+      - name: Type check
+        working-directory: ./packages/shared
+        run: npm run type-check
+      - name: Build
+        working-directory: ./packages/shared
+        run: npm run build

package-lock.json

@@ -1,6 +1,6 @@
 import { resolve } from "node:path";
 
-import { getReactEslintConfig } from "@speakeasy-api/config";
+import { getReactEslintConfig } from "@speakeasy-api/docs-md-shared";
 import { getDirname } from "cross-dirname";
 import globals from "globals";
 

packages/react/eslint.config.mjs

@@ -34,6 +34,7 @@
   "dependencies": {
     "@codesandbox/sandpack-client": "^2.19.8",
     "@codesandbox/sandpack-react": "^2.20.0",
+    "@speakeasy-api/docs-md-shared": "*",
     "arg": "^5.0.2",
     "chalk": "^5.3.0",
     "change-case": "^5.4.4",

packages/react/package.json

@@ -1,39 +1,29 @@
 import { resolve } from "node:path";
 
-import { getReactEslintConfig } from "@speakeasy-api/shared";
 import { getDirname } from "cross-dirname";
-import globals from "globals";
+
+import { getNodeESLintConfig } from "./index.mjs";
 
 const gitignorePath = resolve(getDirname(), "..", "..", ".gitignore");
 
 export default [
-  ...getReactEslintConfig({
+  ...getNodeESLintConfig({
     gitignorePaths: gitignorePath,
     rootDir: getDirname(),
     entryPoints: {
       "eslint.config.mjs": ["default"],
+      "index.mjs": /.*/,
       "types/index.ts": /.*/,
     },
-  // Since we're a mix of running in both Node.js and React, we override the
-  // globals set by the React config to include Node.js globals as well.
-  {
-    languageOptions: {
-      globals: { ...globals.browser, ...globals.node },
-    },
-  },
-  // Disable unused exports rule for Storybook files
-  {
-    files: ["**/*.stories.{ts,tsx}", ".storybook/*.{ts,tsx}"],
-    rules: {
-      "fast-import/no-unused-exports": "off",
-    },
-  },
-  // Disallow console calls in compiler code (use logging.ts functions instead)
-  {
-    files: ["src/compiler/**/*.{ts,js,mts,mjs}"],
-    ignores: ["src/compiler/logging.ts"],
-    rules: {
-      "no-console": "error",
-    },
-  },
+    ignores: ["src/compiler/data/wasm_exec.js"],
+    restrictedImports: [
+      {
+        type: "third-party",
+        moduleSpecifier: "node:fs",
+        allowed: [/src\/compiler\/cli\//],
+        message:
+          "File system access is only allowed in the CLI wrapper because other code needs to be isomorphic",
+      },
+    ],
+  }),
 ];

packages/shared/eslint.config.mjs

@@ -1,19 +1,19 @@
+import { includeIgnoreFile } from "@eslint/compat";
 import eslint from "@eslint/js";
-import tseslint from "typescript-eslint";
+import { globalIgnores } from "eslint/config";
 import eslintConfigPrettier from "eslint-config-prettier/flat";
-import unusedImports from "eslint-plugin-unused-imports";
-import { includeIgnoreFile } from "@eslint/compat";
 import { all } from "eslint-plugin-fast-import";
 import simpleImportSort from "eslint-plugin-simple-import-sort";
-import { globalIgnores } from "eslint/config";
+import unusedImports from "eslint-plugin-unused-imports";
+import tseslint from "typescript-eslint";
 
-export const getBaseESLintConfig = ({
+export function getBaseESLintConfig({
   gitignorePaths,
   rootDir,
   entryPoints,
   ignores,
   restrictedImports,
-}) => {
+}) {
   if (!Array.isArray(gitignorePaths)) {
     gitignorePaths = [gitignorePaths];
   }
@@ -95,4 +95,4 @@ export const getBaseESLintConfig = ({
       },
     },
   ];
-};
+}

packages/shared/eslint/base.mjs

@@ -1,17 +1,20 @@
+import ava from "eslint-plugin-ava";
 import globals from "globals";
+
 import { getBaseESLintConfig } from "./base.mjs";
-import ava from "eslint-plugin-ava";
 
-export const getNodeESLintConfig = (options) => [
-  ...getBaseESLintConfig(options),
-  ava.configs["flat/recommended"],
-  {
-    languageOptions: {
-      globals: globals.node,
-    },
-    rules: {
-      // This rule doesn't support TypeScript tests
-      "ava/no-ignored-test-files": "off",
+export function getNodeESLintConfig(options) {
+  return [
+    ...getBaseESLintConfig(options),
+    ava.configs["flat/recommended"],
+    {
+      languageOptions: {
+        globals: globals.node,
+      },
+      rules: {
+        // This rule doesn't support TypeScript tests
+        "ava/no-ignored-test-files": "off",
+      },
     },
-  },
-];
+  ];
+}

packages/shared/eslint/node.mjs

@@ -1,9 +1,12 @@
+import playwright from "eslint-plugin-playwright";
 import globals from "globals";
+
 import { getBaseESLintConfig } from "./base.mjs";
-import playwright from "eslint-plugin-playwright";
 
-export const getPlaywrightESLintConfig = (options) => [
-  ...getBaseESLintConfig(options),
-  playwright.configs["flat/recommended"],
-  { languageOptions: { globals: globals.node } },
-];
+export function getPlaywrightESLintConfig(options) {
+  return [
+    ...getBaseESLintConfig(options),
+    playwright.configs["flat/recommended"],
+    { languageOptions: { globals: globals.node } },
+  ];
+}

packages/shared/eslint/playwright.mjs

@@ -1,28 +1,31 @@
-import globals from "globals";
-import { getBaseESLintConfig } from "./base.mjs";
 import pluginReact from "eslint-plugin-react";
 import reactHooks from "eslint-plugin-react-hooks";
+import globals from "globals";
 
-export const getReactEslintConfig = (options) => [
-  ...getBaseESLintConfig(options),
-  pluginReact.configs.flat.recommended,
-  reactHooks.configs["recommended-latest"],
-  {
-    languageOptions: {
-      globals: globals.browser,
-    },
-    settings: {
-      react: {
-        version: "detect",
+import { getBaseESLintConfig } from "./base.mjs";
+
+export function getReactEslintConfig(options) {
+  return [
+    ...getBaseESLintConfig(options),
+    pluginReact.configs.flat.recommended,
+    reactHooks.configs["recommended-latest"],
+    {
+      languageOptions: {
+        globals: globals.browser,
+      },
+      settings: {
+        react: {
+          version: "detect",
+        },
+      },
+      rules: {
+        "react-hooks/exhaustive-deps": "error",
       },
     },
-    rules: {
-      "react-hooks/exhaustive-deps": "error",
-    },
-  },
-  {
-    rules: {
-      "react/react-in-jsx-scope": "off",
+    {
+      rules: {
+        "react/react-in-jsx-scope": "off",
+      },
     },
-  },
-];
+  ];
+}

packages/shared/eslint/react.mjs

@@ -31,10 +31,10 @@
     "build": "",
     "dev": "",
     "format": "prettier --config ../../prettier.config.mjs --ignore-path ../../.gitignore --write \"**/*.{js,jsx,mjs,ts,tsx,mts}\"",
-    "lint": "",
+    "lint": "eslint \"**/*.{js,jsx,mjs,ts,tsx,mts}\"",
     "start": "",
     "test": "",
-    "type-check": "",
+    "type-check": "tsc --noEmit",
     "build-api-docs": ""
   }
 }