Skip to content

[polaris.shopify.com] Get latest styles for local development #7554

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

Closed
wants to merge 3 commits into from
Closed

[polaris.shopify.com] Get latest styles for local development #7554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b2a3d0c
[polaris.shopify.com] Get latest styles for local development
kyledurand Oct 27, 2022
695f427
move stylesheetHref back out of component
kyledurand Oct 27, 2022
9bbf3b4
throw error on fail
kyledurand Oct 27, 2022
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
5 changes: 5 additions & 0 deletions .changeset/early-countries-march.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'polaris.shopify.com': patch
---

Copy polaris-react css to keep local dev in sync
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ node_modules
/polaris.shopify.com/public/sitemap.xml
/polaris.shopify.com/public/og-images
/polaris.shopify.com/public/playroom
/polaris.shopify.com/public/polaris-styles.css
5 changes: 3 additions & 2 deletions polaris.shopify.com/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"scripts": {
"build": "yarn gen-assets && playroom build && next build",
"start": "next start",
"dev": "run-p dev:*",
"dev": "yarn get-styles && run-p dev:*",
"dev:server": "open http://localhost:3000 && next dev",
"dev:playroom": "playroom start",
"dev:watch-md": "node scripts/watch-md.mjs",
Expand All @@ -16,7 +16,8 @@
"create-component": "generact --root src/components src/components/Template/Template.tsx",
"gen-sitemap": "yarn next-sitemap",
"get-props": "tsc ./scripts/get-props/src/get-props.ts --target esnext --module node16 --types \"react\" --outDir ./scripts/tmp && node ./scripts/tmp/scripts/get-props/src/get-props.js && rm -rf ./scripts/tmp",
"gen-assets": "node scripts/gen-assets.mjs"
"gen-assets": "node scripts/gen-assets.mjs",
"get-styles": "node scripts/get-styles.mjs"
},
"dependencies": {
"@floating-ui/react-dom-interactions": "^0.10.1",
Expand Down
12 changes: 12 additions & 0 deletions polaris.shopify.com/scripts/get-styles.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import fs from 'fs';

const builtStylesPath = '../polaris-react/build/esm/styles.css';
Copy link
Member Author

@kyledurand kyledurand Oct 27, 2022

Choose a reason for hiding this comment

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

I'm assuming Polaris is always built when yarn dev runs, otherwise other things would fail as well, right?

Copy link
Member

@alex-page alex-page Oct 28, 2022

Choose a reason for hiding this comment

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

Only if it happens at the root of the monorepo. This could be a little bit confusing if someone is running just the website.

const fileDestination = 'public/polaris-styles.css';

fs.copyFile(builtStylesPath, fileDestination, (error) => {
if (error) {
throw new Error(`Error copying styles file: ${error}`);
}

console.log('✅ Copied polaris styles');
});
4 changes: 3 additions & 1 deletion polaris.shopify.com/src/components/PolarisExampleWrapper/PolarisExampleWrapper.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ import {ComponentType} from 'react';
import styles from './PolarisExampleWrapper.module.scss';

const stylesheetHref =
'https://unpkg.com/@shopify/polaris@latest/build/esm/styles.css';
process.env.NODE_ENV === 'development'
? '/polaris-styles.css'
: 'https://unpkg.com/@shopify/polaris@latest/build/esm/styles.css';

export const withPolarisExample = (Component: ComponentType) => {
const PolarisHOC = (props: any) => {
Expand Down