@bloomreach/banana-theme - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

package.json

 {
   "name": "@bloomreach/banana-theme",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Bloomreach Banana Theme",
@@ -16,3 +16,7 @@ "repository": {
     "./css/theme.css": "./dist/css/theme.css",
-    "./css/fonts.css": "./dist/css/fonts.css"
+    "./css/theme-unresolved.css": "./dist/css/theme-unresolved.css",
+    "./css/fonts.css": "./dist/css/fonts.css",
+    "./html/tokens.html": "./dist/html/tokens.html",
+    "./json/base.json": "./dist/json/base.json",
+    "./json/theme.json": "./dist/json/theme.json"
   },
@@ -22,9 +26,15 @@ "browser": {
     "./css/theme.css": "./dist/css/theme.css",
-    "./css/fonts.css": "./dist/css/fonts.css"
+    "./css/theme-unresolved.css": "./dist/css/theme-unresolved.css",
+    "./css/fonts.css": "./dist/css/fonts.css",
+    "./html/tokens.html": "./dist/html/tokens.html",
+    "./json/base.json": "./dist/json/base.json",
+    "./json/theme.json": "./dist/json/theme.json"
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "ts-node ./scripts/build.ts",
+    "changelog": "ts-node ./scripts/changelog.ts",
     "clean": "rm -rf dist",
@@ -36,10 +46,14 @@ "lint": "eslint .",
   "devDependencies": {
+    "@badisi/latest-version": "6.1.8",
     "@bloomreach/eslint-config-base": "1.2.0",
     "@fontsource/inter": "5.0.3",
     "@fontsource/roboto-mono": "5.0.5",
-    "@tokens-studio/sd-transforms": "0.10.1",
+    "@tokens-studio/sd-transforms": "0.10.3",
     "@types/fs-extra": "11.0.1",
+    "@types/lodash": "4.14.195",
+    "axios": "1.4.0",
     "eslint": "8.44.0",
     "eslint-plugin-jsonc": "2.9.0",
     "fs-extra": "11.1.1",
+    "lodash": "4.17.21",
     "style-dictionary": "3.8.0",
@@ -46,0 +60,0 @@ "ts-node": "10.9.1",

README.md

@@ -44,2 +44,13 @@ # Bloomreach Banana Theme
 
+#### Debugging or Customizing the theme at runtime
+
+To accommodate these use cases, the Banana theme package exports a `theme-unresolved.css` file that contains the
+unresolved CSS variables. This file can be used to debug or customize the theme at runtime. To use this file, import it
+into your project's CSS alongside the `base.css` file.
+
+```css
+@import '@bloomreach/banana-theme/css/base.css';
+@import '@bloomreach/banana-theme/css/theme-unresolved.css';
+```
+
 #### Design Token Naming Scheme
@@ -93,6 +104,8 @@
  - `dist/css/base.css`
- - `dist/css/theme.css`
- - `dist/css/fonts.css`
- - `dist/assets/fonts/*.woff`
- - `dist/assets/fonts/*.woff2`
+ - `dist/css/theme.css` (CSS variables)
+ - `dist/css/theme-unresolved.css`
+ - `dist/css/fonts.css` (font rules)
+ - `dist/html/tokens.html` (HTML table with all tokens)
+ - `dist/assets/fonts/*.woff` (font files)
+ - `dist/assets/fonts/*.woff2` (font files)
 
@@ -147,5 +160,21 @@ Ensure the dependencies are installed with `npm ci` before running the `build` command.
 
-The release process is split into two steps: bumping the version and publishing the package. The version should be bumped
-by the developer, the package is then published by the CI/CD pipeline.
+The release process is split into three steps: generating the changelog, bumping the version and publishing the
+package. Generating the changelog and bumping the version is handled by the developer, the package is then published by
+the CI/CD pipeline.
 
+### Changelog
+To generate the changelog, run the following command:
+
+```bash
+npm run changelog <version> <fileName>
+```
+
+The version argument is the version that you are releasing, e.g. `0.0.1`. The fileName argument is the name of the file
+that the changelog will be written to, e.g. `CHANGELOG.md`. If the file already exists, the changelog will be appended to
+the file. If the fileName argument is omitted, the changelog will be written to the console.
+
+Note: the changelog will not include any Jira data other than the ticket number. For the best results, you should add
+the ticket title(s) manually.
+
+### Version
 To bump the version, we use the `npm version` command. This will update the version in the `package.json` file, the
@@ -164,3 +193,4 @@ `package-lock.json` file, and create a git tag.
 
+### Publish
 After bumping the version, push the changes to the remote repository. This will trigger the CI/CD pipeline to publish
 the package to the npm registry.

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

766513

increased by54.6%

Number of package files

38

increased by15.15%

Lines of code

1378

increased by378.47%

Number of lines in readme file

193

increased by18.4%

Worsened metrics

Dev dependency count

15

increased by36.36%

No dependency changes