better-asset 0.1.1 → 0.1.2

package/README.md

@@ -94,15 +94,15 @@ Add a `$schema` key for editor autocompletion:
 
 ### Asset Fields
 
-| Field         | Type    | Required | Default | Description                                  |
-| ------------- | ------- | -------- | ------- | -------------------------------------------- |
-| `name`        | string  | yes      | —       | Base name for generated files                |
-| `source`      | string  | yes      | —       | Source filename (relative to `source_dir`)   |
-| `sizes`       | array   | yes      | —       | Sizes to generate                            |
-| `destination` | string  | yes      | —       | Output directory (relative to project root)  |
-| `format`      | string  | no       | `"png"` | Output format: `png`, `webp`, `jpeg`, `avif` |
-| `sizeInName`  | boolean | no       | auto    | Force include/exclude size in filename       |
-| `ico`         | object  | no       | —       | Generate a `favicon.ico`                     |
+| Field         | Type              | Required | Default | Description                                  |
+| ------------- | ----------------- | -------- | ------- | -------------------------------------------- |
+| `name`        | string            | yes      | —       | Base name for generated files                |
+| `source`      | string            | yes      | —       | Source filename (relative to `source_dir`)   |
+| `sizes`       | array             | yes      | —       | Sizes to generate                            |
+| `destination` | string            | yes      | —       | Output directory (relative to project root)  |
+| `format`      | string            | no       | `"png"` | Output format: `png`, `webp`, `jpeg`, `avif` |
+| `sizeInName`  | boolean           | no       | auto    | Force include/exclude size in filename       |
+| `ico`         | boolean \| object | no       | —       | Generate a `favicon.ico`                     |
 
 ## Size Rules
 
@@ -134,7 +134,14 @@ Override per asset:
 
 ## ICO Generation
 
-Add an `ico` object to generate a real `favicon.ico`:
+Use `ico` as either a boolean shortcut or an object:
+
+```json
+{ "ico": true }
+{ "ico": false }
+```
+
+Or use the object form for more control:
 
 ```json
 {
@@ -145,10 +152,10 @@ Add an `ico` object to generate a real `favicon.ico`:
 }
 ```
 
-| Field      | Type    | Default | Description                            |
-| ---------- | ------- | ------- | -------------------------------------- |
-| `required` | boolean | —       | Whether to generate the `.ico` file    |
-| `size`     | number  | `64`    | Size of the embedded PNG in the `.ico` |
+| Field      | Type    | Required | Default | Description                            |
+| ---------- | ------- | -------- | ------- | -------------------------------------- |
+| `required` | boolean | yes      | —       | Whether to generate the `.ico` file    |
+| `size`     | number  | no       | `64`    | Size of the embedded PNG in the `.ico` |
 
 ## License
 

package/assets.config.schema.json

@@ -62,21 +62,29 @@
 						"description": "Force include/exclude size in filename. Default: included when multiple sizes, omitted for single size."
 					},
 					"ico": {
-						"type": "object",
-						"description": "Generate a favicon.ico file from this asset.",
-						"required": ["required"],
-						"properties": {
-							"required": {
+						"oneOf": [
+							{
 								"type": "boolean",
-								"description": "Whether to generate the .ico file."
+								"description": "Shortcut: true generates favicon.ico (default size: 64), false disables it."
 							},
-							"size": {
-								"type": "integer",
-								"minimum": 1,
-								"default": 64,
-								"description": "Size of the embedded PNG in the .ico file (default: 64)."
+							{
+								"type": "object",
+								"description": "Generate a favicon.ico file from this asset.",
+								"required": ["required"],
+								"properties": {
+									"required": {
+										"type": "boolean",
+										"description": "Whether to generate the .ico file."
+									},
+									"size": {
+										"type": "integer",
+										"minimum": 1,
+										"default": 64,
+										"description": "Size of the embedded PNG in the .ico file (default: 64)."
+									}
+								}
 							}
-						}
+						]
 					}
 				}
 			}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "better-asset",
-	"version": "0.1.1",
+	"version": "0.1.2",
 	"description": "Config-driven image asset generator. Resize, convert, and generate favicons from a single JSON config.",
 	"type": "module",
 	"bin": {

package/src/config.js

@@ -50,6 +50,29 @@ export async function loadConfig(configPath) {
 		if (!Array.isArray(asset.sizes) || asset.sizes.length === 0) {
 			throw new Error(`Asset "${asset.name}" must have a non-empty "sizes" array.`);
 		}
+
+		if (asset.ico !== undefined) {
+			const isBooleanIco = typeof asset.ico === "boolean";
+			const isObjectIco = typeof asset.ico === "object" && asset.ico !== null && !Array.isArray(asset.ico);
+
+			if (!isBooleanIco && !isObjectIco) {
+				throw new Error(`Asset "${asset.name}" has invalid "ico". Use boolean or object.`);
+			}
+
+			if (isObjectIco && asset.ico.size !== undefined) {
+				if (!Number.isInteger(asset.ico.size) || asset.ico.size < 1) {
+					throw new Error(`Asset "${asset.name}" has invalid "ico.size". Use a positive integer.`);
+				}
+			}
+
+			if (isObjectIco && asset.ico.required === undefined) {
+				throw new Error(`Asset "${asset.name}" must include "ico.required" when "ico" is an object.`);
+			}
+
+			if (isObjectIco && typeof asset.ico.required !== "boolean") {
+				throw new Error(`Asset "${asset.name}" has invalid "ico.required". Use true or false.`);
+			}
+		}
 	}
 
 	return config;
@@ -74,17 +97,13 @@ export function defaultConfig() {
 				source: "favicon.svg",
 				sizes: [16, 32, 48],
 				destination: "public/icons",
-				ico: {
-					required: true,
-					size: 96,
-				},
+				ico: true,
 			},
 			{
 				name: "opengraph-image",
 				source: "icon.svg",
 				sizes: ["1200x630"],
-				destination: "public/icons",
-				format: "jpeg",
+				destination: "public",
 			},
 		],
 	};

package/src/generate.js

@@ -5,6 +5,24 @@ import { parseSize, buildFileName, generateImage, generateIco } from "./image.js
 import { cleanGeneratedFiles } from "./clean.js";
 import * as log from "./log.js";
 
+function resolveIcoConfig(ico) {
+	if (ico === true) {
+		return { enabled: true, size: 64 };
+	}
+
+	if (ico === false || ico == null) {
+		return { enabled: false, size: 64 };
+	}
+
+	if (typeof ico === "object") {
+		const enabled = ico.required === true;
+		const size = typeof ico.size === "number" ? ico.size : 64;
+		return { enabled, size };
+	}
+
+	return { enabled: false, size: 64 };
+}
+
 export async function generate(cwd, configFlag) {
 	const configPath = resolveConfigPath(cwd, configFlag);
 
@@ -43,11 +61,12 @@ export async function generate(cwd, configFlag) {
 			totalFiles++;
 		}
 
-		if (asset.ico?.required) {
+		const ico = resolveIcoConfig(asset.ico);
+		if (ico.enabled) {
 			const icoPath = path.join(destinationDir, "favicon.ico");
-			await generateIco(sourcePath, icoPath, asset.ico.size || 64);
+			await generateIco(sourcePath, icoPath, ico.size);
 
-			log.success("favicon.ico", `${asset.ico.size || 64}×${asset.ico.size || 64}`);
+			log.success("favicon.ico", `${ico.size}×${ico.size}`);
 			totalFiles++;
 		}
 	}