@cagovweb/design-system - npm Package Compare versions

Comparing version 1.2.0 to 1.3.1

.vscode/settings.json

@@ -13,3 +13,6 @@ {
 		"quickfix.biome": "explicit"
+	},
+	"[html]": {
+		"editor.defaultFormatter": "vscode.html-language-features"
 	}
 }

CHANGELOG.md

 # Changelog
 
+## [1.3.1](https://github.com/Office-of-Digital-Services/California-Design-System/compare/v1.3.0...v1.3.1) (2024-11-21)
+
+
+### Bug Fixes
+
+* Remedy missing dist folder during bundles ([36cd14a](https://github.com/Office-of-Digital-Services/California-Design-System/commit/36cd14a7323f42dcc1ef2b1b2efa032c8927dedb))
+
+## [1.3.0](https://github.com/Office-of-Digital-Services/California-Design-System/compare/v1.2.0...v1.3.0) (2024-11-21)
+
+
+### Features
+
+* Add CSS reset ([51f4d65](https://github.com/Office-of-Digital-Services/California-Design-System/commit/51f4d659b1430d33e5ee2ae8884bbb3ad74cc92f))
+* Bundle into ZIP file ([9595e44](https://github.com/Office-of-Digital-Services/California-Design-System/commit/9595e44cb819bdd1c39b5e1ec5fd7603a23f0bf6))
+* More elements ([beb5f5e](https://github.com/Office-of-Digital-Services/California-Design-System/commit/beb5f5ea6a8e8e9b32e90022cc4906d4ceadbee3))
+* Prepare files for default elements ([cd3d67e](https://github.com/Office-of-Digital-Services/California-Design-System/commit/cd3d67ede331a5f1346a9e12aab7b4d27da3a540))
+* Skeleton theme and color-scheme toggle ([5985fad](https://github.com/Office-of-Digital-Services/California-Design-System/commit/5985fadf9b5c2b7d75af5388d9ce87a4eb3c1d79))
+
+
+### Bug Fixes
+
+* Github Pages linking ([80a168c](https://github.com/Office-of-Digital-Services/California-Design-System/commit/80a168c8bd510619427f8a08a4d443da9034e14c))
+
 ## [1.2.0](https://github.com/Office-of-Digital-Services/California-Design-System/compare/v1.1.0...v1.2.0) (2024-11-19)
@@ -4,0 +27,0 @@

eleventy.config.js

@@ -0,1 +1,3 @@
+
+import { EleventyHtmlBasePlugin } from "@11ty/eleventy";
 import cssBuilder from "./tools/bundlers/css-builder.js";
@@ -30,3 +32,5 @@ import jsBuilder from "./tools/bundlers/js-builder.js";
 
-	eleventyConfig.addGlobalData("layout", "_layout");
+	eleventyConfig.addPlugin(EleventyHtmlBasePlugin);
+
+	eleventyConfig.addGlobalData("layout", "layout");
 	eleventyConfig.addPassthroughCopy({
@@ -54,3 +58,3 @@ "static/images": "images",
 			// site structure pages (path is relative to input directory)
-			includes: "tools/11ty",
+			includes: "tools/11ty/_includes",
 			// site final output directory
@@ -57,0 +61,0 @@ output: "_site",

package.json

 {
 	"name": "@cagovweb/design-system",
-	"version": "1.2.0",
+	"version": "1.3.1",
 	"type": "module",
@@ -10,2 +10,3 @@ "main": "dist/bundle.js",
 		"site": "npx @11ty/eleventy",
+		"site:gh-pages": "npx @11ty/eleventy --pathprefix /California-Design-System/",
 		"bundle": "node tools/bundlers/run-bundlers.js",
@@ -22,2 +23,3 @@ "format": "npx @biomejs/biome format --write",
 		"@biomejs/biome": "1.9.4",
+		"archiver": "^7.0.1",
 		"chalk": "^5.3.0",
@@ -24,0 +26,0 @@ "esbuild": "^0.24.0",

src/js/_bundle.js

 import "./base.js";
 import "./header.js";
+import "./theme.js";

tools/bundlers/css-builder.js

@@ -6,15 +6,11 @@ import { promises as fs } from "node:fs";
 
-const packageData = await fs
-	.readFile("package.json")
-	.then((data) => JSON.parse(data));
-
-const banner = `/*
-* California Design System
-* https://github.com/Office-of-Digital-Services/California-Design-System
-* 
-* Version: ${packageData.version}
-* Release Notes: https://github.com/Office-of-Digital-Services/California-Design-System/releases/tag/v${packageData.version}
-*/`;
-
-export default async function (distPath, { minify = false } = {}) {
+/**
+ * Compiles the CSS bundle to a given path.
+ * @param {string} distPath The output path of the finished CSS file.
+ * @param {Object} options An optional collection of settings.
+ * @param {string} options.banner A commented banner to place at the top of the built file.
+ * @param {boolean} options.minify A toggle to enable minification of the build output.
+ * @returns {Promise}
+ */
+export default async function (distPath, { banner = "", minify = false } = {}) {
 	const srcPath = "src/css/_bundle.css";
@@ -21,0 +17,0 @@

tools/bundlers/js-builder.js

@@ -1,18 +0,13 @@
-import { promises as fs } from "node:fs";
 import chalk from "chalk";
 import esbuild from "esbuild";
 
-const packageData = await fs
-	.readFile("package.json")
-	.then((data) => JSON.parse(data));
-
-const banner = `/*
-* California Design System
-* https://github.com/Office-of-Digital-Services/California-Design-System
-* 
-* Version: ${packageData.version}
-* Release Notes: https://github.com/Office-of-Digital-Services/California-Design-System/releases/tag/v${packageData.version}
-*/`;
-
-export default async function (distPath, { minify = false } = {}) {
+/**
+ * Compiles the Javascript bundle to a given path.
+ * @param {string} distPath The output path of the finished JS file.
+ * @param {Object} options An optional collection of settings.
+ * @param {string} options.banner A commented banner to place at the top of the built file.
+ * @param {boolean} options.minify A toggle to enable minification of the build output.
+ * @returns {Promise}
+ */
+export default async function (distPath, { banner = "", minify = false } = {}) {
 	const srcPath = "src/js/_bundle.js";
@@ -19,0 +14,0 @@

tools/bundlers/run-bundlers.js

@@ -0,7 +1,33 @@
+import { promises as fs } from "node:fs";
 import cssBuilder from "./css-builder.js";
 import jsBuilder from "./js-builder.js";
+import zipBuilder from "./zip-builder.js";
 
-await cssBuilder("dist/bundle.css");
-await cssBuilder("dist/bundle.min.css", { minify: true });
-await jsBuilder("dist/bundle.js");
-await jsBuilder("dist/bundle.min.js", { minify: true });
+const packageData = await fs
+	.readFile("package.json")
+	.then((data) => JSON.parse(data));
+
+// Common fileName for bundle files.
+const fileSlug = `dist/California-Design-System-${packageData.version}`;
+
+// Banner is placed at the top of bundled CSS and JS files.
+const banner = `/*
+* California Design System
+* https://github.com/Office-of-Digital-Services/California-Design-System
+* 
+* Version: ${packageData.version}
+* Release Notes: https://github.com/Office-of-Digital-Services/California-Design-System/releases/tag/v${packageData.version}
+*/`;
+
+// Delete old build files.
+await fs.rm("dist", { recursive: true, force: true });
+await fs.mkdir("dist");
+
+// Build all files first.
+await cssBuilder(`${fileSlug}.css`, { banner });
+await cssBuilder(`${fileSlug}.min.css`, { banner, minify: true });
+await jsBuilder(`${fileSlug}.js`, { banner });
+await jsBuilder(`${fileSlug}.min.js`, { banner, minify: true });
+
+// Then compile builds into the zip.
+await zipBuilder("dist", `${fileSlug}.zip`);

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

280024

increased by18.23%

Number of package files

45

increased by9.76%

Lines of code

3470

increased by13.1%

Worsened metrics

Dev dependency count

7

increased by16.67%

No dependency changes