Merge branch 'release/3.3' into 1404-fix-empty-array-knob

storybookjs · Sep 7, 2017 · 09a4f2f · 09a4f2f
2 parents cba07ad + a88fdf6
commit 09a4f2f
Show file tree

Hide file tree

Showing 190 changed files with 25,630 additions and 1,412 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -6,7 +6,7 @@ defaults: &defaults
 version: 2
 dependencies:
   pre:
-    - npm install -g npm
+    - yarn global add npm
 jobs:
   validate:
     <<: *defaults
@@ -40,7 +40,7 @@ jobs:
       - run:
           name: "Bootstrapping"
           command: |
-            npm run bootstrap -- --all
+            yarn bootstrap -- --all
       - save_cache:
           key: package-dependencies-{{ checksum "package.json" }}
           paths:
@@ -63,7 +63,7 @@ jobs:
       - run:
           name: "Bootstrapping"
           command: |
-            npm run bootstrap -- --core
+            yarn bootstrap -- --core
       - run:
           name: "Build react kitchen-sink"
           command: |
@@ -91,7 +91,7 @@ jobs:
       - run:
           name: "Bootstrapping packages"
           command: |
-            npm run bootstrap -- --core --reactnative --reactnativeapp
+            yarn bootstrap -- --core --reactnative --reactnativeapp
       - run:
           name: "Running React-Native example"
           command: |
@@ -117,11 +117,11 @@ jobs:
       - run:
           name: "Bootstrapping"
           command: |
-            npm run bootstrap -- --docs
+            yarn bootstrap -- --docs
       - run:
           name: "Running docs"
           command: |
-            npm run docs:build
+            yarn docs:build
   lint:
     <<: *defaults
     steps:
@@ -137,7 +137,7 @@ jobs:
       - run:
           name: "Linting"
           command: |
-            npm run lint
+            yarn lint
   unit-test:
     <<: *defaults
     steps:
@@ -153,12 +153,12 @@ jobs:
       - run:
           name: "Bootstrapping"
           command: |
-            npm run bootstrap -- --core --reactnative
+            yarn bootstrap -- --core --reactnative
       - run:
           name: "Unit testing"
           command: |
-            npm run test -- --coverage -i
-            npm run coverage
+            yarn test -- --all --coverage --runInBand
+            yarn coverage
   deploy:
     <<: *defaults
     steps:

diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@ node_modules
 *.log
 .idea
 .vscode
+*.sw*
 npm-shrinkwrap.json
 dist
 .tern-port
@@ -12,7 +13,6 @@ coverage/
 *.lerna_backup
 build
 packages/examples/automated-*
