@rolemodel/optics 0.3.1 → 0.4.1

package/.babelrc.json

@@ -0,0 +1,14 @@
+{
+  "sourceType": "unambiguous",
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "chrome": 100
+        }
+      }
+    ]
+  ],
+  "plugins": []
+}

package/.github/pull_request_template.md

@@ -19,6 +19,7 @@ What changed in this PR?
 
 - [ ] Have you updated any usage of changed tokens?
 - [ ] Have you updated the docs with any component changes?
+- [ ] Have you updated the dependency graph with any component changes?
 - [ ] Have you run linters?
 - [ ] Have you run prettier?
 - [ ] Have you tried building the css?

package/.github/workflows/publish-storybook.yml

@@ -29,6 +29,6 @@ jobs:
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH: gh-pages # The branch the action should deploy to.
-          FOLDER: docs-build # The folder that the build-storybook script generates files.
+          FOLDER: storybook-static # The folder that the build-storybook script generates files.
           CLEAN: true # Automatically remove deleted files from the deploy branch
           TARGET_FOLDER: docs # The folder that we serve our Storybook files from

package/.prettierignore

@@ -0,0 +1,2 @@
+# Tools
+tools/templates

package/README.md

@@ -38,20 +38,6 @@ We use [Storybook](https://storybook.js.org/docs/html/get-started/introduction)
 
 It can be found here [Optics Documentation](https://docs.optics.rolemodel.design/)
 
-## Tokens
-
-Tokens are defined in `src/core/tokens`
-
-- All core tokens are defined in `src/core/tokens/base_tokens.scss`
-- Basic color tokens are defined in `src/core/tokens/example_color_tokens.scss`
-- Color scale tokens are defined in `src/core/tokens/scale_color_tokens.scss`
-- Alert color tokens are defined in `src/core/tokens/alert_color_tokens.scss`
-- Dark mode tokens are defined in `src/core/tokens/dark_mode_tokens.scss`
-
-There are also a few component specific tokens that are defined in their respective component file, but those are not indented to be global or used outside of that file.
-
-There is a JSON file in `docs/token_structure.json` that lists all the current tokens in one place and shows how the names indicate organization.
-
 ### Token Documentation
 
 We use the Storybook Design Token for showing design tokens in the documentation. This allows us to tag groups of tokens with a category and a presenter.
@@ -67,6 +53,16 @@ Add the following above a group to categorize the tokens.
 */
 ```
 
+### Component Documentation
+
+Additional stories can be added using the following command, or copying an existing story.
+
+```sh
+npm run generate
+```
+
+The visual graphic found on the Selective Imports page in the documentation is generated from the `tools/generate-graph.dot` file. You can preview and export a newer svg version of the graphic by using the `tintinweb.graphviz-interactive-preview` VSCode extension.
+
 ## License
 
 [MIT](LICENSE)