Skip to content

ref: eslint-plugin-boundaries #92031

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

ref: eslint-plugin-boundaries #92031

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d83e8a8
ref: eslint-plugin-boundaries
TkDodo May 21, 2025
1b85c9e
ref: comment in what was commented out for testing
TkDodo May 21, 2025
7030cf1
Merge branch 'master' into tkdodo/ref/eslint-plugin-boundaries
TkDodo May 21, 2025
80b488e
feat: story-files can import from story-book
TkDodo May 22, 2025
8a85327
Merge branch 'master' into tkdodo/ref/eslint-plugin-boundaries
TkDodo May 23, 2025
84c8379
fix: story-book
TkDodo May 23, 2025
7640f38
feat: test boundaries
TkDodo May 23, 2025
26986c5
Merge branch 'master' into tkdodo/ref/eslint-plugin-boundaries
TkDodo May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 196 additions & 0 deletions eslint.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ import pluginQuery from '@tanstack/eslint-plugin-query';
import {globalIgnores} from 'eslint/config';
import prettier from 'eslint-config-prettier';
// @ts-expect-error TS(7016): Could not find a declaration file
import boundaries from 'eslint-plugin-boundaries';
// @ts-expect-error TS(7016): Could not find a declaration file
import importPlugin from 'eslint-plugin-import';
import jest from 'eslint-plugin-jest';
import jestDom from 'eslint-plugin-jest-dom';
Expand Down Expand Up @@ -976,4 +978,198 @@ export default typescript.config([
'no-restricted-imports': 'off',
},
},
{
name: 'plugin/boundaries',
plugins: {
boundaries,
},
settings: {
// order matters here because of nested directories
'boundaries/elements': [
// --- stories ---
{
type: 'story-files',
pattern: 'static/**/*.stories.{ts,tsx}',
mode: 'full',
},
{
type: 'story-book',
pattern: 'static/app/stories',
},
// --- tests ---
{
type: 'test-sentry',
pattern: [
'static/app/**/*.spec.{ts,js,tsx,jsx}',
'tests/js/sentry-test/**/*.*',
'static/app/**/*{t,T}estUtils*.{js,mjs,ts,tsx}',
],
mode: 'full',
},
{
type: 'test-getsentry',
pattern: [
'static/gsApp/**/*.spec.{ts,js,tsx,jsx}',
'tests/js/getsentry-test/**/*.*',
],
mode: 'full',
},
{
type: 'test-gsAdmin',
pattern: ['static/gsAdmin/**/*.spec.{ts,js,tsx,jsx}'],
mode: 'full',
},
{
type: 'test',
pattern: 'tests/js',
},
// --- specifics ---
{
type: 'devtoolbar',
pattern: 'sentry/components/devtoolbar',
},
{
type: 'core-button',
pattern: 'static/app/components/core/button',
},
{
type: 'core',
pattern: 'static/app/components/core',
},
Comment on lines +1032 to +1038
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: we can remove core-button once we’ve isolated everything in core. core-button is a separate group now so that we get fewer violations. Since we match with core*, both groups are included.

// --- sentry ---
{
type: 'sentry-images',
pattern: 'static/images',
},
{
type: 'sentry-locale',
pattern: '(static/app/locale.tsx|src/sentry/locale/**/*.*)',
mode: 'full',
},
{
type: 'sentry-logos',
pattern: 'src/sentry/static/sentry/images/logos',
},
{
type: 'sentry-fonts',
pattern: 'static/fonts',
},
{
type: 'sentry-fixture',
pattern: 'tests/js/fixtures',
},
{
type: 'sentry',
pattern: 'static/app',
},
// --- getsentry ---
{
type: 'getsentry',
pattern: 'static/gsApp',
},
// --- admin ---
{
type: 'gsAdmin',
pattern: 'static/gsAdmin',
},
// --- configs ---
{
type: 'configs',
pattern: '(package.json|config/**/*.*|*.config.{mjs,js,ts})',
mode: 'full',
},
{
type: 'build-utils',
pattern: 'build-utils',
},
{
type: 'scripts',
pattern: 'scripts',
},
],
},
rules: {
...boundaries.configs.strict.rules,
'boundaries/no-ignored': 'off',
'boundaries/no-private': 'off',
'boundaries/element-types': [
'warn',
{
default: 'disallow',
message: '${file.type} is not allowed to import ${dependency.type}',
rules: [
{
from: ['sentry*'],
allow: ['core*', 'sentry*'],
Comment on lines +1102 to +1103
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from and allow are micromatch patterns matched against the type defined in the above settings. I’ve “grouped” all sentry app related things as ”sentry-“ so that we can target them with ”sentry*” here.

So this means: sentry can import from sentry (itself) and from everything core, and since the default is disallow, everything else is forbidden and will yield a warning.

},
{
from: ['getsentry*'],
allow: ['core*', 'getsentry*', 'sentry*'],
},
{
from: ['gsAdmin*'],
disallow: ['sentry-locale'],
allow: ['core*', 'gsAdmin*', 'sentry*', 'getsentry*'],
},
{
from: ['devtoolbar'],
allow: ['devtoolbar', 'sentry*'],
},
{
from: ['test-sentry'],
allow: ['test-sentry', 'test', 'core*', 'sentry*'],
},
{
// todo does test-gesentry need test-sentry?
from: ['test-getsentry'],
allow: [
'test-getsentry',
'test-sentry',
'test',
'core*',
'getsentry*',
'sentry*',
],
},
{
from: ['test-gsAdmin'],
allow: [
'test-gsAdmin',
'test-getsentry',
'test-sentry',
'test',
'core*',
'gsAdmin*',
'sentry*',
'getsentry*',
],
},
{
from: ['test'],
allow: ['test', 'test-sentry', 'sentry*'],
},
{
from: ['configs'],
allow: ['configs', 'build-utils'],
},
// --- stories ---
{
from: ['story-files', 'story-book'],
allow: ['core*', 'sentry*', 'story-book'],
},
// --- core ---
{
from: ['core-button'],
allow: ['core*'],
},
// todo: sentry* shouldn't be allowed
{
from: ['core'],
allow: ['core*', 'sentry*'],
},
],
},
],
},
},
]);
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@
"eslint": "^9.22.0",
"eslint-config-prettier": "^10.1.2",
"eslint-import-resolver-typescript": "^3.8.3",
"eslint-plugin-boundaries": "^5.0.1",
"eslint-plugin-import": "^2.31.0",
"eslint-plugin-jest": "^28.11.0",
"eslint-plugin-jest-dom": "^5.5.0",
Expand Down
2 changes: 1 addition & 1 deletion static/app/views/explore/spans/spansTab.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ import {
} from 'sentry/views/explore/utils';
import {Onboarding} from 'sentry/views/performance/onboarding';

