Skip to content

Commit 0e20bef

Browse files
authored
simplify storybook build (#32)
1 parent 6b9f79d commit 0e20bef

File tree

15 files changed

+2340
-3030
lines changed

15 files changed

+2340
-3030
lines changed

README.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
11
# <img align="center" src="doc/img/syrup.svg" width="52" height="52">cushman toolkit
22

3-
| unit of release | repository |
4-
| --------------- | ---------- |
3+
| unit of release | repository |
4+
| -------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
55
| [`@a110/rito` React Lib](packages/lib/rito/) | [![npm version](https://badge.fury.io/js/@a110%2Frito.svg)](https://www.npmjs.com/package/@a110/rito) |
6+
7+
## What is this?
8+
9+
This project is a [_monorepo_](https://en.wikipedia.org/wiki/Monorepo) that hosts
10+
an [_npm library_](https://www.npmjs.com/package/@a110/rito) that's intended for
11+
use in [_React frontend applications_](https://reactjs.org/).
12+
13+
The simplest way to explore the primary content here would be to visit [the Storybook
14+
page, that's hosted here on GitHub Pages](https://llaenowyd.github.io/cushman/).
15+
16+
## How to use it?
17+
18+
The library, `@a110/rito`, can be added to a React appliction with either
19+
`yarn add @a110/rito` or `npm i --save @a110/rito`. More instructions should
20+
be available in the [package-level documentation](packages/lib/rito/README.md).
21+
22+
## How to hack on it?
23+
24+
1. Fork and clone, checkout a branch
25+
2. `yarn`
26+
3. `yarn build`
27+
4. `yarn dev-rito-sb`
28+
5. Pull requests welcome!

package.json

+6-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@a110/cushman",
3-
"version": "0.0.1",
3+
"version": "0.0.13",
44
"description": "toolkit",
55
"private": true,
66
"workspaces": {
@@ -31,6 +31,10 @@
3131
"npm-run-all": "^4.1.5",
3232
"prettier": "^2.6.2",
3333
"pretty-quick": "^3.1.3",
34-
"rimraf": "^3.0.2"
34+
"rimraf": "^3.0.2",
35+
"yarn": "^1.22.19"
36+
},
37+
"engines": {
38+
"node": ">=16"
3539
}
3640
}

packages/apps/rito-sb/.storybook/DocsContainer.jsx

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React from 'react'
2-
import { DocsContainer as BaseContainer } from '@storybook/addon-docs/blocks'
2+
import { DocsContainer as BaseContainer } from '@storybook/addon-docs'
33
import { useDarkMode } from 'storybook-dark-mode'
44
import { themes } from '@storybook/theming'
55
import {
+1-18
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
const path = require('path')
2-
const { mergeConfig } = require('vite')
32

43
module.exports = {
54
stories: ['../src/**/*.stories.mdx', '../src/**/*.stories.@(js|jsx|ts|tsx)'],
@@ -8,25 +7,9 @@ module.exports = {
87
'@storybook/addon-essentials',
98
'@storybook/addon-interactions',
109
'storybook-dark-mode',
11-
{
12-
name: '@storybook/addon-docs',
13-
options: {
14-
configureJSX: true,
15-
babelOptions: {},
16-
sourceLoaderOptions: { parser: 'typescript' },
17-
transcludeMarkdown: true,
18-
},
19-
},
2010
'@a110/storybook-expand-all',
11+
'storybook-css-modules',
2112
],
2213
framework: '@storybook/react',
23-
core: {
24-
builder: '@storybook/builder-vite',
25-
},
2614
staticDirs: [path.join('..', 'public')],
27-
async viteFinal(config, { configType }) {
28-
return mergeConfig(config, {
29-
base: '',
30-
})
31-
},
3215
}

packages/apps/rito-sb/.storybook/preview.js

+5-8
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
1-
import { useDarkMode } from 'storybook-dark-mode'
1+
import { DocsPage } from '@storybook/addon-docs'
2+
// import { useDarkMode } from 'storybook-dark-mode'
23
import { themes } from '@storybook/theming'
34

45
import DocsContainer from './DocsContainer'
56
import darkTheme from './darkTheme'
67
import lightTheme from './lightTheme'
78

8-
import '@a110/rito/default-palettes.css'
9+
import '@a110/rito/dist/styles/default-palettes.css'
910

1011
export const parameters = {
11-
actions: { argTypesRegex: '^on[A-Z].*' }, // tbd maybe don't need
1212
controls: {
1313
expanded: true,
14-
matchers: {
15-
color: /(background|color)$/i, // tbd maybe don't need
16-
date: /Date$/, // tbd maybe don't need
17-
},
1814
},
1915
darkMode: {
2016
dark: darkTheme, // caution don't add variables here
@@ -29,10 +25,11 @@ export const parameters = {
2925
stylePreview: true,
3026
},
3127
viewMode: 'docs',
32-
previewTabs: { 'storybook/docs/panel': { index: -1 } },
28+
// previewTabs: { 'storybook/docs/panel': { index: -1 } },
3329
docs: {
3430
source: { format: false },
3531
container: DocsContainer,
32+
// page: DocsPage,
3633
},
3734
options: {
3835
storySort: {

packages/apps/rito-sb/package.json

+19-18
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,45 @@
11
{
22
"name": "@a110/rito-sb",
33
"private": true,
4-
"version": "0.0.1",
4+
"version": "0.0.13",
55
"scripts": {
66
"clean": "rimraf storybook-static",
77
"dev": "start-storybook -p 6006",
88
"dev:libwatch": "nodemon --watch ../../packages/rito/dist -e ts,tsx --exec \"start-storybook -p 6006\"",
9-
"dev:app": "vite",
10-
"build:app": "tsc && vite build",
11-
"preview:app": "vite preview",
129
"storybook": "start-storybook -p 6006",
1310
"build-storybook": "build-storybook",
1411
"serve": "serve storybook-static"
1512
},
1613
"dependencies": {
1714
"@a110/rito": "*",
18-
"@a110/storybook-expand-all": "^1.0.9",
15+
"@a110/storybook-expand-all": "^1.1.1",
1916
"react": "^18.0.0",
20-
"react-dom": "^18.0.0"
17+
"react-dom": "^18.0.0",
18+
"react-syntax-highlighter": "^15.5.0"
2119
},
2220
"devDependencies": {
2321
"@babel/core": "^7.17.10",
24-
"@storybook/addon-actions": "^6.5.0",
25-
"@storybook/addon-docs": "^6.5.0",
26-
"@storybook/addon-essentials": "^6.5.0",
27-
"@storybook/addon-interactions": "^6.5.0",
28-
"@storybook/addon-links": "^6.5.0",
29-
"@storybook/builder-vite": "^0.1.33",
30-
"@storybook/react": "^6.5.0",
31-
"@storybook/testing-library": "^0.0.11",
32-
"@storybook/theming": "^6.5.0",
22+
"@storybook/addon-actions": "^6.5.10",
23+
"@storybook/addon-essentials": "^6.5.10",
24+
"@storybook/addon-interactions": "^6.5.10",
25+
"@storybook/addon-links": "^6.5.10",
26+
"@storybook/addons": "^6.5.10",
27+
"@storybook/api": "^6.5.10",
28+
"@storybook/builder-webpack4": "^6.5.10",
29+
"@storybook/components": "^6.5.10",
30+
"@storybook/core-events": "^6.5.10",
31+
"@storybook/manager-webpack4": "^6.5.10",
32+
"@storybook/react": "^6.5.10",
33+
"@storybook/testing-library": "^0.0.13",
34+
"@storybook/theming": "^6.5.10",
3335
"@types/react": "^18.0.0",
3436
"@types/react-dom": "^18.0.0",
35-
"@vitejs/plugin-react": "^1.3.0",
3637
"babel-loader": "^8.2.5",
3738
"nodemon": "^2.0.16",
3839
"rimraf": "^3.0.2",
3940
"serve": "^13.0.2",
41+
"storybook-css-modules": "^1.0.8",
4042
"storybook-dark-mode": "^1.1.0",
41-
"typescript": "^4.6.3",
42-
"vite": "^2.9.7"
43+
"typescript": "^4.6.3"
4344
}
4445
}

packages/apps/rito-sb/src/main.tsx

-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import React from 'react'
22
import ReactDOM from 'react-dom/client'
33
import App from './App'
4-
import './index.css'
54

65
ReactDOM.createRoot(document.getElementById('root')!).render(
76
<React.StrictMode>

0 commit comments

Comments
 (0)