forked from automerge/automerge-repo
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
eslint rule to check we only use the /slim import
- Loading branch information
Showing
5 changed files
with
551 additions
and
382 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| import typescriptEslint from "@typescript-eslint/eslint-plugin" | ||
| import globals from "globals" | ||
| import tsParser from "@typescript-eslint/parser" | ||
| import path from "node:path" | ||
| import { fileURLToPath } from "node:url" | ||
| import js from "@eslint/js" | ||
| import { FlatCompat } from "@eslint/eslintrc" | ||
|
|
||
| // Necessary so that we can use `FlatCompat` for configs which haven't been | ||
| // migrated to eslint 9 yet. See https://eslint.org/docs/latest/use/configure/migration-guide#using-eslintrc-configs-in-flat-config | ||
| const __filename = fileURLToPath(import.meta.url) | ||
| const __dirname = path.dirname(__filename) | ||
| const compat = new FlatCompat({ | ||
| baseDirectory: __dirname, | ||
| recommendedConfig: js.configs.recommended, | ||
| allConfig: js.configs.all, | ||
| }) | ||
|
|
||
| const automergeSlimImportRule = { | ||
| meta: { | ||
| name: "enforce-automerge-slim-import", | ||
| }, | ||
| create(context) { | ||
| return { | ||
| ImportDeclaration(node) { | ||
| let isAutomergeProblem = false | ||
| if (node.source.value === "@automerge/automerge") { | ||
| isAutomergeProblem = true | ||
| } else if ( | ||
| node.source.value.startsWith("@automerge/automerge/") && | ||
| !node.source.value.startsWith("@automerge/automerge/slim") | ||
| ) { | ||
| isAutomergeProblem = true | ||
| } | ||
| if (isAutomergeProblem) { | ||
| context.report({ | ||
| node, | ||
| message: | ||
| "Import from @automerge/automerge/slim instead of @automerge/automerge", | ||
| }) | ||
| } | ||
|
|
||
| let isAutomergeRepoProblem = false | ||
| if (node.source.value === "@automerge/automerge-repo") { | ||
| isAutomergeRepoProblem = true | ||
| } else if ( | ||
| node.source.value.startsWith("@automerge/automerge-repo/") && | ||
| !node.source.value.startsWith("@automerge/automerge-repo/slim") | ||
| ) { | ||
| isAutomergeRepoProblem = true | ||
| } | ||
| if (isAutomergeRepoProblem) { | ||
| context.report({ | ||
| node, | ||
| message: | ||
| "Import from @automerge/automerge-repo/slim instead of @automerge/automerge-repo", | ||
| }) | ||
| } | ||
| }, | ||
| } | ||
| }, | ||
| } | ||
|
|
||
| export default [ | ||
| { | ||
| ignores: [ | ||
| "**/*.d.ts", | ||
| "**/*.config.ts", | ||
| "**/fuzz.ts", | ||
| "examples/**/*", | ||
| "**/test/*", | ||
| "**/dist/*", | ||
| "**/node_modules/*", | ||
| "**/.eslintrc.cjs", | ||
| "packages/create-vite-app/**/*", | ||
| "testSetup.ts", | ||
| ], | ||
| }, | ||
| js.configs.recommended, | ||
| ...compat.extends( | ||
| "plugin:@typescript-eslint/eslint-recommended", | ||
| "plugin:@typescript-eslint/recommended" | ||
| ), | ||
| { | ||
| ignores: [ | ||
| "packages/create-repo-node-app/postbuild.js", | ||
| "eslint.config.mjs", | ||
| ], | ||
| plugins: { | ||
| "@typescript-eslint": typescriptEslint, | ||
| "automerge-slimport": { | ||
| rules: { | ||
| "enforce-automerge-slim-import": automergeSlimImportRule, | ||
| }, | ||
| }, | ||
| }, | ||
|
|
||
| languageOptions: { | ||
| globals: { | ||
| ...globals.browser, | ||
| ...globals.node, | ||
| }, | ||
|
|
||
| parser: tsParser, | ||
| ecmaVersion: "latest", | ||
| sourceType: "module", | ||
|
|
||
| parserOptions: { | ||
| project: ["./packages/*/tsconfig.json"], | ||
| }, | ||
| }, | ||
|
|
||
| rules: { | ||
| semi: [2, "never"], | ||
| "import/extensions": 0, | ||
| "lines-between-class-members": 0, | ||
| "@typescript-eslint/no-floating-promises": 2, | ||
| "@typescript-eslint/no-empty-function": 0, | ||
| "no-param-reassign": 0, | ||
| "no-use-before-define": 0, | ||
| "@typescript-eslint/no-non-null-assertion": 0, | ||
| "@typescript-eslint/no-explicit-any": 0, | ||
|
|
||
| "@typescript-eslint/no-unused-vars": [ | ||
| 2, | ||
| { | ||
| varsIgnorePattern: "^_", | ||
| argsIgnorePattern: "^_", | ||
| }, | ||
| ], | ||
| "automerge-slimport/enforce-automerge-slim-import": 2, | ||
| }, | ||
| }, | ||
| { | ||
| files: [ | ||
| "packages/create-repo-node-app/postbuild.js", | ||
| "packages/create-vite-app/postbuild.js", | ||
| "packages/create-vite-app/test.js", | ||
| ], | ||
|
|
||
| languageOptions: { | ||
| globals: { | ||
| ...globals.node, | ||
| }, | ||
|
|
||
| ecmaVersion: 5, | ||
| sourceType: "commonjs", | ||
| }, | ||
| }, | ||
| ] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,11 @@ | ||
| export * from "../index.js" | ||
| // This triggers the various mechanisms in @automerge/automerge which attempt | ||
| // to figure out what kind of environment we are in and initialize the wasm | ||
| // blob correspondingly | ||
|
|
||
| // The following import triggers the various mechanisms in @automerge/automerge | ||
| // which attempt to figure out what kind of environment we are in and | ||
| // initialize the wasm blob correspondingly. Note that we have a custom eslint | ||
| // rule which would complain about the non-slim import here which we have to | ||
| // disable | ||
| // | ||
| // eslint-disable-next-line automerge-slimport/enforce-automerge-slim-import | ||
| import { next as Am } from "@automerge/automerge" | ||
| Am.init() |
Oops, something went wrong.