svg-vectordrawable 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,65 @@
+import { Config } from 'svgo';
+
+/** A non-fatal issue encountered during conversion. */
+interface Warning {
+    /** Stable machine-readable code, e.g. `unsupported-element`. */
+    code: string;
+    /** Human-readable explanation. */
+    message: string;
+    /** SVG element/attribute the warning relates to, when known. */
+    node?: string;
+}
+interface ConvertOptions {
+    /**
+     * Run svgo normalization first (inline styles, shapes→paths, bake transforms…).
+     * Strongly recommended; it is what makes conversion robust across SVG sources.
+     * @default true
+     */
+    optimize?: boolean;
+    /** Override the svgo config used for normalization (only when `optimize` is true). */
+    svgoConfig?: Config;
+    /** Decimal places kept for generated numbers (coordinates, radii). @default 3 */
+    floatPrecision?: number;
+    /** Concrete color substituted for `currentColor`. @default '#000000' */
+    currentColor?: string;
+    /**
+     * SVG paints unfilled shapes black by default. When true, paths without an
+     * explicit fill get `android:fillColor="#FF000000"`. @default true
+     */
+    fillBlackForUnfilled?: boolean;
+    /** Throw on the first unsupported construct instead of warning. @default false */
+    strict?: boolean;
+    /** Indentation width (spaces). @default 4 */
+    indent?: number;
+    /** Prepend an XML declaration (`<?xml version="1.0" encoding="utf-8"?>`). @default false */
+    xmlTag?: boolean;
+    /** Add `android:tint` to the `<vector>`. Android color literal (e.g. `#AARRGGBB`), passed verbatim. */
+    tint?: string;
+    /** Called for every warning as it happens (in addition to the returned list). */
+    onWarn?: (warning: Warning) => void;
+}
+interface ConvertResult {
+    /** The generated Android VectorDrawable XML. */
+    xml: string;
+    /** All non-fatal issues encountered. */
+    warnings: Warning[];
+}
+/** An RGBA color expressed as Android `#AARRGGBB`. */
+type AndroidColor = `#${string}`;
+
+declare function convert(svg: string, options?: ConvertOptions): ConvertResult;
+
+/**
+ * Converts a single SVG file to a VectorDrawable XML file.
+ * Defaults the output path to the input with a `.xml` extension. (Node only.)
+ */
+declare function convertFile(inputPath: string, outputPath?: string, options?: ConvertOptions): ConvertResult;
+interface ConvertDirResult {
+    input: string;
+    output: string;
+    warnings: Warning[];
+}
+/** Converts every `*.svg` in a directory to `*.xml` in `outputDir`. (Node only, non-recursive.) */
+declare function convertDir(inputDir: string, outputDir: string, options?: ConvertOptions): ConvertDirResult[];
+
+export { type AndroidColor, type ConvertDirResult, type ConvertOptions, type ConvertResult, type Warning, convert, convertDir, convertFile };

package/dist/index.d.ts

@@ -0,0 +1,65 @@
+import { Config } from 'svgo';
+
+/** A non-fatal issue encountered during conversion. */
+interface Warning {
+    /** Stable machine-readable code, e.g. `unsupported-element`. */
+    code: string;
+    /** Human-readable explanation. */
+    message: string;
+    /** SVG element/attribute the warning relates to, when known. */
+    node?: string;
+}
+interface ConvertOptions {
+    /**
+     * Run svgo normalization first (inline styles, shapes→paths, bake transforms…).
+     * Strongly recommended; it is what makes conversion robust across SVG sources.
+     * @default true
+     */
+    optimize?: boolean;
+    /** Override the svgo config used for normalization (only when `optimize` is true). */
+    svgoConfig?: Config;
+    /** Decimal places kept for generated numbers (coordinates, radii). @default 3 */
+    floatPrecision?: number;
+    /** Concrete color substituted for `currentColor`. @default '#000000' */
+    currentColor?: string;
+    /**
+     * SVG paints unfilled shapes black by default. When true, paths without an
+     * explicit fill get `android:fillColor="#FF000000"`. @default true
+     */
+    fillBlackForUnfilled?: boolean;
+    /** Throw on the first unsupported construct instead of warning. @default false */
+    strict?: boolean;
+    /** Indentation width (spaces). @default 4 */
+    indent?: number;
+    /** Prepend an XML declaration (`<?xml version="1.0" encoding="utf-8"?>`). @default false */
+    xmlTag?: boolean;
+    /** Add `android:tint` to the `<vector>`. Android color literal (e.g. `#AARRGGBB`), passed verbatim. */
+    tint?: string;
+    /** Called for every warning as it happens (in addition to the returned list). */
+    onWarn?: (warning: Warning) => void;
+}
+interface ConvertResult {
+    /** The generated Android VectorDrawable XML. */
+    xml: string;
+    /** All non-fatal issues encountered. */
+    warnings: Warning[];
+}
+/** An RGBA color expressed as Android `#AARRGGBB`. */
+type AndroidColor = `#${string}`;
+
+declare function convert(svg: string, options?: ConvertOptions): ConvertResult;
+
+/**
+ * Converts a single SVG file to a VectorDrawable XML file.
+ * Defaults the output path to the input with a `.xml` extension. (Node only.)
+ */
+declare function convertFile(inputPath: string, outputPath?: string, options?: ConvertOptions): ConvertResult;
+interface ConvertDirResult {
+    input: string;
+    output: string;
+    warnings: Warning[];
+}
+/** Converts every `*.svg` in a directory to `*.xml` in `outputDir`. (Node only, non-recursive.) */
+declare function convertDir(inputDir: string, outputDir: string, options?: ConvertOptions): ConvertDirResult[];
+
+export { type AndroidColor, type ConvertDirResult, type ConvertOptions, type ConvertResult, type Warning, convert, convertDir, convertFile };

