Build: Introduce local eslint rule for storybook node logger #31655
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
4 file(s) reviewed, 5 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -0,0 +1,111 @@ | |||
| module.exports = { | |||
| meta: { | |||
| type: 'problem', | |||
There was a problem hiding this comment.
logic: Rule type should be 'suggestion' since this is a code style preference, not a runtime error
| type: 'problem', | |
| type: 'suggestion', |
| CallExpression(node) { | ||
| if ( | ||
| node.callee.type === 'MemberExpression' && | ||
| node.callee.object.name === 'console' | ||
| ) { |
There was a problem hiding this comment.
logic: Missing check for computed properties (e.g. console['log']). This allows bypassing the rule
| // Add import if missing | ||
| if (!loggerImported) { | ||
| if (importNode) { | ||
| const last = importNode.specifiers[importNode.specifiers.length - 1]; | ||
| fixes.push(fixer.insertTextAfter(last, ', logger')); | ||
| } else { | ||
| fixes.push( | ||
| fixer.insertTextBeforeRange( | ||
| [0, 0], | ||
| "import { logger } from 'storybook/internal/node-logger';\n" | ||
| ) | ||
| ); | ||
| } | ||
| } |
There was a problem hiding this comment.
style: Duplicate code block from lines 54-66. Extract to a shared helper function
| excludedFiles: [ | ||
| 'core/node-logger/**/*.ts', | ||
| 'core/client-logger/**/*.ts', | ||
| '**/*.test.*', | ||
| '**/*.spec.*', | ||
| '**/*.mockdata.*', | ||
| ], |
There was a problem hiding this comment.
style: Redundant exclusion of test/spec files - already excluded in files pattern above with !/.test. and !/.spec.
| excludedFiles: [ | |
| 'core/node-logger/**/*.ts', | |
| 'core/client-logger/**/*.ts', | |
| '**/*.test.*', | |
| '**/*.spec.*', | |
| '**/*.mockdata.*', | |
| ], | |
| excludedFiles: [ | |
| 'core/node-logger/**/*.ts', | |
| 'core/client-logger/**/*.ts', | |
| '**/*.mockdata.*', | |
| ], |
| - Automatically add `import { logger } from 'node-logger'` when needed | ||
| - **Why**: Promotes consistent logging across the codebase using Storybook's logger. The logger has log level and tracking capabilities, which is important for debugging purposes and keeps the user experience consistent as well. |
There was a problem hiding this comment.
style: The 'Why' point is formatted inconsistently with the bullet points above it (using bold markdown instead of a dash prefix)
|
View your CI Pipeline Execution ↗ for commit f93449e.
☁️ Nx Cloud last updated this comment at |
Closes #
What I did
Checklist for Contributors
Testing
The changes in this PR are covered in the following automated tests:
Manual testing
This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!
Documentation
MIGRATION.MD
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli-storybook/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
Introduces a new ESLint rule 'enforce-node-logger' to ensure consistent usage of Storybook's node-logger instead of console methods throughout the codebase.
enforce-node-logger.jsrule implementation with auto-fix capabilities for both direct console usage and logger assignmentscode/.eslintrc.jsto target specific TypeScript files with 'error' severityREADME.mdexplaining the rule's purpose and behavior