feat(repo): Add eslint-plugin-tree-shaking

eslint.config.mjs

@@ -1,6 +1,7 @@
 import eslint from '@eslint/js';
 import configPrettier from 'eslint-config-prettier';
 import configTurbo from 'eslint-config-turbo/flat';
+import pluginTreeShaking from '@clerk/eslint-plugin-tree-shaking';
 import pluginImport from 'eslint-plugin-import';
 import pluginJest from 'eslint-plugin-jest';
 import pluginJsDoc from 'eslint-plugin-jsdoc';
@@ -406,6 +407,14 @@ export default tseslint.config([
       '@typescript-eslint/no-floating-promises': 'warn',
     },
   },
+  {
+    name: 'packages/react',
+    files: ['packages/react/src/**/*'],
+    ...pluginTreeShaking.configs.recommended,
+    rules: {
+      'tree-shaking/no-side-effects-in-initialization': 'warn',
+    },
+  },
   {
     name: 'repo/integration',
     ...pluginPlaywright.configs['flat/recommended'],

package.json

@@ -69,6 +69,7 @@
     "@changesets/cli": "^2.29.4",
     "@changesets/get-github-info": "^0.6.0",
     "@clerk/backend": "workspace:*",
+    "@clerk/eslint-plugin-tree-shaking": "workspace:*",
     "@clerk/shared": "workspace:*",
     "@clerk/testing": "workspace:*",
     "@commitlint/cli": "^19.8.0",

packages/eslint-plugin-tree-shaking/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Clerk, Inc.
+Copyright (c) 2016 Lukas Taegert
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/eslint-plugin-tree-shaking/README.md

@@ -0,0 +1,18 @@
+<p align="center">
+  <a href="https://clerk.com?utm_source=github&utm_medium=clerk_types" target="_blank" rel="noopener noreferrer">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://images.clerk.com/static/logo-dark-mode-400x400.png">
+      <img src="https://images.clerk.com/static/logo-light-mode-400x400.png" height="64">
+    </picture>
+  </a>
+  <br />
+  <h1 align="center">@clerk/eslint-plugin-tree-shaking</h1>
+</p>
+
+---
+
+## License and Credits
+
+This project is licensed under the **MIT license**, and is a fork of the [`eslint-plugin-tree-shaking`](https://github.com/lukastaegert/eslint-plugin-tree-shaking) library written by Lukas Taegert.
+
+See [LICENSE](https://github.com/clerk/javascript/blob/main/packages/eslint-plugin-tree-shaking/LICENSE) for more information.

packages/eslint-plugin-tree-shaking/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@clerk/eslint-plugin-tree-shaking",
+  "version": "0.0.1",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "@types/estree": "^1.0.8",
+    "@types/estree-jsx": "^1.0.5",
+    "eslint": "9.31.0"
+  }
+}

packages/eslint-plugin-tree-shaking/src/index.ts

@@ -0,0 +1,21 @@
+import type { ESLint } from 'eslint';
+import { noSideEffectsInInitialization } from './rules/no-side-effects-in-initialization.js';
+
+const plugin: ESLint.Plugin = {
+  meta: {
+    name: 'tree-shaking',
+  },
+  configs: {},
+  rules: {
+    'no-side-effects-in-initialization': noSideEffectsInInitialization,
+  },
+};
+
+Object.assign((plugin.configs ??= {}), {
+  recommended: {
+    plugins: { 'tree-shaking': plugin },
+    rules: { 'tree-shaking/no-side-effects-in-initialization': 'error' },
+  },
+});
+
+export default plugin;