package/dist/index.js

@@ -0,0 +1,32 @@
+import {
+  convert
+} from "./chunk-QG2B6V6V.js";
+
+// src/file.ts
+import { readFileSync, writeFileSync, readdirSync, statSync, mkdirSync } from "fs";
+import { join, extname, basename, dirname } from "path";
+function convertFile(inputPath, outputPath, options) {
+  const result = convert(readFileSync(inputPath, "utf8"), options);
+  const target = outputPath ?? join(dirname(inputPath), `${basename(inputPath, extname(inputPath))}.xml`);
+  mkdirSync(dirname(target), { recursive: true });
+  writeFileSync(target, result.xml);
+  return result;
+}
+function convertDir(inputDir, outputDir, options) {
+  mkdirSync(outputDir, { recursive: true });
+  const out = [];
+  for (const entry of readdirSync(inputDir)) {
+    const p = join(inputDir, entry);
+    if (statSync(p).isFile() && extname(entry).toLowerCase() === ".svg") {
+      const target = join(outputDir, `${basename(entry, ".svg")}.xml`);
+      const { warnings } = convertFile(p, target, options);
+      out.push({ input: p, output: target, warnings });
+    }
+  }
+  return out;
+}
+export {
+  convert,
+  convertDir,
+  convertFile
+};

package/package.json

@@ -0,0 +1,68 @@
+{
+    "name": "svg-vectordrawable",
+    "version": "0.1.0",
+    "description": "Convert SVG to Android VectorDrawable XML. AST-based (via svgo), with gradients (incl. gradientTransform), clip-path, groups and full CSS color support. Fails loud on constructs a VectorDrawable cannot represent.",
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js",
+            "require": "./dist/index.cjs"
+        },
+        "./browser": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/browser.js"
+        }
+    },
+    "bin": {
+        "svgvd": "./dist/cli.js"
+    },
+    "files": [
+        "dist"
+    ],
+    "sideEffects": false,
+    "scripts": {
+        "build": "tsup",
+        "test": "vitest run",
+        "test:watch": "vitest",
+        "test:coverage": "vitest run --coverage",
+        "typecheck": "tsc --noEmit",
+        "lint": "eslint .",
+        "lint:fix": "eslint . --fix",
+        "format": "prettier --write .",
+        "format:check": "prettier --check .",
+        "validate:aapt2": "node scripts/aapt2-validate.mjs",
+        "prepublishOnly": "npm run build",
+        "release": "npm publish --provenance --access public"
+    },
+    "keywords": [
+        "svg",
+        "android",
+        "vectordrawable",
+        "vector-drawable",
+        "gradient",
+        "gradientTransform",
+        "figma",
+        "converter",
+        "svgo"
+    ],
+    "license": "MIT",
+    "engines": {
+        "node": ">=18"
+    },
+    "dependencies": {
+        "svgo": "^4.0.1"
+    },
+    "devDependencies": {
+        "@eslint/js": "^9.0.0",
+        "@types/node": "^20.14.0",
+        "@vitest/coverage-v8": "^2.1.0",
+        "eslint": "^9.0.0",
+        "globals": "^14.0.0",
+        "prettier": "^3.0.0",
+        "tsup": "^8.3.0",
+        "typescript": "^5.6.0",
+        "typescript-eslint": "^8.0.0",
+        "vitest": "^2.1.0"
+    }
+}