-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
70 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -7,7 +7,7 @@ It includes: | |
- A [Style Dictionary](https://v4.styledictionary.com/) configuration for defining design tokens. | ||
- A sensible project layout and organized SCSS files for themes, components, layouts, and base styles. | ||
- SCSS mixins and functions for accessing design tokens. | ||
- [Esbuild](https://esbuild.github.io/) configuration with [dart-sass](https://sass-lang.com/dart-sass/) and [PostCSS](https://postcss.org/). | ||
- [Esbuild](https://esbuild.github.io/) configuration with [dart-sass](https://sass-lang.com/dart-sass/), [PostCSS](https://postcss.org/), [autoprefixer](https://github.com/postcss/autoprefixer), and [PurgeCSS](https://purgecss.com/). | ||
- A [Stylelint](https://stylelint.io/) configuration. | ||
- [pnpm](https://pnpm.io/) as package manager. | ||
|
||
|
@@ -20,8 +20,32 @@ the repository into your project and adapt it to your needs. | |
git clone [email protected]:woylie/barker.git | ||
cd barker | ||
rm -rf .github .git | ||
pnpm install | ||
``` | ||
|
||
## Configuration | ||
|
||
- `build.js`: Contains the build configuration for Esbuild, as well as the | ||
PostCSS configuration and PurgeCSS configuration (disabled by default). | ||
- `style-dictionary.js`: Contains the configuration for Style Dictionary. You | ||
can modify the output formats for the design tokens here. Note that the SCSS | ||
files depend on the `scss` output format. | ||
|
||
## Commands | ||
|
||
| Description | Command | | ||
| --------------------------------------------------- | ------------------------- | | ||
| Development build (tokens, CSS, JS, etc.) | `pnpm build:dev` | | ||
| Production build (tokens, CSS, JS, etc.) | `pnpm build:prod` | | ||
| Watch mode (does not watch Style Dictionary tokens) | `pnpm build:dev:watch` | | ||
| Build Style Dictionary tokens | `pnpm build:tokens` | | ||
| Run linters | `pnpm lint` | | ||
| Fix linter issues | `pnpm lint:fix` | | ||
| Run Prettier | `pnpm lint:prettier` | | ||
| Fix Prettier issues | `pnpm lint:prettier:fix` | | ||
| Run Stylelint | `pnpm lint:stylelint` | | ||
| Fix Stylelint issues | `pnpm lint:stylelint:fix` | | ||
|
||
## Folder Structure | ||
|
||
. | ||
|
@@ -79,21 +103,6 @@ corresponding `_index.scss` files. | |
│ └── ... | ||
└── ... | ||
|
||
## Commands | ||
|
||
| Description | Command | | ||
| --------------------------------------------------- | ------------------------- | | ||
| Development build (tokens, CSS, JS, etc.) | `pnpm build:dev` | | ||
| Production build (tokens, CSS, JS, etc.) | `pnpm build:prod` | | ||
| Watch mode (does not watch Style Dictionary tokens) | `pnpm build:dev:watch` | | ||
| Build Style Dictionary tokens | `pnpm build:tokens` | | ||
| Run linters | `pnpm lint` | | ||
| Fix linter issues | `pnpm lint:fix` | | ||
| Run Prettier | `pnpm lint:prettier` | | ||
| Fix Prettier issues | `pnpm lint:prettier:fix` | | ||
| Run Stylelint | `pnpm lint:stylelint` | | ||
| Fix Stylelint issues | `pnpm lint:stylelint:fix` | | ||
|
||
## Resources | ||
|
||
- The design token structure is based on [Design Tokens Format](https://design-tokens.github.io/community-group/format/) where possible. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.