From d1901046d85d4b0b4c10cf8a9221dad081bd2028 Mon Sep 17 00:00:00 2001 From: Josh Black Date: Wed, 30 Jan 2019 15:10:31 -0600 Subject: [PATCH] chore(project): clean up preview examples and prettier usage (#311) * chore(project): rename basic examples to preview * chore: clean up tasks * chore(project): fix prettier config for faster results * chore(project): run format * chore(prettier): update prettierignore --- .github/CONTRIBUTING.md | 2 +- .prettierignore | 7 +++++++ package.json | 4 ++-- packages/colors/README.md | 5 +++-- packages/colors/examples/preview/package.json | 2 +- packages/grid/README.md | 7 ------- packages/grid/examples/{basic => preview}/.sassrc.js | 0 packages/grid/examples/{basic => preview}/index.html | 0 packages/grid/examples/{basic => preview}/package.json | 2 +- .../examples/{basic => preview}/src/components/App.js | 0 .../{basic => preview}/src/components/AspectRatioPage.js | 0 .../{basic => preview}/src/components/BasicUsagePage.js | 0 .../{basic => preview}/src/components/BleedPage.js | 0 .../{basic => preview}/src/components/CondensedPage.js | 0 .../{basic => preview}/src/components/ExampleContent.js | 0 .../{basic => preview}/src/components/ExamplesPage.js | 0 .../examples/{basic => preview}/src/components/Fluid.js | 0 .../{basic => preview}/src/components/FullBleedPage.js | 0 .../{basic => preview}/src/components/FullWidth.js | 0 .../examples/{basic => preview}/src/components/Grid.js | 0 .../{basic => preview}/src/components/HangPage.js | 0 .../examples/{basic => preview}/src/components/Main.js | 0 .../{basic => preview}/src/components/NotFound.js | 0 .../{basic => preview}/src/components/OffsetPage.js | 0 .../{basic => preview}/src/components/PaddingPage.js | 0 packages/grid/examples/{basic => preview}/src/index.js | 0 .../grid/examples/{basic => preview}/src/tools/grid.js | 0 packages/grid/examples/{basic => preview}/styles.scss | 0 packages/grid/examples/{basic => preview}/yarn.lock | 0 packages/icons/README.md | 7 ------- packages/icons/examples/{esm => preview}/.babelrc | 0 packages/icons/examples/{esm => preview}/index.html | 0 packages/icons/examples/{esm => preview}/index.js | 0 packages/icons/examples/{esm => preview}/package.json | 2 +- packages/icons/examples/{esm => preview}/styles.scss | 0 packages/icons/examples/{esm => preview}/yarn.lock | 0 packages/layout/README.md | 1 - packages/layout/examples/{basic => preview}/index.html | 0 packages/layout/examples/{basic => preview}/package.json | 2 +- packages/layout/examples/{basic => preview}/styles.scss | 0 packages/layout/examples/{basic => preview}/yarn.lock | 0 packages/motion/README.md | 8 ++++---- tasks/ci-check.js | 2 +- 43 files changed, 22 insertions(+), 29 deletions(-) rename packages/grid/examples/{basic => preview}/.sassrc.js (100%) rename packages/grid/examples/{basic => preview}/index.html (100%) rename packages/grid/examples/{basic => preview}/package.json (74%) rename packages/grid/examples/{basic => preview}/src/components/App.js (100%) rename packages/grid/examples/{basic => preview}/src/components/AspectRatioPage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/BasicUsagePage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/BleedPage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/CondensedPage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/ExampleContent.js (100%) rename packages/grid/examples/{basic => preview}/src/components/ExamplesPage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/Fluid.js (100%) rename packages/grid/examples/{basic => preview}/src/components/FullBleedPage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/FullWidth.js (100%) rename packages/grid/examples/{basic => preview}/src/components/Grid.js (100%) rename packages/grid/examples/{basic => preview}/src/components/HangPage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/Main.js (100%) rename packages/grid/examples/{basic => preview}/src/components/NotFound.js (100%) rename packages/grid/examples/{basic => preview}/src/components/OffsetPage.js (100%) rename packages/grid/examples/{basic => preview}/src/components/PaddingPage.js (100%) rename packages/grid/examples/{basic => preview}/src/index.js (100%) rename packages/grid/examples/{basic => preview}/src/tools/grid.js (100%) rename packages/grid/examples/{basic => preview}/styles.scss (100%) rename packages/grid/examples/{basic => preview}/yarn.lock (100%) rename packages/icons/examples/{esm => preview}/.babelrc (100%) rename packages/icons/examples/{esm => preview}/index.html (100%) rename packages/icons/examples/{esm => preview}/index.js (100%) rename packages/icons/examples/{esm => preview}/package.json (95%) rename packages/icons/examples/{esm => preview}/styles.scss (100%) rename packages/icons/examples/{esm => preview}/yarn.lock (100%) rename packages/layout/examples/{basic => preview}/index.html (100%) rename packages/layout/examples/{basic => preview}/package.json (91%) rename packages/layout/examples/{basic => preview}/styles.scss (100%) rename packages/layout/examples/{basic => preview}/yarn.lock (100%) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 3c343305..aa3f6e49 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -47,7 +47,7 @@ If you want to help improve the docs, it's a good idea to let others know what y $ git remote add upstream git@github.com:IBM/carbon-elements.git $ git remote -v ``` - + 4. Switch to our version of Node. If you are using (nvm [Node Version Manager)](https://github.com/creationix/nvm), you can run `nvm use` to quicky switch Node versions. If you are aren't using nvm, you can still check the `.nvmrc` dotfile in the root of this project to find the major stable version of Node we are using, and then you can switch manually. ### Submitting an Issue diff --git a/.prettierignore b/.prettierignore index 6fde8025..676be36b 100644 --- a/.prettierignore +++ b/.prettierignore @@ -8,3 +8,10 @@ ts # Storybook examples **/storybook/stories/** + +# Package-specific +packages/colors/scss/* +packages/elements/scss/* +!packages/elements/scss/elements.scss +!packages/elements/scss/index.scss +packages/themes/scss/* diff --git a/package.json b/package.json index fb7b6f88..36fed391 100644 --- a/package.json +++ b/package.json @@ -19,8 +19,8 @@ "clean": "lerna run clean && lerna clean --yes && rimraf build && rimraf node_modules", "doctoc": "doctoc --title '## Table of Contents' docs", "examples": "rimraf build && yarn build && node tasks/examples.js", - "format": "prettier --write \"**/*.{css,js,md,scss,ts}\"", - "format:diff": "prettier --list-different \"**/*.{css,js,md,scss,ts}\"", + "format": "prettier --write '**/*.{css,js,md,scss,ts}' '!**/{build,es,lib,storybook,ts,umd}/**'", + "format:diff": "prettier --list-different '**/*.{css,js,md,scss,ts}' '!**/{build,es,lib,storybook,ts,umd}/**'", "format:staged": "prettier --write", "lint": "toolkit lint .", "lint:styles": "toolkit stylelint \"**/*.{css,scss}\"", diff --git a/packages/colors/README.md b/packages/colors/README.md index cfd56b58..0208038b 100644 --- a/packages/colors/README.md +++ b/packages/colors/README.md @@ -37,8 +37,9 @@ import { black, blue, warmGray } from '@carbon/colors'; const { black, blue, warmGray } = require('@carbon/colors'); ``` -Each color swatch is exported as a variable, and each color name is also exported as an object that can be called -by specifying grade, for example: +Each color swatch is exported as a variable, and each color name is +also exported as an object that can be called by specifying grade, for +example: ```js black; diff --git a/packages/colors/examples/preview/package.json b/packages/colors/examples/preview/package.json index 569d940b..9923c487 100644 --- a/packages/colors/examples/preview/package.json +++ b/packages/colors/examples/preview/package.json @@ -4,7 +4,7 @@ "version": "0.0.0", "license": "Apache-2.0", "scripts": { - "build": "parcel build -d build --public-url \"/colors/examples/basic\" index.html", + "build": "parcel build -d build --public-url \"/colors/examples/preview\" index.html", "develop": "parcel index.html --no-cache" }, "devDependencies": { diff --git a/packages/grid/README.md b/packages/grid/README.md index 19a08217..8baf43d0 100644 --- a/packages/grid/README.md +++ b/packages/grid/README.md @@ -68,13 +68,6 @@ span one column at our `sm` breakpoint. By default, as we scale beyond the breakpoint the layout will still take up a percentage of the overall width. -## 📚 Examples - -If you're looking for more examples on how to use `@carbon/grid`, we -have some examples that you can check out: - -- [Basic](./examples/basic) - ## 🙌 Contributing We're always looking for contributors to help us fix bugs, build new diff --git a/packages/grid/examples/basic/.sassrc.js b/packages/grid/examples/preview/.sassrc.js similarity index 100% rename from packages/grid/examples/basic/.sassrc.js rename to packages/grid/examples/preview/.sassrc.js diff --git a/packages/grid/examples/basic/index.html b/packages/grid/examples/preview/index.html similarity index 100% rename from packages/grid/examples/basic/index.html rename to packages/grid/examples/preview/index.html diff --git a/packages/grid/examples/basic/package.json b/packages/grid/examples/preview/package.json similarity index 74% rename from packages/grid/examples/basic/package.json rename to packages/grid/examples/preview/package.json index 0c163b3c..1f179d79 100644 --- a/packages/grid/examples/basic/package.json +++ b/packages/grid/examples/preview/package.json @@ -4,7 +4,7 @@ "version": "0.0.0", "license": "Apache-2.0", "scripts": { - "build": "export PATH_PREFIX=\"/grid/examples/basic\" && parcel build -d build --public-url $PATH_PREFIX index.html", + "build": "export PATH_PREFIX=\"/grid/examples/preview\" && parcel build -d build --public-url $PATH_PREFIX index.html", "develop": "parcel index.html --no-cache" }, "devDependencies": { diff --git a/packages/grid/examples/basic/src/components/App.js b/packages/grid/examples/preview/src/components/App.js similarity index 100% rename from packages/grid/examples/basic/src/components/App.js rename to packages/grid/examples/preview/src/components/App.js diff --git a/packages/grid/examples/basic/src/components/AspectRatioPage.js b/packages/grid/examples/preview/src/components/AspectRatioPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/AspectRatioPage.js rename to packages/grid/examples/preview/src/components/AspectRatioPage.js diff --git a/packages/grid/examples/basic/src/components/BasicUsagePage.js b/packages/grid/examples/preview/src/components/BasicUsagePage.js similarity index 100% rename from packages/grid/examples/basic/src/components/BasicUsagePage.js rename to packages/grid/examples/preview/src/components/BasicUsagePage.js diff --git a/packages/grid/examples/basic/src/components/BleedPage.js b/packages/grid/examples/preview/src/components/BleedPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/BleedPage.js rename to packages/grid/examples/preview/src/components/BleedPage.js diff --git a/packages/grid/examples/basic/src/components/CondensedPage.js b/packages/grid/examples/preview/src/components/CondensedPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/CondensedPage.js rename to packages/grid/examples/preview/src/components/CondensedPage.js diff --git a/packages/grid/examples/basic/src/components/ExampleContent.js b/packages/grid/examples/preview/src/components/ExampleContent.js similarity index 100% rename from packages/grid/examples/basic/src/components/ExampleContent.js rename to packages/grid/examples/preview/src/components/ExampleContent.js diff --git a/packages/grid/examples/basic/src/components/ExamplesPage.js b/packages/grid/examples/preview/src/components/ExamplesPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/ExamplesPage.js rename to packages/grid/examples/preview/src/components/ExamplesPage.js diff --git a/packages/grid/examples/basic/src/components/Fluid.js b/packages/grid/examples/preview/src/components/Fluid.js similarity index 100% rename from packages/grid/examples/basic/src/components/Fluid.js rename to packages/grid/examples/preview/src/components/Fluid.js diff --git a/packages/grid/examples/basic/src/components/FullBleedPage.js b/packages/grid/examples/preview/src/components/FullBleedPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/FullBleedPage.js rename to packages/grid/examples/preview/src/components/FullBleedPage.js diff --git a/packages/grid/examples/basic/src/components/FullWidth.js b/packages/grid/examples/preview/src/components/FullWidth.js similarity index 100% rename from packages/grid/examples/basic/src/components/FullWidth.js rename to packages/grid/examples/preview/src/components/FullWidth.js diff --git a/packages/grid/examples/basic/src/components/Grid.js b/packages/grid/examples/preview/src/components/Grid.js similarity index 100% rename from packages/grid/examples/basic/src/components/Grid.js rename to packages/grid/examples/preview/src/components/Grid.js diff --git a/packages/grid/examples/basic/src/components/HangPage.js b/packages/grid/examples/preview/src/components/HangPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/HangPage.js rename to packages/grid/examples/preview/src/components/HangPage.js diff --git a/packages/grid/examples/basic/src/components/Main.js b/packages/grid/examples/preview/src/components/Main.js similarity index 100% rename from packages/grid/examples/basic/src/components/Main.js rename to packages/grid/examples/preview/src/components/Main.js diff --git a/packages/grid/examples/basic/src/components/NotFound.js b/packages/grid/examples/preview/src/components/NotFound.js similarity index 100% rename from packages/grid/examples/basic/src/components/NotFound.js rename to packages/grid/examples/preview/src/components/NotFound.js diff --git a/packages/grid/examples/basic/src/components/OffsetPage.js b/packages/grid/examples/preview/src/components/OffsetPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/OffsetPage.js rename to packages/grid/examples/preview/src/components/OffsetPage.js diff --git a/packages/grid/examples/basic/src/components/PaddingPage.js b/packages/grid/examples/preview/src/components/PaddingPage.js similarity index 100% rename from packages/grid/examples/basic/src/components/PaddingPage.js rename to packages/grid/examples/preview/src/components/PaddingPage.js diff --git a/packages/grid/examples/basic/src/index.js b/packages/grid/examples/preview/src/index.js similarity index 100% rename from packages/grid/examples/basic/src/index.js rename to packages/grid/examples/preview/src/index.js diff --git a/packages/grid/examples/basic/src/tools/grid.js b/packages/grid/examples/preview/src/tools/grid.js similarity index 100% rename from packages/grid/examples/basic/src/tools/grid.js rename to packages/grid/examples/preview/src/tools/grid.js diff --git a/packages/grid/examples/basic/styles.scss b/packages/grid/examples/preview/styles.scss similarity index 100% rename from packages/grid/examples/basic/styles.scss rename to packages/grid/examples/preview/styles.scss diff --git a/packages/grid/examples/basic/yarn.lock b/packages/grid/examples/preview/yarn.lock similarity index 100% rename from packages/grid/examples/basic/yarn.lock rename to packages/grid/examples/preview/yarn.lock diff --git a/packages/icons/README.md b/packages/icons/README.md index 393f482c..ed75d923 100644 --- a/packages/icons/README.md +++ b/packages/icons/README.md @@ -18,13 +18,6 @@ command instead: yarn add @carbon/icons ``` -## 📚 Examples - -If you're looking for more examples on how to use `@carbon/icons`, we -have some examples that you can check out: - -- [Esm](./examples/esm) - ## 🙌 Contributing We're always looking for contributors to help us fix bugs, build new diff --git a/packages/icons/examples/esm/.babelrc b/packages/icons/examples/preview/.babelrc similarity index 100% rename from packages/icons/examples/esm/.babelrc rename to packages/icons/examples/preview/.babelrc diff --git a/packages/icons/examples/esm/index.html b/packages/icons/examples/preview/index.html similarity index 100% rename from packages/icons/examples/esm/index.html rename to packages/icons/examples/preview/index.html diff --git a/packages/icons/examples/esm/index.js b/packages/icons/examples/preview/index.js similarity index 100% rename from packages/icons/examples/esm/index.js rename to packages/icons/examples/preview/index.js diff --git a/packages/icons/examples/esm/package.json b/packages/icons/examples/preview/package.json similarity index 95% rename from packages/icons/examples/esm/package.json rename to packages/icons/examples/preview/package.json index b88596b7..94724032 100644 --- a/packages/icons/examples/esm/package.json +++ b/packages/icons/examples/preview/package.json @@ -4,7 +4,7 @@ "version": "0.0.0", "license": "Apache-2.0", "scripts": { - "build": "parcel build -d build --public-url \"/icons/examples/esm\" index.html", + "build": "parcel build -d build --public-url \"/icons/examples/preview\" index.html", "develop": "parcel index.html --no-cache" }, "devDependencies": { diff --git a/packages/icons/examples/esm/styles.scss b/packages/icons/examples/preview/styles.scss similarity index 100% rename from packages/icons/examples/esm/styles.scss rename to packages/icons/examples/preview/styles.scss diff --git a/packages/icons/examples/esm/yarn.lock b/packages/icons/examples/preview/yarn.lock similarity index 100% rename from packages/icons/examples/esm/yarn.lock rename to packages/icons/examples/preview/yarn.lock diff --git a/packages/layout/README.md b/packages/layout/README.md index e6e9a9e6..133715a5 100644 --- a/packages/layout/README.md +++ b/packages/layout/README.md @@ -47,7 +47,6 @@ feel free to file an issue proposing the new addition! If you're looking for more examples on how to use `@carbon/layout`, we have some examples that you can check out: -- [Basic](./examples/basic) - [Styled-components](./examples/styled-components) ## 🙌 Contributing diff --git a/packages/layout/examples/basic/index.html b/packages/layout/examples/preview/index.html similarity index 100% rename from packages/layout/examples/basic/index.html rename to packages/layout/examples/preview/index.html diff --git a/packages/layout/examples/basic/package.json b/packages/layout/examples/preview/package.json similarity index 91% rename from packages/layout/examples/basic/package.json rename to packages/layout/examples/preview/package.json index ce32b90c..93967be2 100644 --- a/packages/layout/examples/basic/package.json +++ b/packages/layout/examples/preview/package.json @@ -4,7 +4,7 @@ "version": "0.0.0", "license": "Apache-2.0", "scripts": { - "build": "parcel build -d build --public-url \"/layout/examples/basic\" index.html", + "build": "parcel build -d build --public-url \"/layout/examples/preview\" index.html", "develop": "parcel index.html --no-cache" }, "devDependencies": { diff --git a/packages/layout/examples/basic/styles.scss b/packages/layout/examples/preview/styles.scss similarity index 100% rename from packages/layout/examples/basic/styles.scss rename to packages/layout/examples/preview/styles.scss diff --git a/packages/layout/examples/basic/yarn.lock b/packages/layout/examples/preview/yarn.lock similarity index 100% rename from packages/layout/examples/basic/yarn.lock rename to packages/layout/examples/preview/yarn.lock diff --git a/packages/motion/README.md b/packages/motion/README.md index 895cf6bf..98fc9f51 100644 --- a/packages/motion/README.md +++ b/packages/motion/README.md @@ -27,10 +27,10 @@ curves using either Sass or JavaScript. ### Sass -`@carbon/motion` exports a `carbon--motion` function and `carbon--motion` mixin that -you can use to access the value of a motion curve or include that -curve as the `transition-property` for a selector. To use these -helpers, you can do the following in your project: +`@carbon/motion` exports a `carbon--motion` function and `carbon--motion` mixin that you can use to access the value of a motion +curve or include that curve as the `transition-property` for a +selector. To use these helpers, you can do the following in your +project: ```scss @import '@carbon/motion/scss/motion.scss'; diff --git a/tasks/ci-check.js b/tasks/ci-check.js index eeb60b0d..285fcc99 100644 --- a/tasks/ci-check.js +++ b/tasks/ci-check.js @@ -10,7 +10,7 @@ async function main() { cwd: process.cwd(), }; const tasks = [ - 'yarn toolkit format:diff', + 'yarn format:diff', `yarn bundler check --ignore '**/@(node_modules|examples)/**' 'packages/**/*.scss'`, `yarn test --ci --reporters=default --reporters=jest-junit --testPathIgnorePatterns='examples'`, ];