-yarn.lock
 /**/LICENSE
 docs/public
 packs/*.tgz

diff --git a/.mailmap b/.mailmap
@@ -0,0 +1,50 @@
+# --- instructions --- #
+
+# Add your account in this format:
+Your name here <[email protected]> # github:my-github-account, npm:my-npm-account, twitter:my-twitter-handle
+
+# supported:
+# github, npm, twitter, website
+
+# --- list ----------- #
+
+Aaron Mc Adam <[email protected]> 
+Aruna Herath <[email protected]> <[email protected]> 
+Arunoda Susiripala <[email protected]>  Arunoda Susiripala <[email protected]> 
+Benedikt D Valdez <[email protected]>  Benedikt D Valdez <[email protected]> 
+Daniel Duan <[email protected]> <[email protected]> 
+Daniel James <[email protected]> <[email protected]> 
+Danny Andrews <[email protected]>  [email protected]> 
+Dustin Kane <[email protected]> <[email protected]> 
+Eli Sherer <[email protected]>  elish <[email protected]> 
+Evgeny Kochetkov <[email protected]>  Evgeny Kochetkov <[email protected]> 
+Fabien Bernard <[email protected]>  Fabien BERNARD <[email protected]> 
+Fernando Daciuk <[email protected]> <[email protected]> 
+Greenkeeper <[email protected]>  greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com> 
+Greenkeeper <[email protected]>  greenkeeperio-bot <[email protected]> 
+Jason Schloer <[email protected]>  jschloer <[email protected]> 
+Jean-Michel Francois <[email protected]>  Jean-Michel FRANCOIS <[email protected]> 
+Jeff Carbonella <[email protected]> <[email protected]> 
+Jeff Knaggs <[email protected]> <[email protected]> 
+Jordan Gensler <[email protected]> <[email protected]> 
+Kanitkorn Sujautra <[email protected]>  Kanitkorn S <[email protected]> 
+Kent C. Dodds <[email protected]> <[email protected]> 
+larry <[email protected]> <[email protected]> 
+Madushan Nishantha <[email protected]> <[email protected]> 
+Marie-Laure Thuret <[email protected]>  mthuret <[email protected]> 
+Max Hodges <[email protected]>  MaxHodges <[email protected]> 
+Michael Shilman <[email protected]> <[email protected]> 
+Michael Shilman <[email protected]> <[email protected]> 
+Muhammed Thanish <[email protected]> <[email protected]> 
+Ned Schwartz <[email protected]>  Ned Schwartz <[email protected]> 
+Joe Nelson <[email protected]>  Nelson, Joe <[email protected]> 
+Nikolay Kozhuharenko <[email protected]>  Nikolay <[email protected]> 
+Norbert de Langen <[email protected]>  # github:ndelangen, npm:ndelangen, twitter:norbertdelangen
+Oleg Proskurin <[email protected]>  UsulPro <[email protected]> 
+Orta <[email protected]>  orta <[email protected]> 
+Ritesh Kumar <[email protected]>  Ritesh Kumar <[email protected]> 
+Sylvain Bannier <[email protected]>  Sylvain BANNIER <[email protected]> 
+Tom Coleman <[email protected]>  Tom Coleman <[email protected]> 
+Trevor Eyre <[email protected]> # github:TrevorEyre, twitter:trevor_eyre
+William Castandet <[email protected]>  wcastand <[email protected]> 
+Xavier Cazalot <[email protected]>  xavcz <[email protected]> 
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,53 @@
+# 3.3.0-alpha.0
+
+2017-September-06
+
+#### Features
+
+-   Viewport addon: simulate device sizes in preview window [#1753](https://github.com/storybooks/storybook/pull/1753)
+-   CLI: Add codemod for deprecated addon-links and addon-actions from app [#1368](https://github.com/storybooks/storybook/pull/1368)
+-   Info addon: More detailed props table [#1485](https://github.com/storybooks/storybook/pull/1485)
+-   React native: Add accessibility labels to OnDeviceUI [#1780](https://github.com/storybooks/storybook/pull/1780)
+-   Stories panel: Stories on each hierarchy level [#1763](https://github.com/storybooks/storybook/pull/1763)
+-   Storyshots: Generate snapshot per story file [#1584](https://github.com/storybooks/storybook/pull/1584)
+-   CLI: Add support for Vue projects using Nuxt [#1794](https://github.com/storybooks/storybook/pull/1794)
+
+#### Bug Fixes
+
+-   Import chunks/assets in correct order using HtmlWebpackPlugin [#1775](https://github.com/storybooks/storybook/pull/1775)
+-   Fix preview scrolling [#1782](https://github.com/storybooks/storybook/pull/1782)
+-   Height aligned 2 buttons in manager's header [#1769](https://github.com/storybooks/storybook/pull/1769)
+-   Search box: make found options selectable with click [#1697](https://github.com/storybooks/storybook/pull/1697)
+-   Info addon: Fix Docgen in static builds [#1725](https://github.com/storybooks/storybook/pull/1725)
+-   Knobs: allow arrays in object knob proptypes [#1701](https://github.com/storybooks/storybook/pull/1701)
+
+#### Documentation
+
+-   Improve linkTo documentation [#1793](https://github.com/storybooks/storybook/pull/1793)
+-   Add carbon to examples page [#1764](https://github.com/storybooks/storybook/pull/1764)
+-   Minor grammar fixes and clarification to Vue documentation [#1756](https://github.com/storybooks/storybook/pull/1756)
+-   Fix incorrect yarn command in docs [#1758](https://github.com/storybooks/storybook/pull/1758)
+-   Add storybook-chrome-screenshot to addon gallery [#1761](https://github.com/storybooks/storybook/pull/1761)
+-   Fixing typo on VueJS withNotes Example [#1787](https://github.com/storybooks/storybook/pull/1787)
+
+#### Maintenance
+
+-   Deprecate confusing option names [#1692](https://github.com/storybooks/storybook/pull/1692)
+-   A CLI for running specific tests suites, like bootstrap CLI [#1752](https://github.com/storybooks/storybook/pull/1752)
+-   Remove check for sender on channel. [#1407](https://github.com/storybooks/storybook/pull/1407)
+-   Use yarn instead of NPM [#1703](https://github.com/storybooks/storybook/pull/1703)
+-   Add config for dependencies.io [#1770](https://github.com/storybooks/storybook/pull/1770)
+-   Added addon-knobs to crna and vanilla react native. [#1636](https://github.com/storybooks/storybook/pull/1636)
+-   Fixed Jest warnings [#1744](https://github.com/storybooks/storybook/pull/1744)
+-   Smoke test master [#1801](https://github.com/storybooks/storybook/pull/1801)
+
+#### Dependency Upgrades
+
+-   Upgrade root dependencies and sync with packages [#1802](https://github.com/storybooks/storybook/pull/1802)
+-   Update jest to the latest version 🚀 [#1799](https://github.com/storybooks/storybook/pull/1799)
+-   Update eslint-plugin-jest to the latest version 🚀 [#1795](https://github.com/storybooks/storybook/pull/1795)
+-   Update lerna to the latest version 🚀 [#1768](https://github.com/storybooks/storybook/pull/1768)
+
 # 3.2.9
 
 2017-August-26

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,8 @@ Thanks for your interest in improving Storybook! We are a community-driven proje
 
 Please review this document to help to streamline the process and save everyone's precious time.
 
+This guide assumes you're using `yarn` as package manager. You may have some success using `npm` as well, but there are chances you'll get wrong versions of root dependencies in that case (we only commit `yarn.lock` to the repo).
+
 ## Issues
 
 No software is bug free. So, if you got an issue, follow these steps:
@@ -18,29 +20,57 @@ No software is bug free. So, if you got an issue, follow these steps:
 
 ### Testing against `master`
 
-To test your project against the current latest version of storybook, you can clone the repository and link it with `npm`. Try following these steps:
+To test your project against the current latest version of storybook, you can clone the repository and link it with `yarn`. Try following these steps:
 
-1.  Download the latest version of this project, and build it:
+#### 1. Download the latest version of this project, and build it:
 
 ```sh
 git clone https://github.com/storybooks/storybook.git
 cd storybook
-npm install
-npm run bootstrap -- --core
+yarn install
+yarn bootstrap
 ```
 
-2.  Link `storybook` and any other required dependencies:
+The bootstrap command will ask which sections of the codebase you want to bootstrap. Unless you're going to work with ReactNative or the Documentation, you can keep the default.
+
+You can also pick directly from CLI:
+
+    yarn bootstrap -- --core
+
+#### 2a. Run unit tests
+
+You can use one of the example projects in `examples/` to develop on.
+
+This command will list all the suites and options for running tests. 
 
 ```sh
-cd app/react
-npm link
+yarn test
+```
+
+_Note that in order to run the tests fro ReactNative, you must have bootstrapped with ReactNative enabled_
 
-cd <your-project>
-npm link @storybook/react
+You can also pick suites from CLI:
 
-# repeat with whichever other parts of the monorepo you are using.
+```sh
+yarn test -- --core
 ```
 
+In order to run ALL unit tests, you must have bootstrapped the react-native
+
+#### 2b. Link `storybook` and any other required dependencies:
+
+If you want to test your own existing project using the github version of storybook, you need to `link` the packages you use in your project.
+
+    ```sh
+    cd app/react
+    yarn link
+
+    cd <your-project>
+    yarn link @storybook/react
+
+    # repeat with whichever other parts of the monorepo you are using.
+    ```
+
 ### Reproductions
 
 The best way to help figure out an issue you are having is to produce a minimal reproduction against the `master` branch.
@@ -51,13 +81,12 @@ A good way to do that is using the example `cra-kitchen-sink` app embedded in th
 # Download and build this repository:
 git clone https://github.com/storybooks/storybook.git
 cd storybook
-npm install
-npm run bootstrap -- --core
-
-cd examples/cra-kitchen-sink
+yarn install
+yarn bootstrap
 
 # make changes to try and reproduce the problem, such as adding components + stories
-npm start storybook
+cd examples/cra-kitchen-sink
+yarn storybook
 
 # see if you can see the problem, if so, commit it:
 git checkout "branch-describing-issue"
@@ -71,7 +100,7 @@ git push -u <your-username> master
 
 If you follow that process, you can then link to the github repository in the issue. See <https://github.com/storybooks/storybook/issues/708#issuecomment-290589886> for an example.
 
-**NOTE**: If your issue involves a webpack config, create-react-app will prevent you from modifying the _app's_ webpack config, however you can still modify storybook's to mirror your app's version of storybook. Alternatively, use `npm run eject` in the CRA app to get a modifiable webpack config.
+**NOTE**: If your issue involves a webpack config, create-react-app will prevent you from modifying the _app's_ webpack config, however you can still modify storybook's to mirror your app's version of storybook. Alternatively, use `yarn eject` in the CRA app to get a modifiable webpack config.
 
 ## Pull Requests (PRs)
 
@@ -82,7 +111,7 @@ We welcome your contributions. There are many ways you can help us. This is few
 -   Work on [API](https://github.com/storybooks/storybook/labels/enhancement%3A%20api), [Addons](https://github.com/storybooks/storybook/labels/enhancement%3A%20addons), [UI](https://github.com/storybooks/storybook/labels/enhancement%3A%20ui) or [Webpack](https://github.com/storybooks/storybook/labels/enhancement%3A%20webpack) use enhancements and new [features](https://github.com/storybooks/storybook/labels/feature%20request).
 -   Add more [tests](https://codecov.io/gh/storybooks/storybook/tree/master/packages) (specially for the [UI](https://codecov.io/gh/storybooks/storybook/tree/master/packages/storybook-ui/src)).
 
-Before you submit a new PR, make you to run `npm test`. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.
+Before you submit a new PR, make you to run `yarn test`. Do not submit a PR if tests are failing. If you need any help, create an issue and ask.
 
 ### Reviewing PRs
 
@@ -136,7 +165,7 @@ This project written in ES2016+ syntax so, we need to transpile it before use.
 So run the following command:
 
 ```sh
-npm run dev
+yarn dev
 ```
 
 This will watch files and transpile in watch mode.
@@ -146,14 +175,14 @@ This will watch files and transpile in watch mode.
 First of all link this repo with:
 
 ```sh
-npm link
+yarn link
 ```
 
 In order to test features you add, you may need to link the local copy of this repo.
 For that we need a sample project. Let's create it.
 
 ```sh
-npm install --global create-react-app getstorybook
+yarn global add create-react-app getstorybook
 create-react-app my-demo-app
 cd my-demo-app
 getstorybook
@@ -165,12 +194,12 @@ getstorybook
 Then link storybook inside the sample project with:
 
 ```sh
-npm link @storybook/react
+yarn link @storybook/react
 ```
 
 ### Getting Changes
 
-After you've done any change, you need to run the `npm run storybook` command every time to see those changes.
+After you've done any change, you need to run the `yarn storybook` command every time to see those changes.
 
 ## Release Guide
 
@@ -193,12 +222,9 @@ First, build the release:
 git checkout master
 git status
 
-# clean out extra files
+# clean out extra files & build all the packages
 # WARNING: destructive if you have extra files lying around!
-git clean -fdx && yarn
-
-# build all the packages
-npm run bootstrap -- --all
+yarn bootstrap -- --reset --all
 ```
 
 From here there are different procedures for prerelease (e.g. alpha/beta/rc) and proper release.
@@ -209,7 +235,7 @@ From here there are different procedures for prerelease (e.g. alpha/beta/rc) and
 
 ```sh
 # publish and tag the release
-npm run publish -- --concurrency 1 --npm-tag=alpha
+yarn run publish -- --concurrency 1 --npm-tag=alpha
 
 # push the tags
 git push --tags
@@ -219,14 +245,14 @@ git push --tags
 
 ```sh
 # publish but don't commit to git
-npm run publish -- --concurrency 1 --skip-git
+yarn publish -- --concurrency 1 --skip-git
 
 # Update `CHANGELOG.md`
 # - Edit PR titles/labels on github until output is good
 # - Optionally, edit a handwritten description in `CHANGELOG.md`
-npm run changelog
+yarn changelog
 
 # tag the release and push `CHANGELOG.md` and tags
 # FIXME: not end-to-end tested!
-npm run github-release
+yarn github-release
 ```