vite-plugin-css-vars-to-scss-tokens 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yalla Nkardaz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,97 @@
+# vite-plugin-css-vars-to-scss-tokens
+
+A small Vite plugin that generates SCSS token declarations from CSS custom properties.
+
+The plugin reads a source variables file (default `src/styles/_variables.scss`) and writes a generated SCSS tokens file (default `src/styles/_tokens.scss`). This allows multiple projects to reuse CSS variables as SCSS variables via `var(--name)` declarations.
+
+## Features
+
+- Automatically generates SCSS token declarations from CSS custom properties
+- Avoids unnecessary writes to prevent extra rebuilds
+- Watches the source file in Vite dev server mode
+- Supports custom source and output file paths
+- Written in TypeScript and published as a reusable npm package
+
+## Install
+
+```bash
+npm install --save-dev vite-plugin-css-vars-to-scss-tokens
+```
+
+or with Yarn:
+
+```bash
+yarn add --dev vite-plugin-css-vars-to-scss-tokens
+```
+
+## Usage
+
+Add the plugin to your Vite configuration:
+
+```ts
+import { defineConfig } from 'vite';
+import scssTokensPlugin from 'vite-plugin-css-vars-to-scss-tokens';
+
+export default defineConfig({
+  plugins: [
+    scssTokensPlugin(),
+  ],
+});
+```
+
+### Custom options
+
+The plugin accepts an optional options object:
+
+```ts
+scssTokensPlugin({
+  variablesFile: 'src/styles/_variables.scss',
+  tokensFile: 'src/styles/_tokens.scss',
+  logger: (message) => console.log(message),
+});
+```
+
+Options:
+
+- `variablesFile?: string` — path to the source CSS/SCSS variables file relative to the project root
+- `tokensFile?: string` — path to the generated SCSS tokens file relative to the project root
+- `logger?: (message: string) => void` — optional custom logger callback
+
+## Default behavior
+
+By default, the plugin:
+
+- reads `src/styles/_variables.scss`
+- generates `src/styles/_tokens.scss`
+- parses CSS variables defined as `--name: value;`
+- creates SCSS declarations like `$name: var(--name);`
+- logs updates to the console or the provided logger
+
+## Example source file
+
+```scss
+:root {
+  --color-primary: #1e90ff;
+  --font-size-base: 16px;
+}
+```
+
+Generates:
+
+```scss
+// AUTO-GENERATED — do not edit manually.
+// Source: src/styles/_variables.scss
+
+$color-primary: var(--color-primary);
+$font-size-base: var(--font-size-base);
+```
+
+## Notes
+
+- The plugin is designed for Vite projects and uses the Vite plugin API.
+- It works in both build and dev server modes.
+- Generated files are only written when the content changes.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import type { Plugin } from 'vite';
+export interface ScssTokensPluginOptions {
+    /** Path to the source CSS/SCSS variables file relative to the project root. */
+    variablesFile?: string;
+    /** Path to the generated tokens file relative to the project root. */
+    tokensFile?: string;
+    /** Optional custom logger callback. */
+    logger?: (message: string) => void;
+}
+export default function scssTokensPlugin(options?: ScssTokensPluginOptions): Plugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAkB,MAAM,MAAM,CAAC;AAInD,MAAM,WAAW,uBAAuB;IACtC,+EAA+E;IAC/E,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,sEAAsE;IACtE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uCAAuC;IACvC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;CACpC;AAwFD,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,GAAE,uBAA4B,GAAG,MAAM,CA8BtF"}

package/dist/index.js

@@ -0,0 +1,113 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  default: () => scssTokensPlugin
+});
+module.exports = __toCommonJS(index_exports);
+var import_node_fs = __toESM(require("fs"));
+var import_node_path = __toESM(require("path"));
+var DEFAULT_VARIABLES_FILE = "src/styles/_variables.scss";
+var DEFAULT_TOKENS_FILE = "src/styles/_tokens.scss";
+function parseVariableNames(content) {
+  const regex = /^\s*--([\w-]+)\s*:/gm;
+  const names = [];
+  let match;
+  while ((match = regex.exec(content)) !== null) {
+    names.push(match[1]);
+  }
+  return names;
+}
+function generateTokens(names, sourceFile) {
+  const lines = names.map((name) => `$${name}: var(--${name});`);
+  return [
+    "// AUTO-GENERATED \u2014 do not edit manually.",
+    `// Source: ${sourceFile}`,
+    "",
+    ...lines,
+    ""
+  ].join("\n");
+}
+function resolveFilePath(root, filePath) {
+  return import_node_path.default.resolve(root, filePath);
+}
+function ensureDirectory(filePath) {
+  import_node_fs.default.mkdirSync(import_node_path.default.dirname(filePath), { recursive: true });
+}
+function syncTokens(root, options, log) {
+  const variablesFile = options.variablesFile ?? DEFAULT_VARIABLES_FILE;
+  const tokensFile = options.tokensFile ?? DEFAULT_TOKENS_FILE;
+  const varsPath = resolveFilePath(root, variablesFile);
+  const tokensPath = resolveFilePath(root, tokensFile);
+  if (!import_node_fs.default.existsSync(varsPath)) {
+    log(`[vite-plugin-css-vars-to-scss-tokens] Source not found: ${variablesFile}`);
+    return;
+  }
+  const source = import_node_fs.default.readFileSync(varsPath, "utf-8");
+  const names = parseVariableNames(source);
+  if (names.length === 0) {
+    log("[vite-plugin-css-vars-to-scss-tokens] No CSS variables found \u2014 tokens file not updated.");
+    return;
+  }
+  const tokens = generateTokens(names, variablesFile);
+  const existing = import_node_fs.default.existsSync(tokensPath) ? import_node_fs.default.readFileSync(tokensPath, "utf-8") : "";
+  if (existing === tokens) {
+    return;
+  }
+  ensureDirectory(tokensPath);
+  import_node_fs.default.writeFileSync(tokensPath, tokens, "utf-8");
+  log(`[vite-plugin-css-vars-to-scss-tokens] Updated ${tokensFile} (${names.length} variables)`);
+}
+function scssTokensPlugin(options = {}) {
+  let root = process.cwd();
+  const log = options.logger ?? ((message) => console.log(message));
+  return {
+    name: "vite-plugin-css-vars-to-scss-tokens",
+    /**
+     * Save resolved Vite root for correct file path resolution.
+     */
+    configResolved(config) {
+      root = config.root;
+    },
+    buildStart() {
+      syncTokens(root, options, log);
+    },
+    configureServer(server) {
+      const variablesFile = options.variablesFile ?? DEFAULT_VARIABLES_FILE;
+      const varsAbs = resolveFilePath(root, variablesFile);
+      server.watcher.add(varsAbs);
+      server.watcher.on("change", (file) => {
+        if (import_node_path.default.resolve(file) !== varsAbs) return;
+        syncTokens(root, options, (msg) => server.config.logger.info(msg, { timestamp: true }));
+      });
+    }
+  };
+}

