@acot/acot-runner-storybook
Advanced tools
Changelog
0.0.10-canary.0 (2021-04-04)
debug package (85f8ea4)init subcommand (982553b)BrowserPool hangs (93da5cb)--(reporter|runner)-with options (64944e1)--no-open options for preset serve sub-command (0a43e58)@acot/sitemap to init sub-command (336196a)verbose flag (0cd3e16)GET request instead of HEAD request #34 (5a48d8a)BrowserPool (21f7228)help from tags (7ac5678)pattern to specify test target (67c319f)@acot/acot-runner-sitemap package (9a760b7)@acot/mock package (fb6e4ba)acot-head flag to test <head> in rule documentation (a1c5760)page-has-title rule (4353cab)page-has-valid-lang rule (8ee766c)Readme
An acot custom runner for Storybook.
The @acot/acot-runner-storybook crawls all the Stories in Storybook and sets them up for acot to audit.
Install via npm:
$ npm install --save-dev @acot/acot-runner-storybook
Add @acot/storybook to the runner field of the configuration file.
{
"runner": "@acot/storybook"
}
You can pass a custom config to the parameters.acot field in Story's metadata, as in the following example:
// Component Story Format (CSF) Example:
export default {
title: 'Button',
component: Button,
parameters: {
acot: {
rules: {
'@acot/wcag/button-has-name': 'off',
},
},
},
};
includeType: string[]
Required: false
The Story name pattern to include in the audit target. See the micromatch documentation for pattern strings.
{
"runner": {
"uses": "@acot/storybook",
"with": {
"include": ["*", "/atoms/**/*"]
}
}
}
excludeType: string[]
Required: false
The Story name pattern to exclude in the audit target. See the micromatch documentation for pattern strings.
{
"runner": {
"uses": "@acot/storybook",
"with": {
"exclude": ["/utils/**/*"]
}
}
}
Since @acot/acot-runner-storybook doesn't rely on UI frameworks like React, Angular, or Vue.js, it can be used in conjunction with any UI framework of your choice!
FAQs
An acot custom runner for Storybook.
The npm package @acot/acot-runner-storybook receives a total of 85 weekly downloads. As such, @acot/acot-runner-storybook popularity was classified as not popular.
We found that @acot/acot-runner-storybook demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.