Skip to content

Commit 192babf

Browse files
committed
docs: updated files & folders documentation
1 parent 99404b4 commit 192babf

File tree

1 file changed

+15
-8
lines changed

1 file changed

+15
-8
lines changed

docs/files-folder-structure.adoc

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
## Files and folder structure
22

3-
patternlab system structure files and folders are formatted in italic. Most common aspects like `package.json` are being left out.
3+
link:https://patternlab.io/[pattern lab] system structure files and folders are formatted in italic. Most common aspects like `package.json` are being left out.
44

5+
* `.husky`: Storing the Git lifecycle scripts / hooks like e.g. regarding [commit message linting](adr/linting-git.adoc) or pre-commit code formatting via link:adr/code_style_formatter-prettier.adoc[prettier] supported by link:https://www.npmjs.com/package/husky[husky]
6+
* `.vscode`: Providing Microsoft Visual Studio Code IDE configurations, currently recommended extensions
57
* `docs`: including relevant documentation as well as ADRs
68
* `_helpers_`: storing handlebars helper scripts
79
* `_public_`: for the _patternlab_ system exports
@@ -18,17 +20,22 @@ patternlab system structure files and folders are formatted in italic. Most comm
1820
*** `04-pages`: We'd like to provide further (example) pages in the near future, like e.g. an imprint or login
1921
*** `00-global.md`: Intro page for the patternlab system
2022
** `_css_`: Skeleton SCSS files that are including the SCSS files within the __patterns_ subfolders
21-
*** `_pattern-scaffolding.css_`: _patternlab_ system related file for styling the Patternlab UI
22-
*** `_pattern-scaffolding-project-specific.css_`: individual styles for the _patternlab_ UI
23-
** `fonts`: Including the relevant Webfonts and Iconfonts, as well as their sources
23+
*** `helpers`: Providing some global SCSS helpers that are supporting common use cases
24+
*** `_db-ui-core.variables.scss`: Including global variables for DB UI Core that is only being handled as a SCSS partial
25+
*** `_rollup.assets-paths.scss` & `_webpack.assets-paths.scss`: Include either one of those in your SCSS file depending if and which bundler you're using in your setup before you `@import "db-ui-core";`; we're adapting the paths to assets in here differentiated by the different bundlers formats
26+
*** `db-ui-core.general.scss`: Providing some general global styles (especially) for DB UI Elements to be included in every Web Component and thatfor is actually meant to get exported during build as `db-ui-core.general.css`
27+
*** `db-ui-core.vars.scss`: Providing global variables (especially) for DB UI Elements that is actually meant to get exported during build as `db-ui-core.vars.css`
28+
*** `_pattern-scaffolding.css_`: _patternlab_ system related file for styling the _pattern lab_ UI
29+
*** `_pattern-scaffolding-project-specific.scss_`: individual styles for the _pattern lab_ UI
30+
** `fonts`: Including the relevant Webfonts, as well as their sources
2431
** `_images_`: Providing some relevant image files:
2532
*** `appicons`: Possible app icon files
26-
*** `icons`: All of the icons as SVG files as well (recommended`: use the Icon Webfont)
27-
*** `samples`: sample image files
2833
** `_js_`: target folder for babels JS build process
2934
** `pattern-template`: Template files to get used by the /scripts/create-component.sh script for creating new components
35+
** `samples`: sample image and video files
3036
* `tests`: BackstopJS testing tools related files (configuration and reference files)
3137
* `.browserslistrc`: Standard file to including a list of browsers to support, used by e.g. PostCSS
38+
* `.commitlintrc.json`: Configuration file for the commitlint tool
3239
* `.ecrc`: Configuration file (mainly for excludes for now) for the linter link:https://github.com/editorconfig-checker/editorconfig-checker[`editorconfig-checker`] on code conventions defined by `.editorconfig`, which is brought to us via `super-linter`
3340
* `.editorconfig`: Including code conventions
3441
* `.eslintignore`: Files to exclude from eslinting (like e.g. `xo` as well)
@@ -39,8 +46,9 @@ patternlab system structure files and folders are formatted in italic. Most comm
3946
* `.jscpd.json`: Configuration file (mainly for ignores for now) for the linter link:https://github.com/kucherenko/jscpd/[`jscpd`], which is brought to us via `super-linter`
4047
* `.lighthouse-budget.json`: Configuration file for link:https://web.dev/use-lighthouse-for-performance-budgets/[storing Google Lighthouse performance budgets]
4148
* `.markdownlintignore`: files and folders to get ignored by Markdownlinter
42-
* `.markdownlintrc`: Configuring all the relevant rules for markdown linting / https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
49+
* `.markdownlintrc.json`: Configuring all the relevant rules for markdown linting / https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md
4350
* `.npmignore`: Handling files that wouldn't need to get included within the NPM package
51+
* `.nvmrc`: Currently used node version as a configuration for the [Node Version Manager](https://github.com/nvm-sh/nvm)
4452
* `.pa11yci`: Configuration file for the accessibility testing tool
4553
* `.postcssrc`: Configuration file for the PostCSS CSS "pastprocessing" tool
4654
* `.prettierignore`: files and folders to ignore by link:adr/code_style_formatter-prettier.html[_prettier.io_ code formatter]: link:https://prettier.io/docs/en/ignore.html
@@ -49,7 +57,6 @@ patternlab system structure files and folders are formatted in italic. Most comm
4957
* `.stylelintrc.json`: Configuration file for our link:adr/linting-stylelint.html[_stylelint_ CSS/SCSS/SASS code linter]
5058
* `.xo-config.json`: Configuration file for our link:adr/linting-xo.html[_xo_ JavaScript code linter]
5159
* `.yamllint.yml`: yamllint link:https://yamllint.readthedocs.io/en/stable/configuration.html[configuration file]
52-
* `.commitlintrc.json`: Configuration file for the commitlint tool
5360
* `_dependencyGraph.json_ (optional)`: This file gets generated as cache/temp file by the _patternlab_ system for persisting the pattern stucture
5461
* `Dockerfile`: relevant for our CI/CD process
5562
* `_*.patternlab-config.json_`: These files contain the relevant _patternlab_ system configurations

0 commit comments

Comments
 (0)