From f716ee8efd46396be0f6c2f249f858451471e908 Mon Sep 17 00:00:00 2001 From: Michael Shilman Date: Wed, 31 Oct 2018 14:50:35 +0800 Subject: [PATCH] Merge pull request #4594 from gabrielcsapo/update-ember-ergonomics [ember] update ember ergonomics to not require any manual setup --- docs/src/pages/basics/guide-ember/index.md | 38 ++----------------- examples/ember-cli/.env | 3 +- examples/ember-cli/.gitignore | 2 + .../ember-cli/.storybook/preview-head.html | 10 ----- examples/ember-cli/package.json | 4 +- yarn.lock | 27 +++++++++---- 6 files changed, 30 insertions(+), 54 deletions(-) delete mode 100644 examples/ember-cli/.storybook/preview-head.html diff --git a/docs/src/pages/basics/guide-ember/index.md b/docs/src/pages/basics/guide-ember/index.md index 6b424bcaf61d..0b76d9dc97a1 100644 --- a/docs/src/pages/basics/guide-ember/index.md +++ b/docs/src/pages/basics/guide-ember/index.md @@ -37,50 +37,20 @@ npm init Then add the following NPM script to your package json in order to start the storybook later in this guide: -> In order for your storybook to run properly be sure to be either run `ember serve` or `ember build` before running any storybook commands. +> In order for your storybook to run properly be sure to be either run `ember serve` or `ember build` before running any storybook commands. Running `ember serve` before storybook will enable live reloading. ```json { "scripts": { - "storybook": "start-storybook -p 9001 -s dist" + "build-storybook": "ember build && build-storybook -p 9001 -s dist", + "storybook": "ember serve & start-storybook -p 9001 -s dist" } } ``` ## Setup environment -### Adding preview-head.html - -In order for storybook to register your ember application you must add the following file to `.storybook/preview-head.html` - -> These scripts may not contain everything you need, a good point of reference is to look at what is in the head tag in your applications `dist/index.html` file when you build. - -``` - - - - - - - - -``` - -> Adding the runningTests script is extremely important don't forget to add this as it will result in your application binding multiple times. - -Substitute `ember-app-name` with the name of your ember application. - -> This is found by going to `package.json` and referencing the name field - -### Adding .env - -A file named `.env` is needed in the root directory with the following contents: - -``` -STORYBOOK_NAME={ember-app-name} -``` +Your environment will be preconfigured using `ember-cli-storybook`. This will add a `preview-head.html`, a `.env` and make sure that your environment is configured to work with live reload. ## Create the config file diff --git a/examples/ember-cli/.env b/examples/ember-cli/.env index 6051734db011..8e8c4cbfc8fc 100644 --- a/examples/ember-cli/.env +++ b/examples/ember-cli/.env @@ -1,2 +1 @@ -STORYBOOK_EXAMPLE_APP=true -STORYBOOK_NAME=ember-example +STORYBOOK_NAME=ember-example \ No newline at end of file diff --git a/examples/ember-cli/.gitignore b/examples/ember-cli/.gitignore index 964fe8b4e8f3..9f61ffc32c50 100644 --- a/examples/ember-cli/.gitignore +++ b/examples/ember-cli/.gitignore @@ -13,3 +13,5 @@ build .DS_Store npm-debug.log tmp +.env +.storybook/preview-head.html diff --git a/examples/ember-cli/.storybook/preview-head.html b/examples/ember-cli/.storybook/preview-head.html deleted file mode 100644 index 813f2051ae07..000000000000 --- a/examples/ember-cli/.storybook/preview-head.html +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - diff --git a/examples/ember-cli/package.json b/examples/ember-cli/package.json index 6f88903279d7..f16c1cf94f33 100644 --- a/examples/ember-cli/package.json +++ b/examples/ember-cli/package.json @@ -6,7 +6,8 @@ "build": "ember build", "build-storybook": "yarn build && cp -r public/* dist && build-storybook -s dist", "dev": "ember serve", - "storybook": "yarn build && start-storybook -p 9009 -s dist, public" + "storybook": "yarn build && start-storybook -p 9009 -s dist", + "storybook:dev": "yarn dev & start-storybook -p 9009 -s dist" }, "devDependencies": { "@babel/core": "^7.1.2", @@ -34,6 +35,7 @@ "ember-cli-inject-live-reload": "^2.0.1", "ember-cli-shims": "^1.2.0", "ember-cli-sri": "^2.1.0", + "ember-cli-storybook": "^0.0.1", "ember-cli-uglify": "^2.0.0", "ember-load-initializers": "^1.1.0", "ember-resolver": "^5.0.1", diff --git a/yarn.lock b/yarn.lock index 75d3e096e3fc..c94160ca53e2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -5477,13 +5477,13 @@ browserslist@^4.0.0, browserslist@^4.1.0, browserslist@^4.1.1: node-releases "^1.0.0-alpha.12" browserslist@^4.2.1: - version "4.2.1" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.2.1.tgz#257a24c879d1cd4016348eee5c25de683260b21d" - integrity sha512-1oO0c7Zhejwd+LXihS89WqtKionSbz298rJZKJgfrHIZhrV8AC15gw553VcB0lcEugja7IhWD7iAlrsamfYVPA== + version "4.3.4" + resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.3.4.tgz#4477b737db6a1b07077275b24791e680d4300425" + integrity sha512-u5iz+ijIMUlmV8blX82VGFrB9ecnUg5qEt55CMZ/YJEhha+d8qpBfOFuutJ6F/VKRXjZoD33b6uvarpPxcl3RA== dependencies: - caniuse-lite "^1.0.30000890" - electron-to-chromium "^1.3.79" - node-releases "^1.0.0-alpha.14" + caniuse-lite "^1.0.30000899" + electron-to-chromium "^1.3.82" + node-releases "^1.0.1" browserstack@^1.5.1: version "1.5.1" @@ -5774,11 +5774,16 @@ caniuse-lite@^1.0.0, caniuse-lite@^1.0.30000844, caniuse-lite@^1.0.30000884, can resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000890.tgz#86a18ffcc65d79ec6a437e985761b8bf1c4efeaf" integrity sha512-4NI3s4Y6ROm+SgZN5sLUG4k7nVWQnedis3c/RWkynV5G6cHSY7+a8fwFyn2yoBDE3E6VswhTNNwR3PvzGqlTkg== -caniuse-lite@^1.0.30000890, caniuse-lite@^1.0.30000892: +caniuse-lite@^1.0.30000890: version "1.0.30000892" resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000892.tgz#344d2b51ee3ff5977537da4aa449c90eec40b759" integrity sha512-X9rxMaWZNbJB5qjkDqPtNv/yfViTeUL6ILk0QJNxLV3OhKC5Acn5vxsuUvllR6B48mog8lmS+whwHq/QIYSL9w== +caniuse-lite@^1.0.30000892: + version "1.0.30000900" + resolved "https://registry.yarnpkg.com/caniuse-lite/-/caniuse-lite-1.0.30000900.tgz#015cfe37897a3386a3075a914498800c29afe77e" + integrity sha512-xDVs8pBFr6bzq9pXUkLKpGQQnzsF/l6/yX38UnCkTcUcwC0rDl1NGZGildcJVTU+uGBxfsyniK/ZWagPNn1Oqw== + canonical-path@0.0.2: version "0.0.2" resolved "https://registry.yarnpkg.com/canonical-path/-/canonical-path-0.0.2.tgz#e31eb937a8c93ee2a01df1839794721902874574" @@ -8172,6 +8177,14 @@ ember-cli-sri@^2.1.0: dependencies: broccoli-sri-hash "^2.1.0" +ember-cli-storybook@^0.0.1: + version "0.0.1" + resolved "https://registry.yarnpkg.com/ember-cli-storybook/-/ember-cli-storybook-0.0.1.tgz#63908e3b81d08de7a7e51dc18c618a398ca2357a" + integrity sha512-dmPNYEvVLefodAgA/JZQxazdMqcBjvEB+4SNE9ba37jOx8HS3sWvcd31RXCam+KfGaFbrR/u2c8FCZ59SC3jOQ== + dependencies: + cheerio "^1.0.0-rc.2" + ember-cli-babel "^7.1.2" + ember-cli-string-utils@^1.1.0: version "1.1.0" resolved "https://registry.yarnpkg.com/ember-cli-string-utils/-/ember-cli-string-utils-1.1.0.tgz#39b677fc2805f55173735376fcef278eaa4452a1"