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.

Sign up for GitHub

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

Mayflower v10: display rendered styles #1224

Merged
merged 12 commits into from
Oct 22, 2020
Merged

Mayflower v10: display rendered styles #1224

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
06da44b
WIP.
smurrayatwork Oct 16, 2020
cf88b36
Merge branch 'mayflower-v10' of github.com:massgov/mayflower into may…
smurrayatwork Oct 16, 2020
e73d29a
Adds support for displaying rendered styles and html for Header, Head…
smurrayatwork Oct 20, 2020
12737e6
Branch cleanup.
smurrayatwork Oct 20, 2020
b97c83e
Code cleanup.
smurrayatwork Oct 20, 2020
050ebcb
Fixes performance issues caused by prettier formatting displayed css.
smurrayatwork Oct 21, 2020
b356aac
Fixes visual regressions.
smurrayatwork Oct 21, 2020
83c1110
Reduces the number of scss files for preview to work.
smurrayatwork Oct 21, 2020
e549d12
Pulls in latest mayflower-v10, fixes merge conflicts.
smurrayatwork Oct 22, 2020
e0dcc0c
Updates pnpm lock file.
smurrayatwork Oct 22, 2020
98832dc
Updates preview component to use memoization on html display, removes…
smurrayatwork Oct 22, 2020
9fb73ad
Merge branch 'mayflower-v10' into mayflower-v10--display-rendered-styles
clairesunstudio Oct 22, 2020
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
478 changes: 475 additions & 3 deletions common/config/rush/pnpm-lock.yaml
View file
Open in desktop

Large diffs are not rendered by default.

98 changes: 80 additions & 18 deletions packages/react/.storybook/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ const assets = require('@massds/mayflower-assets');
const iconPath = path.resolve(__dirname, '../src/components/base/Icon/assets');
const nodeModules = path.resolve(path.join(process.cwd(), 'node_modules'));
const pnpmNodeModules = path.join(nodeModules, '.pnpm', 'node_modules');
const MiniCssExtractPlugin = require('mini-css-extract-plugin');

