diff --git a/.github/stale.yml b/.github/stale.yml new file mode 100644 index 00000000000..a5717c95fa5 --- /dev/null +++ b/.github/stale.yml @@ -0,0 +1,26 @@ +# Number of days of inactivity before an issue becomes stale +daysUntilStale: 85 +# Number of days of inactivity before a stale issue is closed +daysUntilClose: 5 +# Issues with these labels will never be considered stale +exemptLabels: + - bug + - 'help wanted' + - 'in progress' + - 'do not merge' + - 'needs review' + +# Label to use when marking an issue as stale +staleLabel: inactive +# Comment to post when marking an issue as stale. Set to `false` to disable +markComment: > + Hi everyone! Seems like there hasn't been much going on in this issue lately. + If there are still questions, comments, or bugs, please feel free to continue + the discussion. We do try to do some housekeeping every once in a while so + inactive issues will get closed after 90 days. Thanks! +# Comment to post when closing a stale issue. Set to `false` to disable +closeComment: > + Hey there, it's me again! I am going to help our maintainers close this issue + so they can focus on development efforts instead. If the issue mentioned is + still a concern, please open a new ticket and mention this old one. Cheers + and thanks for using Storybook! diff --git a/README.md b/README.md index dc645de5f97..8e2301332c5 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,8 @@ cd my-react-app getstorybook ``` +The `-g` global install is used to run our cli tool in your project directory to generate templates for your existing projects. To avoid the global install and start your project manually, take a look at our [Slow Start Guide](https://storybook.js.org/basics/slow-start-guide/). + Once it's installed, you can `npm run storybook` and it will run the development server on your local machine, and give you a URL to browse some sample stories. **Storybook v2.x migration note**: If you're using Storybook v2.x and want to shift to 3.x version the easiest way is: diff --git a/docs/pages/basics/guide-react/index.md b/docs/pages/basics/guide-react/index.md index da950fc4f00..dd955c0dc84 100644 --- a/docs/pages/basics/guide-react/index.md +++ b/docs/pages/basics/guide-react/index.md @@ -31,7 +31,7 @@ npm i --save-dev @storybook/react ## Add react and react-dom -Make sure that you have `react` and `react-dom` in your dependencies as well because we list is as a peerDependency: +Make sure that you have `react` and `react-dom` in your dependencies as well because we list these as a peerDependency: ```sh npm i --save react react-dom diff --git a/docs/pages/basics/quick-start-guide/index.md b/docs/pages/basics/quick-start-guide/index.md index 1d067775639..1eb1eaa771e 100644 --- a/docs/pages/basics/quick-start-guide/index.md +++ b/docs/pages/basics/quick-start-guide/index.md @@ -11,6 +11,7 @@ cd my-project-directory npm i -g @storybook/cli getstorybook ``` +The `-g` global install is used to run our cli tool in your project directory to generate templates for your existing projects. To avoid the global install and start your project manually, take a look at our [Slow Start Guide](/basics/slow-start-guide/). This will configure your app for Storybook. After that, you can run your Storybook with: diff --git a/docs/pages/examples/_examples.yml b/docs/pages/examples/_examples.yml index 64247866060..a57cc7a56a6 100644 --- a/docs/pages/examples/_examples.yml +++ b/docs/pages/examples/_examples.yml @@ -25,6 +25,13 @@ atlassian: description: Atlassian's official UI library. demo: https://atlaskit.atlassian.com/components site: https://atlaskit.atlassian.com/ +wix: + thumbnail: ./thumbnails/wix.png + title: Wix Style React + description: Components that conform to Wix Style + source: https://github.com/wix/wix-style-react + demo: https://wix.github.io/wix-style-react/ + site: https://wix.com buffer: thumbnail: ./thumbnails/buffer.jpg title: Buffer Components diff --git a/docs/pages/examples/thumbnails/wix.png b/docs/pages/examples/thumbnails/wix.png new file mode 100644 index 00000000000..f0d351c03dd Binary files /dev/null and b/docs/pages/examples/thumbnails/wix.png differ diff --git a/integration/examples.test.js b/integration/examples.test.js index 8912f6dff5e..cdafd0f7411 100644 --- a/integration/examples.test.js +++ b/integration/examples.test.js @@ -13,32 +13,29 @@ const examples = [ examples.forEach(({ name, port }) => { let browser = puppeteer.launch(); + let page; describe('sandboxes', () => { + beforeAll(async () => { + browser = await browser; + page = await browser.newPage(); + await page.setViewport({ width: 1400, height: 1000 }); + }); afterAll(() => { browser.close(); }); - it.concurrent( - `Take screenshots for '${name}'`, - async () => { - browser = await browser; - const page = await browser.newPage(); - await page.setViewport({ width: 1400, height: 1000 }); - await page.goto(`http://localhost:${port}`); - await page.waitForSelector('[role="menuitem"][data-name="Welcome"]'); - await page.waitFor(2000); + it(`Take screenshots for '${name}'`, async () => { + await page.goto(`http://localhost:${port}`); + await page.waitForSelector('[role="menuitem"][data-name="Welcome"]'); + await page.waitFor(2000); - const screenshot = await page.screenshot({ fullPage: true }); - - expect(screenshot).toMatchImageSnapshot({ - customDiffConfig: { - threshold: 0.03, // 3% threshold - }, - customSnapshotIdentifier: name.split('/').join('-'), - }); - }, - 1000 * 60 * 10 // 10 minutes for all tests in total - ); + const screenshot = await page.screenshot({ fullPage: true }); + expect(screenshot).toMatchImageSnapshot({ + failureThreshold: 0.04, // 4% threshold, + failureThresholdType: 'percent', + customSnapshotIdentifier: name.split('/').join('-'), + }); + }); }); }); diff --git a/package.json b/package.json index 423b93fcda1..3783b0b5bb7 100644 --- a/package.json +++ b/package.json @@ -70,7 +70,7 @@ "inquirer": "^3.2.3", "jest": "^21.2.0", "jest-enzyme": "^4.0.1", - "jest-image-snapshot": "^1.0.1", + "jest-image-snapshot": "^2.1.0", "lerna": "^2.4.0", "lint-staged": "^4.3.0", "lodash": "^4.17.4", diff --git a/yarn.lock b/yarn.lock index 4247badd7aa..f63e56fdc03 100644 --- a/yarn.lock +++ b/yarn.lock @@ -407,10 +407,6 @@ art@^0.10.0: version "0.10.1" resolved "https://registry.yarnpkg.com/art/-/art-0.10.1.tgz#38541883e399225c5e193ff246e8f157cf7b2146" -asap@~1.0.0: - version "1.0.0" - resolved "https://registry.yarnpkg.com/asap/-/asap-1.0.0.tgz#b2a45da5fdfa20b0496fc3768cc27c12fa916a7d" - asap@~2.0.3: version "2.0.6" resolved "https://registry.yarnpkg.com/asap/-/asap-2.0.6.tgz#e50347611d7e690943208bbdafebcbc2fb866d46" @@ -481,10 +477,6 @@ async-limiter@~1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/async-limiter/-/async-limiter-1.0.0.tgz#78faed8c3d074ab81f22b4e985d79e8738f720f8" -async@0.1.15: - version "0.1.15" - resolved "https://registry.yarnpkg.com/async/-/async-0.1.15.tgz#2180eaca2cf2a6ca5280d41c0585bec9b3e49bd3" - async@2.1.4: version "2.1.4" resolved "https://registry.yarnpkg.com/async/-/async-2.1.4.tgz#2d2160c7788032e4dd6cbe2502f1f9a2c8f6cde4" @@ -2082,14 +2074,6 @@ binary-extensions@^1.0.0: version "1.10.0" resolved "https://registry.yarnpkg.com/binary-extensions/-/binary-extensions-1.10.0.tgz#9aeb9a6c5e88638aad171e167f5900abe24835d0" -blink-diff@^1.0.13: - version "1.0.13" - resolved "https://registry.yarnpkg.com/blink-diff/-/blink-diff-1.0.13.tgz#80e3df69de804b30d40c70f041e983841ecda899" - dependencies: - pngjs-image "~0.11.5" - preceptor-core "~0.10.0" - promise "6.0.0" - block-stream@*: version "0.0.9" resolved "https://registry.yarnpkg.com/block-stream/-/block-stream-0.0.9.tgz#13ebfe778a03205cfe03751481ebb4b3300c126a" @@ -5842,7 +5826,7 @@ iconv-lite@0.4.13: version "0.4.13" resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.13.tgz#1f88aba4ab0b1508e8312acc39345f36e992e2f2" -iconv-lite@0.4.19, iconv-lite@^0.4.17, iconv-lite@^0.4.5, iconv-lite@^0.4.8, iconv-lite@~0.4.13: +iconv-lite@0.4.19, iconv-lite@^0.4.17, iconv-lite@^0.4.5, iconv-lite@~0.4.13: version "0.4.19" resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.19.tgz#f7468f60135f5e5dad3399c0a81be9a1603a082b" @@ -6688,14 +6672,15 @@ jest-haste-map@^21.2.0: sane "^2.0.0" worker-farm "^1.3.1" -jest-image-snapshot@^1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/jest-image-snapshot/-/jest-image-snapshot-1.0.1.tgz#9b92f57b46c29627b2e9da6e07c27ee784be95a4" +jest-image-snapshot@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/jest-image-snapshot/-/jest-image-snapshot-2.1.0.tgz#a8863f38de868e0175335dd9a1b170650e0bcdc9" dependencies: - blink-diff "^1.0.13" chalk "^1.1.3" lodash "^4.17.4" mkdirp "^0.5.1" + pixelmatch "^4.0.2" + pngjs "^3.3.0" jest-jasmine2@^20.0.4: version "20.0.4" @@ -7644,14 +7629,6 @@ log-update@^1.0.2: ansi-escapes "^1.0.0" cli-cursor "^1.0.2" -log4js@0.6.20: - version "0.6.20" - resolved "https://registry.yarnpkg.com/log4js/-/log4js-0.6.20.tgz#5382993d038ee2e453de21c82f4b1beeed2c48fa" - dependencies: - async "0.1.15" - readable-stream "~1.0.2" - semver "~1.1.4" - loglevel@^1.4.1: version "1.5.1" resolved "https://registry.yarnpkg.com/loglevel/-/loglevel-1.5.1.tgz#189078c94ab9053ee215a0acdbf24244ea0f6502" @@ -8600,7 +8577,7 @@ package-json@^4.0.0: registry-url "^3.0.3" semver "^5.1.0" -pako@^0.2.6, pako@~0.2.0: +pako@~0.2.0: version "0.2.9" resolved "https://registry.yarnpkg.com/pako/-/pako-0.2.9.tgz#f3f7522f4ef782348da8161bad9ecfd51bf83a75" @@ -8814,6 +8791,12 @@ pinkie@^2.0.0: version "2.0.4" resolved "https://registry.yarnpkg.com/pinkie/-/pinkie-2.0.4.tgz#72556b80cfa0d48a974e80e77248e80ed4f7f870" +pixelmatch@^4.0.2: + version "4.0.2" + resolved "https://registry.yarnpkg.com/pixelmatch/-/pixelmatch-4.0.2.tgz#8f47dcec5011b477b67db03c243bc1f3085e8854" + dependencies: + pngjs "^3.0.0" + pkg-dir@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/pkg-dir/-/pkg-dir-1.0.0.tgz#7a4b508a8d5bb2d629d447056ff4e9c9314cf3d4" @@ -8861,20 +8844,9 @@ pluralize@^7.0.0: version "7.0.0" resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-7.0.0.tgz#298b89df8b93b0221dbf421ad2b1b1ea23fc6777" -pngjs-image@~0.11.5: - version "0.11.7" - resolved "https://registry.yarnpkg.com/pngjs-image/-/pngjs-image-0.11.7.tgz#631dd59924569fc82ffebae0d5d53f85f54dab62" - dependencies: - iconv-lite "^0.4.8" - pako "^0.2.6" - pngjs "2.3.1" - request "^2.55.0" - stream-buffers "1.0.1" - underscore "1.7.0" - -pngjs@2.3.1: - version "2.3.1" - resolved "https://registry.yarnpkg.com/pngjs/-/pngjs-2.3.1.tgz#11d1e12b9cb64d63e30c143a330f4c1f567da85f" +pngjs@^3.0.0, pngjs@^3.3.0: + version "3.3.0" + resolved "https://registry.yarnpkg.com/pngjs/-/pngjs-3.3.0.tgz#1f5730c189c94933b81beda2ab2f8e2855263a8f" podda@^1.2.2: version "1.2.2" @@ -9184,13 +9156,6 @@ postcss@^6.0.0, postcss@^6.0.1, postcss@^6.0.13, postcss@^6.0.2, postcss@^6.0.6, source-map "^0.6.1" supports-color "^4.4.0" -preceptor-core@~0.10.0: - version "0.10.0" - resolved "https://registry.yarnpkg.com/preceptor-core/-/preceptor-core-0.10.0.tgz#d906e88760c6fb92121f942b393c91dfcf7618a4" - dependencies: - log4js "0.6.20" - underscore "1.7.0" - prelude-ls@~1.1.2: version "1.1.2" resolved "https://registry.yarnpkg.com/prelude-ls/-/prelude-ls-1.1.2.tgz#21932a549f5e52ffd9a827f570e04be62a97da54" @@ -9276,12 +9241,6 @@ promise.prototype.finally@^3.0.0: es-abstract "^1.8.2" function-bind "^1.1.1" -promise@6.0.0: - version "6.0.0" - resolved "https://registry.yarnpkg.com/promise/-/promise-6.0.0.tgz#456538dd4afdd25dc7d0f52a5201ed242b7c109d" - dependencies: - asap "~1.0.0" - promise@8.0.1: version "8.0.1" resolved "https://registry.yarnpkg.com/promise/-/promise-8.0.1.tgz#e45d68b00a17647b6da711bf85ed6ed47208f450" @@ -9903,7 +9862,7 @@ read-pkg@^2.0.0: normalize-package-data "^2.3.2" path-type "^2.0.0" -readable-stream@1.0, readable-stream@~1.0.2: +readable-stream@1.0: version "1.0.34" resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-1.0.34.tgz#125820e34bc842d2f2aaafafe4c2916ee32c157c" dependencies: @@ -10469,7 +10428,7 @@ request@2.81.0: tunnel-agent "^0.6.0" uuid "^3.0.0" -request@^2.55.0, request@^2.79.0, request@^2.83.0: +request@^2.79.0, request@^2.83.0: version "2.83.0" resolved "https://registry.yarnpkg.com/request/-/request-2.83.0.tgz#ca0b65da02ed62935887808e6f510381034e3356" dependencies: @@ -10723,10 +10682,6 @@ semver-diff@^2.0.0: version "5.4.1" resolved "https://registry.yarnpkg.com/semver/-/semver-5.4.1.tgz#e059c09d8571f0540823733433505d3a2f00b18e" -semver@~1.1.4: - version "1.1.4" - resolved "https://registry.yarnpkg.com/semver/-/semver-1.1.4.tgz#2e5a4e72bab03472cc97f72753b4508912ef5540" - semver@~5.0.1: version "5.0.3" resolved "https://registry.yarnpkg.com/semver/-/semver-5.0.3.tgz#77466de589cd5d3c95f138aa78bc569a3cb5d27a" @@ -11146,10 +11101,6 @@ stream-browserify@^2.0.1: inherits "~2.0.1" readable-stream "^2.0.2" -stream-buffers@1.0.1: - version "1.0.1" - resolved "https://registry.yarnpkg.com/stream-buffers/-/stream-buffers-1.0.1.tgz#9a44a37555f96a5b78a5a765f0c48446cb160b8c" - stream-buffers@~2.2.0: version "2.2.0" resolved "https://registry.yarnpkg.com/stream-buffers/-/stream-buffers-2.2.0.tgz#91d5f5130d1cef96dcfa7f726945188741d09ee4" @@ -11800,10 +11751,6 @@ undefsafe@0.0.3: version "0.0.3" resolved "https://registry.yarnpkg.com/undefsafe/-/undefsafe-0.0.3.tgz#ecca3a03e56b9af17385baac812ac83b994a962f" -underscore@1.7.0: - version "1.7.0" - resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.7.0.tgz#6bbaf0877500d36be34ecaa584e0db9fef035209" - underscore@~1.4.4: version "1.4.4" resolved "https://registry.yarnpkg.com/underscore/-/underscore-1.4.4.tgz#61a6a32010622afa07963bf325203cf12239d604"