build(deps): bump actions/setup-node from 2 to 6#441
Conversation
67b5925 to
bafa092
Compare
| @@ -1,70 +1,70 @@ | |||
| import type { StorybookConfig } from '@storybook/react-vite'; | |||
There was a problem hiding this comment.
What: Ensure that all necessary Storybook dependencies are up to date and compatible with version 6.
Why: Using outdated dependencies may introduce security vulnerabilities and affect the functionality. Keeping dependencies up to date is critical for maintaining security and compatibility.
How: Review the dependencies listed in the Storybook configuration and compare their versions with the latest ones released on npm or the respective repositories.
| /** @type { import('@storybook/react-webpack5').StorybookConfig } */ | ||
| const config: StorybookConfig = { | ||
| stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'], |
There was a problem hiding this comment.
What: Verify that the migration from Webpack to Vite preserves all necessary functionalities and optimizations.
Why: This is a significant change in the framework, and it could introduce performance issues or bugs if not done carefully. Proper testing after the migration is essential.
How: Run the complete storybook setup with the new configuration and ensure all stories render correctly. Check for any warnings or errors that might indicate misconfigurations.
| }, | ||
| }, | ||
| }); | ||
| }, |
There was a problem hiding this comment.
What: Make sure to test the viteFinal function behavior, particularly the plugin filtering logic.
Why: Inadvertently removing essential plugins can lead to broken builds or distorted UIs in Storybook setups.
How: Write test cases to simulate various configurations and validate that the essential plugins remain intact after the filter operation.
| 'src/utilities' | ||
| ), | ||
| '@/components': path.resolve( | ||
| __dirname, |
There was a problem hiding this comment.
What: Consider adding comments or documentation detailing custom configurations applied to the Vite setup.
Why: Clear documentation helps future developers understand the rationale behind certain configuration choices, making it easier for them to maintain or further modify the code in the future.
How: Incorporate inline comments or a dedicated section in the README to explain the purpose of specific configurations and adjustments.
| @@ -1,70 +1,70 @@ | |||
| import type { StorybookConfig } from '@storybook/react-vite'; | |||
| import path from 'path'; | |||
|
|
|||
There was a problem hiding this comment.
What: Ensure that this configuration adheres to the latest best practices for Storybook and Vite integration.
Why: Adhering to the best practices helps prevent potential issues in the future as both tools continue to evolve.
How: Consult the official Storybook and Vite documentation for the latest recommendations regarding their integration and check if any changing practices apply to your configuration.
| @@ -1,30 +1,30 @@ | |||
| import React from 'react'; | |||
There was a problem hiding this comment.
What: Avoid disabling accessibility rules globally without justification.
Why: Disabling the 'color-contrast' rule universally can lead to accessibility issues for users with visual impairments. It's important to ensure that color contrast meets accessibility standards, helping to create a more inclusive experience for all users.
How: Instead of disabling the rule globally, consider addressing any color contrast issues in your components directly. If there are specific instances where you want to disable the rule, document why that is necessary for those specific cases.
|
|
||
| const preview: Preview = { | ||
| parameters: { | ||
| controls: { |
There was a problem hiding this comment.
What: Consider adding comments that clarify the use of specific decorators or configurations.
Why: Not everyone may be familiar with the use of Storybook decorators or the structure of your configuration. Adding comments can help future developers understand the purpose behind certain configurations.
How: Add comments above the decorators section and relevant parameters to explain their purpose, especially regarding custom styling or configuration for accessibility.
| // Disable color contrast checks for the entire storybook. | ||
| a11y: { | ||
| config: { | ||
| rules: [{ id: 'color-contrast', enabled: false }], |
There was a problem hiding this comment.
What: Review the use of Tailwind CSS utility classes for compatibility and responsiveness.
Why: Using Tailwind CSS classes should align with best practices for maintaining responsiveness and custom styling rules. Ensure that the utility classes adhere to the project's design standards.
How: Ensure that the styles you define with Tailwind CSS are compatible across different screens and devices. Consider testing on multiple screen sizes and providing additional styles if necessary for responsiveness.
| @@ -1,30 +1,30 @@ | |||
| const { getStoryContext } = require('@storybook/test-runner'); | |||
There was a problem hiding this comment.
What: Check if axe-playwright injects different dependencies across versions.
Why: New versions might have deprecated methods or changed the way they function which could lead to unexpected results during accessibility checks.
How: Visit the axe-playwright release notes and verify if the injectAxe method has any new required parameters or changes.
| if (storyContext.parameters?.a11y?.disable) { | ||
| return; | ||
| } | ||
There was a problem hiding this comment.
What: Ensure that 'storyContext' is properly defined before invoking its properties.
Why: Accessing properties of an undefined object can lead to runtime errors and might break the accessibility checks being performed.
How: Add a validation statement to check if 'storyContext' is defined before attempting to access storyContext.parameters?.a11y.
| await configureAxe(page, { | ||
| rules: storyContext.parameters?.a11y?.config?.rules, | ||
| }); | ||
There was a problem hiding this comment.
What: Consider adding error handling in case of failed accessibility checks with checkA11y.
Why: Robust error handling will provide relevant feedback and prevent potential disruptions in the testing flow when an accessibility issue is encountered.
How: Wrap the 'await checkA11y(...)` in a try-catch block to log or handle errors gracefully.
| }); | ||
| // Do not run a11y tests on disabled stories. | ||
| if (storyContext.parameters?.a11y?.disable) { |
There was a problem hiding this comment.
What: Check if detailedReportOptions is suitable for all reports being generated.
Why: Different accessibility requirements may need different reporting styles or levels of detail depending on the complexity of the stories.
How: Consider making the detailedReportOptions configurable or provide more context on when to apply different reporting levels.
Bumps actions/setup-node from 2 to 6.
Release notes
Sourced from actions/setup-node's releases.
... (truncated)
Commits
48b55a0Update Node.js versions in versions.yml and bump package to v6.4.0 (#1533)ab72c7eUpgrade@actionsdependencies (#1525)53b8394Bump minimatch from 3.1.2 to 3.1.5 (#1498)54045abScope test lockfiles by package manager and update cache tests (#1495)c882bffReplace uuid with crypto.randomUUID() (#1378)774c1d6feat(node-version-file): support parsingdevEnginesfield (#1283)efcb663fix: remove hardcoded bearer (#1467)d02c89dFix npm audit issues (#1491)6044e13Docs: bump actions/checkout from v5 to v6 (#1468)8e49463Fix README typo (#1226)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)