From 1ad7a7739776d711b1faf4752c314c07b3e186ee Mon Sep 17 00:00:00 2001 From: Josh DeGraw Date: Wed, 6 Apr 2022 10:17:14 -0600 Subject: [PATCH 1/8] Fix reference to essentials configuration --- docs/essentials/introduction.md | 2 +- .../common/storybook-main-register-essentials-addon.js.mdx | 7 +++++++ 2 files changed, 8 insertions(+), 1 deletion(-) create mode 100644 docs/snippets/common/storybook-main-register-essentials-addon.js.mdx diff --git a/docs/essentials/introduction.md b/docs/essentials/introduction.md index db59851a041..4d84463a8e9 100644 --- a/docs/essentials/introduction.md +++ b/docs/essentials/introduction.md @@ -32,7 +32,7 @@ Update your Storybook configuration (in [`.storybook/main.js`](../configure/over diff --git a/docs/snippets/common/storybook-main-register-essentials-addon.js.mdx b/docs/snippets/common/storybook-main-register-essentials-addon.js.mdx new file mode 100644 index 00000000000..578c2c746cb --- /dev/null +++ b/docs/snippets/common/storybook-main-register-essentials-addon.js.mdx @@ -0,0 +1,7 @@ +```js +// .storybook/main.js + +module.exports = { + addons: ['@storybook/addon-essentials'], +}; +``` \ No newline at end of file From bbfc53736b0d8cf2dc8265e0946e5f1252aded06 Mon Sep 17 00:00:00 2001 From: Josh DeGraw <18509575+josh-degraw@users.noreply.github.com> Date: Fri, 8 Apr 2022 13:49:58 -0600 Subject: [PATCH 2/8] Update storybook-main-register-essentials-addon.js.mdx --- .../common/storybook-main-register-essentials-addon.js.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/snippets/common/storybook-main-register-essentials-addon.js.mdx b/docs/snippets/common/storybook-main-register-essentials-addon.js.mdx index 578c2c746cb..8c20f79bb8e 100644 --- a/docs/snippets/common/storybook-main-register-essentials-addon.js.mdx +++ b/docs/snippets/common/storybook-main-register-essentials-addon.js.mdx @@ -2,6 +2,7 @@ // .storybook/main.js module.exports = { - addons: ['@storybook/addon-essentials'], + stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'], + addons: ['@storybook/addon-links', '@storybook/addon-essentials'], }; -``` \ No newline at end of file +``` From 81caed5ad75e576eee130f46085e2a48f2074d63 Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Thu, 14 Apr 2022 14:14:44 +0200 Subject: [PATCH 3/8] chore: format versions.ts file using repo config --- lib/cli/package.json | 1 + .../scripts/generate-sb-packages-versions.js | 12 +- lib/cli/src/versions.ts | 114 +++++++++--------- 3 files changed, 68 insertions(+), 59 deletions(-) diff --git a/lib/cli/package.json b/lib/cli/package.json index c04a5d30e12..7b9e1b81972 100644 --- a/lib/cli/package.json +++ b/lib/cli/package.json @@ -82,6 +82,7 @@ "@types/semver": "^7.3.4", "@types/shelljs": "^0.8.7", "@types/update-notifier": "^5.0.0", + "prettier": ">=2.2.1 <=2.3.0", "strip-json-comments": "^3.1.1", "update-notifier": "^5.0.1" }, diff --git a/lib/cli/scripts/generate-sb-packages-versions.js b/lib/cli/scripts/generate-sb-packages-versions.js index 0f181d64e0a..18944ebf5aa 100755 --- a/lib/cli/scripts/generate-sb-packages-versions.js +++ b/lib/cli/scripts/generate-sb-packages-versions.js @@ -2,6 +2,7 @@ const { readJson, writeFile } = require('fs-extra'); const path = require('path'); +const prettier = require('prettier'); const globby = require('globby'); const semver = require('@storybook/semver'); const { default: dedent } = require('ts-dedent'); @@ -40,12 +41,19 @@ const run = async () => { .sort((package1, package2) => package1.name.localeCompare(package2.name)) .reduce((acc, { name }) => ({ ...acc, [name]: updatedVersion }), {}); + const prettierConfig = await prettier.resolveConfig( + path.join(__dirname, '..', '..', '..', '.prettierrc') + ); + await writeFile( path.join(__dirname, '..', 'src', 'versions.ts'), - dedent` + prettier.format( + dedent` // auto generated file, do not edit export default ${JSON.stringify(packageToVersionMap, null, 2)} - ` + `, + { ...prettierConfig, parser: 'typescript' } + ) ); }; diff --git a/lib/cli/src/versions.ts b/lib/cli/src/versions.ts index 5d4b0741b2e..c7a12a86359 100644 --- a/lib/cli/src/versions.ts +++ b/lib/cli/src/versions.ts @@ -1,59 +1,59 @@ // auto generated file, do not edit export default { - "@storybook/addon-a11y": "6.5.0-alpha.63", - "@storybook/addon-actions": "6.5.0-alpha.63", - "@storybook/addon-backgrounds": "6.5.0-alpha.63", - "@storybook/addon-controls": "6.5.0-alpha.63", - "@storybook/addon-docs": "6.5.0-alpha.63", - "@storybook/addon-essentials": "6.5.0-alpha.63", - "@storybook/addon-interactions": "6.5.0-alpha.63", - "@storybook/addon-jest": "6.5.0-alpha.63", - "@storybook/addon-links": "6.5.0-alpha.63", - "@storybook/addon-measure": "6.5.0-alpha.63", - "@storybook/addon-outline": "6.5.0-alpha.63", - "@storybook/addon-storyshots": "6.5.0-alpha.63", - "@storybook/addon-storyshots-puppeteer": "6.5.0-alpha.63", - "@storybook/addon-storysource": "6.5.0-alpha.63", - "@storybook/addon-toolbars": "6.5.0-alpha.63", - "@storybook/addon-viewport": "6.5.0-alpha.63", - "@storybook/addons": "6.5.0-alpha.63", - "@storybook/angular": "6.5.0-alpha.63", - "@storybook/api": "6.5.0-alpha.63", - "@storybook/builder-webpack4": "6.5.0-alpha.63", - "@storybook/builder-webpack5": "6.5.0-alpha.63", - "@storybook/channel-postmessage": "6.5.0-alpha.63", - "@storybook/channel-websocket": "6.5.0-alpha.63", - "@storybook/channels": "6.5.0-alpha.63", - "@storybook/cli": "6.5.0-alpha.63", - "@storybook/client-api": "6.5.0-alpha.63", - "@storybook/client-logger": "6.5.0-alpha.63", - "@storybook/codemod": "6.5.0-alpha.63", - "@storybook/components": "6.5.0-alpha.63", - "@storybook/core": "6.5.0-alpha.63", - "@storybook/core-client": "6.5.0-alpha.63", - "@storybook/core-common": "6.5.0-alpha.63", - "@storybook/core-events": "6.5.0-alpha.63", - "@storybook/core-server": "6.5.0-alpha.63", - "@storybook/csf-tools": "6.5.0-alpha.63", - "@storybook/docs-tools": "6.5.0-alpha.63", - "@storybook/ember": "6.5.0-alpha.63", - "@storybook/html": "6.5.0-alpha.63", - "@storybook/instrumenter": "6.5.0-alpha.63", - "@storybook/manager-webpack4": "6.5.0-alpha.63", - "@storybook/manager-webpack5": "6.5.0-alpha.63", - "@storybook/node-logger": "6.5.0-alpha.63", - "@storybook/postinstall": "6.5.0-alpha.63", - "@storybook/preact": "6.5.0-alpha.63", - "@storybook/preview-web": "6.5.0-alpha.63", - "@storybook/react": "6.5.0-alpha.63", - "@storybook/router": "6.5.0-alpha.63", - "@storybook/server": "6.5.0-alpha.63", - "@storybook/source-loader": "6.5.0-alpha.63", - "@storybook/store": "6.5.0-alpha.63", - "@storybook/svelte": "6.5.0-alpha.63", - "@storybook/theming": "6.5.0-alpha.63", - "@storybook/ui": "6.5.0-alpha.63", - "@storybook/vue": "6.5.0-alpha.63", - "@storybook/vue3": "6.5.0-alpha.63", - "@storybook/web-components": "6.5.0-alpha.63" -} \ No newline at end of file + '@storybook/addon-a11y': '6.5.0-alpha.63', + '@storybook/addon-actions': '6.5.0-alpha.63', + '@storybook/addon-backgrounds': '6.5.0-alpha.63', + '@storybook/addon-controls': '6.5.0-alpha.63', + '@storybook/addon-docs': '6.5.0-alpha.63', + '@storybook/addon-essentials': '6.5.0-alpha.63', + '@storybook/addon-interactions': '6.5.0-alpha.63', + '@storybook/addon-jest': '6.5.0-alpha.63', + '@storybook/addon-links': '6.5.0-alpha.63', + '@storybook/addon-measure': '6.5.0-alpha.63', + '@storybook/addon-outline': '6.5.0-alpha.63', + '@storybook/addon-storyshots': '6.5.0-alpha.63', + '@storybook/addon-storyshots-puppeteer': '6.5.0-alpha.63', + '@storybook/addon-storysource': '6.5.0-alpha.63', + '@storybook/addon-toolbars': '6.5.0-alpha.63', + '@storybook/addon-viewport': '6.5.0-alpha.63', + '@storybook/addons': '6.5.0-alpha.63', + '@storybook/angular': '6.5.0-alpha.63', + '@storybook/api': '6.5.0-alpha.63', + '@storybook/builder-webpack4': '6.5.0-alpha.63', + '@storybook/builder-webpack5': '6.5.0-alpha.63', + '@storybook/channel-postmessage': '6.5.0-alpha.63', + '@storybook/channel-websocket': '6.5.0-alpha.63', + '@storybook/channels': '6.5.0-alpha.63', + '@storybook/cli': '6.5.0-alpha.63', + '@storybook/client-api': '6.5.0-alpha.63', + '@storybook/client-logger': '6.5.0-alpha.63', + '@storybook/codemod': '6.5.0-alpha.63', + '@storybook/components': '6.5.0-alpha.63', + '@storybook/core': '6.5.0-alpha.63', + '@storybook/core-client': '6.5.0-alpha.63', + '@storybook/core-common': '6.5.0-alpha.63', + '@storybook/core-events': '6.5.0-alpha.63', + '@storybook/core-server': '6.5.0-alpha.63', + '@storybook/csf-tools': '6.5.0-alpha.63', + '@storybook/docs-tools': '6.5.0-alpha.63', + '@storybook/ember': '6.5.0-alpha.63', + '@storybook/html': '6.5.0-alpha.63', + '@storybook/instrumenter': '6.5.0-alpha.63', + '@storybook/manager-webpack4': '6.5.0-alpha.63', + '@storybook/manager-webpack5': '6.5.0-alpha.63', + '@storybook/node-logger': '6.5.0-alpha.63', + '@storybook/postinstall': '6.5.0-alpha.63', + '@storybook/preact': '6.5.0-alpha.63', + '@storybook/preview-web': '6.5.0-alpha.63', + '@storybook/react': '6.5.0-alpha.63', + '@storybook/router': '6.5.0-alpha.63', + '@storybook/server': '6.5.0-alpha.63', + '@storybook/source-loader': '6.5.0-alpha.63', + '@storybook/store': '6.5.0-alpha.63', + '@storybook/svelte': '6.5.0-alpha.63', + '@storybook/theming': '6.5.0-alpha.63', + '@storybook/ui': '6.5.0-alpha.63', + '@storybook/vue': '6.5.0-alpha.63', + '@storybook/vue3': '6.5.0-alpha.63', + '@storybook/web-components': '6.5.0-alpha.63', +}; From a5c0866320eddfb5cfd83c800cb992b6c5402cf3 Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Thu, 14 Apr 2022 14:21:39 +0200 Subject: [PATCH 4/8] chore: update lockfile --- yarn.lock | 1 + 1 file changed, 1 insertion(+) diff --git a/yarn.lock b/yarn.lock index 9b0b9f5a399..a9ebffe8c1d 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7322,6 +7322,7 @@ __metadata: jscodeshift: ^0.13.1 json5: ^2.1.3 leven: ^3.1.0 + prettier: ">=2.2.1 <=2.3.0" prompts: ^2.4.0 puppeteer-core: ^2.1.1 read-pkg-up: ^7.0.1 From 0feb7bc8527dc622703eb678085de45f0444a394 Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Thu, 14 Apr 2022 14:28:31 +0200 Subject: [PATCH 5/8] chore: use lint command to format versions.ts --- .../scripts/generate-sb-packages-versions.js | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/lib/cli/scripts/generate-sb-packages-versions.js b/lib/cli/scripts/generate-sb-packages-versions.js index 18944ebf5aa..807b154fe25 100755 --- a/lib/cli/scripts/generate-sb-packages-versions.js +++ b/lib/cli/scripts/generate-sb-packages-versions.js @@ -1,8 +1,8 @@ #!/usr/bin/env node const { readJson, writeFile } = require('fs-extra'); +const { exec } = require('child_process'); const path = require('path'); -const prettier = require('prettier'); const globby = require('globby'); const semver = require('@storybook/semver'); const { default: dedent } = require('ts-dedent'); @@ -41,20 +41,17 @@ const run = async () => { .sort((package1, package2) => package1.name.localeCompare(package2.name)) .reduce((acc, { name }) => ({ ...acc, [name]: updatedVersion }), {}); - const prettierConfig = await prettier.resolveConfig( - path.join(__dirname, '..', '..', '..', '.prettierrc') - ); - await writeFile( path.join(__dirname, '..', 'src', 'versions.ts'), - prettier.format( - dedent` + dedent` // auto generated file, do not edit export default ${JSON.stringify(packageToVersionMap, null, 2)} - `, - { ...prettierConfig, parser: 'typescript' } - ) + ` ); + + exec(`yarn eslint --fix ${path.join(__dirname, '..', 'src', 'versions.ts')}`, { + cwd: path.join(__dirname, '..', '..', '..'), + }); }; run().catch((e) => { From 0bffb794c8cbeb810aed4d6e2d89854a41d5bd3a Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Thu, 14 Apr 2022 14:33:23 +0200 Subject: [PATCH 6/8] chore: remove prettier as dev dependency from sb cli --- lib/cli/package.json | 1 - yarn.lock | 1 - 2 files changed, 2 deletions(-) diff --git a/lib/cli/package.json b/lib/cli/package.json index 7b9e1b81972..c04a5d30e12 100644 --- a/lib/cli/package.json +++ b/lib/cli/package.json @@ -82,7 +82,6 @@ "@types/semver": "^7.3.4", "@types/shelljs": "^0.8.7", "@types/update-notifier": "^5.0.0", - "prettier": ">=2.2.1 <=2.3.0", "strip-json-comments": "^3.1.1", "update-notifier": "^5.0.1" }, diff --git a/yarn.lock b/yarn.lock index a9ebffe8c1d..9b0b9f5a399 100644 --- a/yarn.lock +++ b/yarn.lock @@ -7322,7 +7322,6 @@ __metadata: jscodeshift: ^0.13.1 json5: ^2.1.3 leven: ^3.1.0 - prettier: ">=2.2.1 <=2.3.0" prompts: ^2.4.0 puppeteer-core: ^2.1.1 read-pkg-up: ^7.0.1 From 2fa45d815b7f00f9535ced4b862f670d095c80e0 Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Thu, 14 Apr 2022 14:33:39 +0200 Subject: [PATCH 7/8] chore: use lint command instead of eslint directly --- lib/cli/scripts/generate-sb-packages-versions.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/cli/scripts/generate-sb-packages-versions.js b/lib/cli/scripts/generate-sb-packages-versions.js index 807b154fe25..aab6c42ccb0 100755 --- a/lib/cli/scripts/generate-sb-packages-versions.js +++ b/lib/cli/scripts/generate-sb-packages-versions.js @@ -49,7 +49,7 @@ const run = async () => { ` ); - exec(`yarn eslint --fix ${path.join(__dirname, '..', 'src', 'versions.ts')}`, { + exec(`yarn lint:js:cmd --fix ${path.join(__dirname, '..', 'src', 'versions.ts')}`, { cwd: path.join(__dirname, '..', '..', '..'), }); }; From 36be97a7e3baa4b49b6099a8578c2830e8caea89 Mon Sep 17 00:00:00 2001 From: Yann Braga Date: Fri, 15 Apr 2022 14:55:21 +0200 Subject: [PATCH 8/8] remove stories from deprecated addons: options and queryparams --- .../stories/addon-options.stories.js | 29 ------------------- .../stories/addon-queryparams.stories.js | 27 ----------------- 2 files changed, 56 deletions(-) delete mode 100644 examples/official-storybook/stories/addon-options.stories.js delete mode 100644 examples/official-storybook/stories/addon-queryparams.stories.js diff --git a/examples/official-storybook/stories/addon-options.stories.js b/examples/official-storybook/stories/addon-options.stories.js deleted file mode 100644 index 0ee37459418..00000000000 --- a/examples/official-storybook/stories/addon-options.stories.js +++ /dev/null @@ -1,29 +0,0 @@ -import React from 'react'; - -export default { - title: 'Addons/Options', -}; - -export const SettingName = () => ( -
This story should have changed the name of the storybook
-); - -SettingName.storyName = 'setting name'; - -SettingName.parameters = { - options: { - name: 'Custom Storybook', - }, -}; - -export const HidingAddonPanel = () => ( -
This story should have changed hidden the addons panel
-); - -HidingAddonPanel.storyName = 'hiding addon panel'; - -HidingAddonPanel.parameters = { - options: { - showPanel: false, - }, -}; diff --git a/examples/official-storybook/stories/addon-queryparams.stories.js b/examples/official-storybook/stories/addon-queryparams.stories.js deleted file mode 100644 index 4b0cd74f7b0..00000000000 --- a/examples/official-storybook/stories/addon-queryparams.stories.js +++ /dev/null @@ -1,27 +0,0 @@ -import global from 'global'; -import React from 'react'; - -const { document } = global; - -export default { - title: 'Addons/QueryParams', - - parameters: { - query: { - mock: true, - }, - }, -}; - -export const MockIsTrue = () => ( -
This story should have an extra url query param: {document.location.search}
-); - -MockIsTrue.storyName = 'mock is true'; - -export const MockIs4 = () => ( -
This story should have an extra url query param: {document.location.search}
-); - -MockIs4.storyName = 'mock is 4'; -MockIs4.parameters = { query: { mock: 4 } };