Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add support for css to storybook #4950

Merged
merged 15 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17,855 changes: 3,779 additions & 14,076 deletions package-lock.json

Large diffs are not rendered by default.

79 changes: 0 additions & 79 deletions packages/react/.storybook/main.js

This file was deleted.

59 changes: 59 additions & 0 deletions packages/react/.storybook/main.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
import {createRequire} from 'node:module'
import path from 'node:path'
import postcssPresetPrimer from 'postcss-preset-primer'
import type {StorybookConfig} from '@storybook/react-vite'

const require = createRequire(import.meta.url)

const {DEPLOY_ENV = 'development'} = process.env

const config: StorybookConfig = {
stories:
DEPLOY_ENV === 'development'
? ['../src/**/*.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)']
: // Don't include dev stories in production
['../src/**/*.mdx', '../src/**/!(*.dev).stories.@(js|jsx|ts|tsx)'],
addons: [
{
name: '@storybook/addon-essentials',
options: {
backgrounds: false,
},
},
getAbsolutePath('@storybook/addon-storysource'),
getAbsolutePath('@storybook/addon-interactions'),
getAbsolutePath('@storybook/addon-a11y'),
getAbsolutePath('@storybook/addon-links'),
],

framework: {
name: '@storybook/react-vite',
options: {},
},
async viteFinal(config) {
config.define = {
...config.define,
__DEV__: JSON.stringify(true),
}

config.css = {
...config.css,
modules: {
...config.css?.modules,
generateScopedName: 'prc_[local]_[hash:base64:5]',
},
postcss: {
...config.css?.postcss,
plugins: [postcssPresetPrimer()],
},
joshblack marked this conversation as resolved.
Show resolved Hide resolved
}

return config
},
}

export default config