// eslint-disable-next-line no-restricted-imports
// eslint-disable-next-line no-restricted-imports,boundaries/element-types
import QuotaExceededAlert from 'getsentry/components/performance/quotaExceededAlert';

interface SpansTabOnboardingProps {
Expand Down
16 changes: 13 additions & 3 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7037,7 +7037,7 @@ eslint-config-prettier@^10.1.2:
resolved "https://registry.yarnpkg.com/eslint-config-prettier/-/eslint-config-prettier-10.1.2.tgz#31a4b393c40c4180202c27e829af43323bf85276"
integrity sha512-Epgp/EofAUeEpIdZkW60MHKvPyru1ruQJxPL+WIycnaPApuseK0Zpkrh/FwL9oIpQvIhJwV7ptOy0DWUjTlCiA==

eslint-import-resolver-node@^0.3.9:
eslint-import-resolver-node@0.3.9, eslint-import-resolver-node@^0.3.9:
version "0.3.9"
resolved "https://registry.yarnpkg.com/eslint-import-resolver-node/-/eslint-import-resolver-node-0.3.9.tgz#d4eaac52b8a2e7c3cd1903eb00f7e053356118ac"
integrity sha512-WFj2isz22JahUv+B788TlO3N6zL3nNJGU8CcZbPZvVEkBPaJdCV4vy5wyghty5ROFbCRnm132v8BScu5/1BQ8g==
Expand All @@ -7059,13 +7059,23 @@ eslint-import-resolver-typescript@^3.8.3:
stable-hash "^0.0.4"
tinyglobby "^0.2.12"

eslint-module-utils@^2.12.0:
eslint-module-utils@2.12.0, eslint-module-utils@^2.12.0:
version "2.12.0"
resolved "https://registry.yarnpkg.com/eslint-module-utils/-/eslint-module-utils-2.12.0.tgz#fe4cfb948d61f49203d7b08871982b65b9af0b0b"
integrity sha512-wALZ0HFoytlyh/1+4wuZ9FJCD/leWHQzzrxJ8+rebyReSLk7LApMyd3WJaLVoN+D5+WIdJyDK1c6JnE65V4Zyg==
dependencies:
debug "^3.2.7"

eslint-plugin-boundaries@^5.0.1:
version "5.0.1"
resolved "https://registry.yarnpkg.com/eslint-plugin-boundaries/-/eslint-plugin-boundaries-5.0.1.tgz#7603c7d57c4d6ac8a7f24db4ff810dba03ddb217"
integrity sha512-QBw1TgoA3JnD+AQ8EHqZL8LtiFVREnFmD2BnHzVl38UKtRTds8rawIg03ZLwFs/90yKSh+DVVXRpvVK631Z/0w==
dependencies:
chalk "4.1.2"
eslint-import-resolver-node "0.3.9"
eslint-module-utils "2.12.0"
micromatch "4.0.8"

eslint-plugin-import@^2.31.0:
version "2.31.0"
resolved "https://registry.yarnpkg.com/eslint-plugin-import/-/eslint-plugin-import-2.31.0.tgz#310ce7e720ca1d9c0bb3f69adfd1c6bdd7d9e0e7"
Expand Down Expand Up @@ -10274,7 +10284,7 @@ micromark@^4.0.0:
micromark-util-symbol "^2.0.0"
micromark-util-types "^2.0.0"

micromatch@^4.0.2, micromatch@^4.0.4, micromatch@^4.0.8:
micromatch@4.0.8, micromatch@^4.0.2, micromatch@^4.0.4, micromatch@^4.0.8:
version "4.0.8"
resolved "https://registry.yarnpkg.com/micromatch/-/micromatch-4.0.8.tgz#d66fa18f3a47076789320b9b1af32bd86d9fa202"
integrity sha512-PXwfBhYu0hBCPw8Dn0E+WDYb7af3dSLVWKi3HGv84IdF4TyFoC0ysxFd0Goxw7nSv4T/PzEJQxsYsEiFCKo2BA==
Expand Down
Loading