module.exports = {
stories: ['../src/**/*.stories.@(js|mdx)'],
Expand All @@ -29,31 +30,93 @@ module.exports = {
{
name: '@storybook/preset-scss',
options: {
cssLoaderOptions: {
sourceMap: true
styleLoaderOptions: false,
sassLoaderOptions: false,
cssLoaderOptions: false,
rule: {
oneOf: [
{
exclude: [
path.resolve(__dirname, '../src/index.scss')
],
use: [
{
loader: 'css-loader',
options: {
sourceMap: process.env.NODE_ENV === 'development'
}
},
{
loader: 'sass-loader',
options: {
sourceMap: process.env.NODE_ENV === 'development',
implementation: require('sass'),
sassOptions: {
// This ensures production builds of storybook maintain
// spacing for displaying styles.
outputStyle: 'expanded',
includePaths: [
nodeModules,
pnpmNodeModules,
path.resolve(__dirname, '../src'),
path.resolve(__dirname, '../src/components'),
path.resolve(__dirname, '../src/components/styles'),
].concat(assets.includePaths)
}
}
}
]
},
{
include: [
path.resolve(__dirname, '../src/index.scss')
],
use: [
{
loader: MiniCssExtractPlugin.loader
},
{
loader: 'css-loader',
options: {
sourceMap: process.env.NODE_ENV === 'development'
}
},
{
loader: 'sass-loader',
options: {
sourceMap: process.env.NODE_ENV === 'development',
implementation: require('sass'),
sassOptions: {
includePaths: [
nodeModules,
pnpmNodeModules,
path.resolve(__dirname, '../src'),
path.resolve(__dirname, '../src/components'),
path.resolve(__dirname, '../src/components/styles'),
].concat(assets.includePaths)
}
}
}
]
}
]
},
sassLoaderOptions: {
sourceMap: true,
implementation: require('sass'),
sassOptions: {
includePaths: [
nodeModules,
pnpmNodeModules,
path.resolve(__dirname, '../src'),
path.resolve(__dirname, '../src/components'),
path.resolve(__dirname, '../src/components/styles'),
].concat(assets.includePaths)
}
}
}
},
],
webpackFinal: (config, { configType }) => {
// modify storybook's file-loader rule to avoid conflicts with svgr
const fileLoaderRule = config.module.rules.find(rule => rule.test.test && rule.test.test('.svg'));
fileLoaderRule.exclude = iconPath;



config.plugins.push(
new MiniCssExtractPlugin({
// Options similar to the same options in webpackOptions.output
// both options are optional
filename: '[name].css',
chunkFilename: '[id].css',
})
);
config.module.rules.unshift({
test: /\.svg$/,
include: iconPath,
Expand All @@ -67,7 +130,6 @@ module.exports = {
},
],
});

config.resolve = {
...config.resolve,
alias: {
Expand Down
70 changes: 44 additions & 26 deletions packages/react/.storybook/preview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,16 @@ import {
Canvas, Story
} from '@storybook/addon-docs/blocks';
import { ActionBar, Source } from '@storybook/components';

import prettier from 'prettier/standalone';
import parserHtml from 'prettier/parser-html';
import { Prism as SyntaxHighlighter } from 'react-syntax-highlighter';
import { okaidia } from 'react-syntax-highlighter/dist/esm/styles/prism';
import parserCss from 'prettier/parser-postcss';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
import parserCss from 'prettier/parser-postcss';

this is no longer needed right?

import SyntaxHighlighter, { Renderer, Wrapper } from './syntax-highlighter';

import '../src/index.scss';

import logo from '!url-loader!@massds/mayflower-assets/static/images/stateseal.png';
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should use the UNPKG CDN for linking the assets (pending on the mayflower-assets release)


const storyKindOrder = [
'about', // storyKindOrder.indexOf -1 follow alphabetical order
'brand', // storyKindOrder.indexOf -1 follow alphabetical order
Expand All @@ -33,46 +37,60 @@ const storyKindOrder = [
'others/pages'
];

export const StoryPage = ({ StoryComponent = null, showStories = false, Description }) => {
export const StoryPage = ({ StoryComponent = null, showStories = false, Description, styles = null }) => {
const docsContext = React.useContext(DocsContext);
const [showHTML, setShowHTML] = React.useState(true);
const [showCSS, setShowCSS] = React.useState(true);

const css = React.useMemo(() => showCSS && styles ? styles.toString() : null, [showCSS, styles]);

const { id, name, parameters = {}, args } = docsContext;
const { component } = parameters;
const HtmlComponent = StoryComponent || component;
let html = null;
if (HtmlComponent) {
html = prettier.format(ReactDOMServer
.renderToStaticMarkup(
(
<HtmlComponent {...args} />
)),
{
htmlWhitespaceSensitivity: 'ignore',
endOfLine: 'auto',
parser: 'html',
plugins: [parserHtml]
}
);
}

let html = ReactDOMServer
.renderToStaticMarkup(
Copy link
Contributor

@clairesunstudio clairesunstudio Oct 21, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we use useMemo for html rendering too?

(
<HtmlComponent {...args} />
));
const actionItem = {
title: showHTML ? 'Hide HTML' : 'Show HTML?',
onClick: () => setShowHTML((prev) => !prev)
};
const cssActionItem = {
title: showCSS ? 'Hide Styles' : 'Show Styles?',
onClick: () => setShowCSS((prev) => !prev)
};

html = prettier.format(html,
{
htmlWhitespaceSensitivity: 'ignore',
endOfLine: 'auto',
parser: 'html',
plugins: [parserHtml]
});
// Replaces the path to the state seal with a base64 image.
html = html.replace(/static\/media\/stateseal\.(.*)\.png/, logo);


return(
<>
<Title>{component.displayName}</Title>
<Subtitle />
{ Description && <Description />}
<Primary name={name} />
<ArgsTable story={CURRENT_SELECTION}/>
{html && (
<Heading>
HTML
<ActionBar actionItems={[actionItem]} />
</Heading>
)}
{!showHTML && <Source storyId={id} error="Click Show HTML above to view markup source." />}
{html && showHTML && <Source storyId={id} language="html" code={html} dark />}
{html && (
<Heading>
HTML
<ActionBar actionItems={[actionItem]} />
</Heading>
)}
{!showHTML && <Source storyId={id} error="Click Show HTML above to view markup source." />}
{html && showHTML && <SyntaxHighlighter format={false} renderer={Renderer} language="html" code={html} dark />}
<Heading>Styles<ActionBar actionItems={[cssActionItem]} /></Heading>
{!showCSS && <Source storyId={id} error="Click Show Styles above to view styles source." />}
{css && showCSS && <SyntaxHighlighter format={false} renderer={Renderer} language="css" code={css} dark />}
{ showStories && <Stories />}
</>
);
Expand Down
Loading