Add addon-a11y to monorepo #2292

ndelangen · 2017-11-11T21:10:13Z

Closes: storybook-eol/storybook-addon-a11y#14

What I did

Merged in the a11y addon into the monorepo

How to test

It's used in the cra-kitchen-sink

* Add Button example * Add semicolon behind import * Add Image example * Add Form examples * Add Typography examples

This allows us to test against the original html structure with storyshot’s snapshot testing.

Changed some "you're" in "your"

danielduan

Fix up those references to the old package name and move the package Storybook over to our CRA.

I think it's good to take a pass and see if this work with React 16 too. I don't see anything obvious that would break, but more testing is always good.

danielduan · 2017-11-11T22:08:17Z

addons/a11y/.storybook/components/Button/stories.js

+const text = Faker.lorem.words();
+
+storiesOf('<Button />', module)
+  .addDecorator(checkA11y)


I think these a11y stories should be moved over to CRA so we can test them together.

Added, will leave the old storybook, because might copy over some more stories later.

danielduan · 2017-11-11T22:11:17Z

addons/a11y/README.md

+First, install the addon.
+
+```sh
+$ npm install -D storybook-addon-a11y


new package name?

danielduan · 2017-11-11T22:11:41Z

addons/a11y/README.md

+import React from 'react';
+import { storiesOf } from '@storybook/react';
+
+import { checkA11y } from 'storybook-addon-a11y';


danielduan · 2017-11-11T22:12:53Z

addons/a11y/package.json

+  "dependencies": {
+    "@storybook/react": "^3.2.14",
+    "axe-core": "^2.0.7",
+    "prop-types": "^15.5.10"


peer dep? also this shouldn't require @storybook/react

Hypnosphi · 2017-11-11T23:14:47Z

addons/a11y/.gitignore

@@ -0,0 +1,3 @@
+node_modules
+coverage
+dist


Looks like it's all covered by root .gitignore

codecov · 2017-11-11T23:32:18Z

Codecov Report

Merging #2292 into master will decrease coverage by 0.94%.
The diff coverage is 0%.

@@            Coverage Diff             @@
##           master    #2292      +/-   ##
==========================================
- Coverage   22.14%   21.19%   -0.95%     
==========================================
  Files         268      283      +15     
  Lines        5893     6156     +263     
  Branches      710      724      +14     
==========================================
  Hits         1305     1305              
- Misses       4060     4302     +242     
- Partials      528      549      +21

Impacted Files	Coverage Δ
addons/a11y/src/components/Report/Elements.js	`0% <0%> (ø)`
addons/a11y/register.js	`0% <0%> (ø)`
addons/a11y/src/components/Report/Item.js	`0% <0%> (ø)`
addons/a11y/src/components/Tabs.js	`0% <0%> (ø)`
addons/a11y/src/components/Report/index.js	`0% <0%> (ø)`
addons/a11y/src/components/Report/Info.js	`0% <0%> (ø)`
addons/a11y/src/register.js	`0% <0%> (ø)`
addons/a11y/src/A11yManager.js	`0% <0%> (ø)`
addons/a11y/manager.js	`0% <0%> (ø)`
addons/a11y/src/components/WrapStory.js	`0% <0%> (ø)`
... and 46 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7a1f7c4...0f30fc9. Read the comment docs.

ndelangen · 2017-11-11T23:42:04Z

Added a simple example to cra-kitchen-sink:

ndelangen · 2017-11-11T23:44:45Z

Seems to work fine with React 16.1.x!

Hypnosphi · 2017-11-12T17:34:57Z

addons/a11y/register.js

@@ -0,0 +1,3 @@
+// NOTE: loading addons using this file is deprecated!


danielduan · 2017-11-13T19:04:27Z

Code looks good to go, you'll need to rebase and the tests though.

# Conflicts: # yarn.lock

ndelangen · 2017-11-13T22:30:26Z

Should be OK to merge now, @Hypnosphi doe you agree?

Hypnosphi · 2017-11-13T23:25:35Z

examples/cra-kitchen-sink/src/stories/addon-a11y.stories.js

+
+storiesOf('Addon a11y', module)
+  .addDecorator(checkA11y)
+  .add('Default', () => <BaseButton />)


This produces a propType warning:

Warning: Failed prop type: The prop `label` is marked as required in `BaseButton`, but its value is `undefined`

Jaco Bovenschen and others added 14 commits November 11, 2017 22:00

Initial commit

2a434dd

Fix wrong import in manager.js

12d989e

Remove unused preview.js file

eb76e63

Correct main entry

0d67ae2

Export shared variables in entry point

fae8834

Create more example stories (#1)

0266c97

* Add Button example * Add semicolon behind import * Add Image example * Add Form examples * Add Typography examples

Bump version to 0.0.4

17acba5

Update to use Storybook v3. Closes #7

980468b

Prepare for release

c2aacec

Fix git repo paths in package.json

7bd40cf

Get rid of extra span

8d4f74b

This allows us to test against the original html structure with storyshot’s snapshot testing.

Prepare for release

ea9ac1a

Fixed typos in README.md

f3a8e48

Changed some "you're" in "your"

RENAME package & SYNC versions with monorepo && CHANGE readme

6fdc4e3

ndelangen self-assigned this Nov 11, 2017

ndelangen requested review from jbovenschen and a team November 11, 2017 21:10

ndelangen added the addon: a11y label Nov 11, 2017

danielduan requested changes Nov 11, 2017

View reviewed changes

ndelangen added 2 commits November 11, 2017 23:37

FIX versions & dependencies for addon-a11y

986e552

FIX incorrect package names in readme

607f37d

ndelangen force-pushed the add-addon-a11y branch from da47b56 to 607f37d Compare November 11, 2017 22:38

Merge branch 'master' into add-addon-a11y

1561f54

Hypnosphi requested changes Nov 11, 2017

View reviewed changes

addons/a11y/.gitignore Outdated

@@ -0,0 +1,3 @@

node_modules

coverage

dist

Copy link

Member

Hypnosphi Nov 11, 2017

Choose a reason for hiding this comment

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

Looks like it's all covered by root .gitignore

ndelangen added 5 commits November 12, 2017 00:17

DELETE unnecessary files

90f1711

Linting

88a8f00

Remove most devDependencies

56d13ef

lockfile

90e8857

Linting

5792e09

ADD story for addon-a11y to cra-kitchen-sink

c3cfd7b

Hypnosphi reviewed Nov 12, 2017

View reviewed changes

addons/a11y/register.js Outdated

@@ -0,0 +1,3 @@

// NOTE: loading addons using this file is deprecated!

Copy link

Member

Hypnosphi Nov 12, 2017

Choose a reason for hiding this comment

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

Why?

danielduan approved these changes Nov 13, 2017

View reviewed changes

Linting

3bf698c

ndelangen force-pushed the add-addon-a11y branch from 9cf2947 to 3bf698c Compare November 13, 2017 21:02

ndelangen added 5 commits November 13, 2017 22:18

ADD snapshots for new stories

862d4cf

Merge branch 'master' into add-addon-a11y

56c14a2

# Conflicts: # yarn.lock

FIX fonts (from lib/components)

5ec50a8

IMPROVE tabs visually

966c605

CHANGE simplify addon namespace

857d84d

ndelangen added the feature request label Nov 13, 2017

FIX lockfile

0f30fc9

Hypnosphi approved these changes Nov 13, 2017

View reviewed changes

ndelangen mentioned this pull request Nov 13, 2017

Need to customise aXe options storybook-eol/storybook-addon-a11y#4

Closed

ndelangen merged commit e3239ee into master Nov 13, 2017

ndelangen deleted the add-addon-a11y branch November 13, 2017 22:54

Hypnosphi reviewed Nov 13, 2017

View reviewed changes

ndelangen mentioned this pull request Nov 14, 2017

FIX propwarning on basebutton && ADD style prop on basebutton #2305

Merged

dependencies bot mentioned this pull request Apr 16, 2018

Update 63 dependencies from npm #3429

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add addon-a11y to monorepo #2292

Add addon-a11y to monorepo #2292

ndelangen commented Nov 11, 2017 •

edited

Loading

danielduan left a comment

danielduan Nov 11, 2017

ndelangen Nov 11, 2017

ndelangen Nov 11, 2017

danielduan Nov 11, 2017

danielduan Nov 11, 2017

danielduan Nov 11, 2017

Hypnosphi Nov 11, 2017

codecov bot commented Nov 11, 2017 •

edited

Loading

ndelangen commented Nov 11, 2017

ndelangen commented Nov 11, 2017

Hypnosphi Nov 12, 2017

danielduan commented Nov 13, 2017

ndelangen commented Nov 13, 2017

Hypnosphi Nov 13, 2017

ndelangen Nov 13, 2017

		@@ -0,0 +1,3 @@
		// NOTE: loading addons using this file is deprecated!

Add addon-a11y to monorepo #2292

Add addon-a11y to monorepo #2292

Conversation

ndelangen commented Nov 11, 2017 • edited Loading

What I did

How to test

danielduan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented Nov 11, 2017 • edited Loading

Codecov Report

ndelangen commented Nov 11, 2017

ndelangen commented Nov 11, 2017

Choose a reason for hiding this comment

danielduan commented Nov 13, 2017

ndelangen commented Nov 13, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ndelangen commented Nov 11, 2017 •

edited

Loading

codecov bot commented Nov 11, 2017 •

edited

Loading