function getAbsolutePath(value) {
return path.dirname(require.resolve(path.join(value, 'package.json')))
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {addons, types} from '@storybook/addons'
import {addons, types} from '@storybook/manager-api'
import {useGlobals} from '@storybook/manager-api'
import {IconButton, WithTooltip, TooltipLinkList} from '@storybook/components'
import {BeakerIcon} from '@primer/octicons-react'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import {PrimerBreakpoints} from '../src/utils/layout'
import React, {useEffect} from 'react'
import {ThemeProvider, BaseStyles, theme} from '../src'
import {ThemeProvider, BaseStyles} from '../src'
import {FeatureFlags} from '../src/FeatureFlags'
import {DefaultFeatureFlags} from '../src/FeatureFlags/DefaultFeatureFlags'
import {clsx} from 'clsx'
Expand Down
2 changes: 1 addition & 1 deletion packages/react/.storybook/src/accessibility-tool.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import React, {useCallback} from 'react'
import {useGlobals} from '@storybook/api'
import {useGlobals} from '@storybook/manager-api'
import {IconButton, Icons} from '@storybook/components'

export const ADDON_ID = 'show-surrounding-links'
Expand Down
30 changes: 12 additions & 18 deletions packages/react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,20 +137,17 @@
"@rollup/plugin-terser": "0.4.3",
"@rollup/plugin-typescript": "11.1.5",
"@rollup/plugin-virtual": "3.0.2",
"@storybook/addon-a11y": "^8.1.5",
"@storybook/addon-actions": "^8.1.5",
"@storybook/addon-essentials": "^8.1.5",
"@storybook/addon-interactions": "^8.1.5",
"@storybook/addon-links": "^8.1.5",
"@storybook/addon-storysource": "^8.1.5",
"@storybook/addon-styling": "1.3.7",
"@storybook/addon-webpack5-compiler-babel": "3.0.3",
"@storybook/addons": "7.6.17",
"@storybook/csf": "0.1.2",
"@storybook/react": "^8.1.5",
"@storybook/react-webpack5": "^8.1.5",
"@storybook/source-loader": "^8.1.5",
"@storybook/theming": "^8.1.5",
"@storybook/addon-a11y": "^8.3.0",
"@storybook/addon-actions": "^8.3.0",
"@storybook/addon-essentials": "^8.3.0",
"@storybook/addon-interactions": "^8.3.0",
"@storybook/addon-links": "^8.3.0",
"@storybook/addon-storysource": "^8.3.0",
"@storybook/preview-api": "^8.3.0",
"@storybook/react": "^8.3.0",
"@storybook/react-vite": "^8.3.0",
"@storybook/source-loader": "^8.3.0",
"@storybook/theming": "^8.3.0",
"@testing-library/dom": "^10.4.0",
"@testing-library/jest-dom": "^6.4.5",
"@testing-library/react": "^16.0.0",
Expand All @@ -169,7 +166,6 @@
"ajv": "8.16.0",
"axe-core": "4.9.1",
"babel-core": "7.0.0-bridge.0",
"babel-loader": "^9.1.0",
"babel-plugin-add-react-displayname": "0.0.5",
"babel-plugin-dev-expression": "0.2.3",
"babel-plugin-macros": "3.1.0",
Expand Down Expand Up @@ -212,8 +208,7 @@
"rollup-plugin-postcss": "4.0.2",
"rollup-plugin-visualizer": "5.9.2",
"semver": "7.6.2",
"storybook": "^8.1.5",
"storybook-addon-turbo-build": "2.0.1",
"storybook": "^8.3.0",
"styled-components": "5.3.11",
"terser": "5.31.0",
"ts-toolbelt": "9.6.0",
Expand All @@ -223,7 +218,6 @@
"unist-util-find": "3.0.0",
"unist-util-find-before": "4.0.0",
"unist-util-flat-filter": "2.0.0",
"webpack": "5.94.0",
"yaml": "2.3.4"
},
"peerDependencies": {
Expand Down
8 changes: 0 additions & 8 deletions packages/react/postcss.config.mjs

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import {DiffIcon, PlusIcon} from '@primer/octicons-react'
import type {Meta} from '@storybook/react'
import React from '@storybook/react'
import {useRef, useState} from 'react'
import React, {useRef, useState} from 'react'
import Box from '../../Box'
import type {Emoji, Mentionable, Reference, SavedReply} from '.'
import MarkdownEditor from '.'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
import type {Meta} from '@storybook/react'
import React from '@storybook/react'
import {useState} from 'react'
import React, {useState} from 'react'
import BaseStyles from '../../BaseStyles'
import Box from '../../Box'
import type {Emoji, Mentionable, Reference, SavedReply} from '.'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type {Meta} from '@storybook/react'
import React from '@storybook/react'
import {debounce} from 'lodash'
import {useCallback, useMemo, useState} from 'react'
import React, {useCallback, useMemo, useState} from 'react'
import BaseStyles from '../../BaseStyles'
import Box from '../../Box'
import ThemeProvider from '../../ThemeProvider'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import type {Meta} from '@storybook/react'
import React from '@storybook/react'
import {debounce} from 'lodash'
import {useCallback, useMemo, useState} from 'react'
import React, {useCallback, useMemo, useState} from 'react'
import BaseStyles from '../../BaseStyles'
import Box from '../../Box'
import ThemeProvider from '../../ThemeProvider'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
// Utility functions used in theme-preval.js
// This file needs to be a JavaScript file using CommonJS to be compatible with preval
// Temporarily disabling since this is originally a JavaScript that needed to be
// migrated to TypeScript for exports to work as correctly in Vite.
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-nocheck

const isEmpty = require('lodash.isempty')
const isObject = require('lodash.isobject')
import isEmpty from 'lodash.isempty'
import isObject from 'lodash.isobject'

function fontStack(fonts) {
return fonts.map(font => (font.includes(' ') ? `"${font}"` : font)).join(', ')
Expand Down Expand Up @@ -54,15 +56,21 @@ function partitionColors(colors) {
}

function omitScale(obj) {
// This is intentionally removing `scale` from the provided object
// eslint-disable-next-line @typescript-eslint/no-unused-vars
const {scale, ...rest} = obj
return rest
}

module.exports = {
const themeUtils = {
fontStack,
isShadowValue,
isColorValue,
filterObject,
partitionColors,
omitScale,
}

export {fontStack, isShadowValue, isColorValue, filterObject, partitionColors, omitScale}

export default themeUtils
Loading