Skip to content
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.

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

Spike/story book accessibility ci #19

Merged
merged 15 commits into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
1ad6601
spike(storyBookAccessibilityCI): Added need libraries
jarvisraymond-uchicago Jan 6, 2025
b241587
spike(storyBookAccessibilityCI): Updated yaml for CI and added ESLINT…
jarvisraymond-uchicago Jan 7, 2025
eae3419
spike(storyBookAccessibilityCI): resolved accessibility issues to che…
jarvisraymond-uchicago Jan 7, 2025
88724ab
spike(storyBookAccessibilityCI): added tailwind styles, support for S…
jarvisraymond-uchicago Jan 8, 2025
dde5364
spike(storyBookAccessibilityCI): added tests for HealButtonLink, fixe…
jarvisraymond-uchicago Jan 8, 2025
609449e
spike(storyBookAccessibilityCI): fixed eslint errors in HEALBUTTONLINK
jarvisraymond-uchicago Jan 8, 2025
941bafb
spike(storyBookAccessibilityCI): updated ci.yaml
jarvisraymond-uchicago Jan 8, 2025
47f676a
spike(storyBookAccessibilityCI): Added tests and stories
jarvisraymond-uchicago Jan 9, 2025
cf77d09
spike(storyBookAccessibilityCI): Removed boiler plate files
jarvisraymond-uchicago Jan 10, 2025
33d8c93
spike(storyBookAccessibilityCI): Updated unit tests to pass
jarvisraymond-uchicago Jan 14, 2025
9e95fa6
Merge branch 'main' into spike/storyBookAccessibilityCI
jarvisraymond-uchicago Jan 14, 2025
b5af99d
spike(storyBookAccessibilityCI): Added storybook story for Quote Spot…
jarvisraymond-uchicago Jan 14, 2025
6cd662c
spike(storyBookAccessibilityCI): Removed unneeded import to fix lint …
jarvisraymond-uchicago Jan 14, 2025
3ce9250
spike(storyBookAccessibilityCI): Fixed storybook story test logic
jarvisraymond-uchicago Jan 14, 2025
90d1c24
spike(storyBookAccessibilityCI): Fixed lint issue
jarvisraymond-uchicago Jan 14, 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
10 changes: 1 addition & 9 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,7 @@ module.exports = {
es2021: true,
node: true,
},
extends: [
'eslint:recommended',
'plugin:jsx-a11y/recommended',
'plugin:react/recommended',
'plugin:react-hooks/recommended',
'plugin:@typescript-eslint/recommended',
'plugin:@next/next/recommended',
'prettier',
],
extends: ['eslint:recommended', 'plugin:jsx-a11y/recommended', 'plugin:react/recommended', 'plugin:react-hooks/recommended', 'plugin:@typescript-eslint/recommended', 'plugin:@next/next/recommended', 'prettier', 'plugin:storybook/recommended'],
parser: '@typescript-eslint/parser',
parserOptions: {
ecmaFeatures: {
Expand Down
20 changes: 20 additions & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
name: CI
on: push
jobs:
interaction-and-accessibility:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 20
- name: Install dependencies
run: npm install
- name: Install Playwright
run: npx playwright install --with-deps
- name: Build Storybook
run: npm run build-storybook --quiet
- name: Serve Storybook and run tests
run: |
npx concurrently -k -s first -n "SB,TEST" -c "magenta,blue" \
"npx http-server storybook-static --port 6006 --silent" \
"npx wait-on tcp:6006 && yarn test-storybook"
build:
runs-on: ubuntu-latest
steps:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,5 @@ yarn-error.log*
# typescript
*.tsbuildinfo
next-env.d.ts

*storybook.log
38 changes: 38 additions & 0 deletions .storybook/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import type { StorybookConfig } from '@storybook/nextjs';

const config: StorybookConfig = {
stories: ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|mjs|ts|tsx)'],
addons: [
'@storybook/addon-onboarding',
'@storybook/addon-essentials',
'@chromatic-com/storybook',
'@storybook/addon-interactions',
'@storybook/addon-a11y',
],
framework: {
name: '@storybook/nextjs',
options: {},
},
staticDirs: ['../public'],
webpackFinal: async (config) => {
const imageRule = config.module?.rules?.find((rule) => {
const test = (rule as { test: RegExp }).test;

if (!test) {
return false;
}

return test.test('.svg');
}) as { [key: string]: any };

imageRule.exclude = /\.svg$/;

config.module?.rules?.push({
test: /\.svg$/,
use: ['@svgr/webpack'],
});

return config;
},
};
export default config;
25 changes: 25 additions & 0 deletions .storybook/preview.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import React from 'react';
import type { Preview } from '@storybook/react';
import { MantineProvider } from '@mantine/core';
import '../src/styles/globals.css';

const preview: Preview = {
parameters: {
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/i,
},
},
},
tags: ['autodocs'],
decorators: [
(Story) => (
<MantineProvider>
<Story />
</MantineProvider>
),
],
};

export default preview;
22 changes: 22 additions & 0 deletions .storybook/test-runner.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import type { TestRunnerConfig } from '@storybook/test-runner';
import { injectAxe, checkA11y } from 'axe-playwright';

/*
* See https://storybook.js.org/docs/writing-tests/test-runner#test-hook-api
* to learn more about the test-runner hooks API.
*/
const config: TestRunnerConfig = {
async preVisit(page) {
await injectAxe(page);
},
async postVisit(page) {
await checkA11y(page, '#storybook-root', {
detailedReport: true,
detailedReportOptions: {
html: true,
},
});
},
};

export default config;
Loading
Loading