package/dist/index.mjs

@@ -0,0 +1,82 @@
+// src/index.ts
+import fs from "fs";
+import path from "path";
+var DEFAULT_VARIABLES_FILE = "src/styles/_variables.scss";
+var DEFAULT_TOKENS_FILE = "src/styles/_tokens.scss";
+function parseVariableNames(content) {
+  const regex = /^\s*--([\w-]+)\s*:/gm;
+  const names = [];
+  let match;
+  while ((match = regex.exec(content)) !== null) {
+    names.push(match[1]);
+  }
+  return names;
+}
+function generateTokens(names, sourceFile) {
+  const lines = names.map((name) => `$${name}: var(--${name});`);
+  return [
+    "// AUTO-GENERATED \u2014 do not edit manually.",
+    `// Source: ${sourceFile}`,
+    "",
+    ...lines,
+    ""
+  ].join("\n");
+}
+function resolveFilePath(root, filePath) {
+  return path.resolve(root, filePath);
+}
+function ensureDirectory(filePath) {
+  fs.mkdirSync(path.dirname(filePath), { recursive: true });
+}
+function syncTokens(root, options, log) {
+  const variablesFile = options.variablesFile ?? DEFAULT_VARIABLES_FILE;
+  const tokensFile = options.tokensFile ?? DEFAULT_TOKENS_FILE;
+  const varsPath = resolveFilePath(root, variablesFile);
+  const tokensPath = resolveFilePath(root, tokensFile);
+  if (!fs.existsSync(varsPath)) {
+    log(`[vite-plugin-css-vars-to-scss-tokens] Source not found: ${variablesFile}`);
+    return;
+  }
+  const source = fs.readFileSync(varsPath, "utf-8");
+  const names = parseVariableNames(source);
+  if (names.length === 0) {
+    log("[vite-plugin-css-vars-to-scss-tokens] No CSS variables found \u2014 tokens file not updated.");
+    return;
+  }
+  const tokens = generateTokens(names, variablesFile);
+  const existing = fs.existsSync(tokensPath) ? fs.readFileSync(tokensPath, "utf-8") : "";
+  if (existing === tokens) {
+    return;
+  }
+  ensureDirectory(tokensPath);
+  fs.writeFileSync(tokensPath, tokens, "utf-8");
+  log(`[vite-plugin-css-vars-to-scss-tokens] Updated ${tokensFile} (${names.length} variables)`);
+}
+function scssTokensPlugin(options = {}) {
+  let root = process.cwd();
+  const log = options.logger ?? ((message) => console.log(message));
+  return {
+    name: "vite-plugin-css-vars-to-scss-tokens",
+    /**
+     * Save resolved Vite root for correct file path resolution.
+     */
+    configResolved(config) {
+      root = config.root;
+    },
+    buildStart() {
+      syncTokens(root, options, log);
+    },
+    configureServer(server) {
+      const variablesFile = options.variablesFile ?? DEFAULT_VARIABLES_FILE;
+      const varsAbs = resolveFilePath(root, variablesFile);
+      server.watcher.add(varsAbs);
+      server.watcher.on("change", (file) => {
+        if (path.resolve(file) !== varsAbs) return;
+        syncTokens(root, options, (msg) => server.config.logger.info(msg, { timestamp: true }));
+      });
+    }
+  };
+}
+export {
+  scssTokensPlugin as default
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "vite-plugin-css-vars-to-scss-tokens",
+  "version": "1.0.0",
+  "description": "Vite plugin that generates SCSS token variables from CSS custom properties",
+  "license": "MIT",
+  "author": "Yalla Nkardaz",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/DemerNkardaz/vite-plugin-css-vars-to-scss-tokens"
+  },
+  "homepage": "https://github.com/DemerNkardaz/vite-plugin-css-vars-to-scss-tokens#readme",
+  "bugs": {
+    "url": "https://github.com/DemerNkardaz/vite-plugin-css-vars-to-scss-tokens/issues"
+  },
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "vite",
+    "plugin",
+    "scss",
+    "css",
+    "tokens",
+    "css-variables"
+  ],
+  "scripts": {
+    "build": "tsup && tsc --project tsconfig.build.json",
+    "dev": "tsup --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "vite": ">=4.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.9.1",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.14"
+  }
+}