@moritzloewenstein/vite-plugin-sass-glob-import 5.0.0 → 5.0.2

package/README.md

@@ -12,14 +12,14 @@ Fork of [vite-plugin-sass-glob-import](https://github.com/cmalven/vite-plugin-sa
 ## Install
 
 ```shell
-npm i -D vite-plugin-sass-glob-import
+npm i -D @moritzloewenstein/vite-plugin-sass-glob-import
 ```
 
 ```js
 // In vite.config.js
 
 import { defineConfig } from "vite";
-import sassGlobImports from "vite-plugin-sass-glob-import";
+import sassGlobImports from "@moritzloewenstein/vite-plugin-sass-glob-import";
 
 export default defineConfig({
   plugins: [sassGlobImports()],

package/dist/index.d.mts

@@ -0,0 +1,10 @@
+import { Plugin } from 'vite';
+
+interface PluginOptions {
+    ignorePaths?: string[];
+    autoInvalidation?: boolean;
+}
+
+declare function sassGlobImports(_options?: PluginOptions): Plugin;
+
+export { sassGlobImports as default };

package/dist/index.mjs

@@ -0,0 +1,160 @@
+// src/index.ts
+import fs from "fs";
+import path from "path";
+import c from "ansi-colors";
+import { globSync } from "glob";
+import { minimatch } from "minimatch";
+import {
+  normalizePath
+} from "vite";
+var IMPORT_REGEX;
+var options;
+var globToModuleIds;
+var projectRoot;
+var server;
+function sassGlobImports(_options = {}) {
+  IMPORT_REGEX = /^([ \t]*(?:\/\*.*)?)@(import|use)\s+["']([^"']+\*[^"']*(?:\.scss|\.sass)?)["'];?([ \t]*(?:\/[/*].*)?)$/gm;
+  options = _options;
+  globToModuleIds = /* @__PURE__ */ new Map();
+  return {
+    name: "sass-glob-import",
+    enforce: "pre",
+    configResolved(config) {
+      projectRoot = normalizePath(config.root);
+      if (options.autoInvalidation && !config.server.watch) {
+        config.logger.warn(
+          "vite-plugin-sass-glob-import: set server.watch: true for automatic glob module invalidation"
+        );
+      }
+    },
+    configureServer(_server) {
+      if (!options.autoInvalidation) {
+        return;
+      }
+      server = _server;
+      server.watcher.on("all", async (_event, pathName) => {
+        if (!path.extname(pathName).match(/\.sass|\.scss/i)) {
+          return;
+        }
+        const relPathName = path.relative(projectRoot, pathName);
+        const modsToInvalidate = /* @__PURE__ */ new Set();
+        for (const [glob, modSet] of globToModuleIds) {
+          if (minimatch(relPathName, glob)) {
+            for (const mod of modSet) {
+              modsToInvalidate.add(mod);
+            }
+          }
+        }
+        const modsByFile = /* @__PURE__ */ new Set();
+        for (const mod of modsToInvalidate) {
+          const modules = server.moduleGraph.getModulesByFile(mod);
+          if (!modules) continue;
+          for (const m of modules) {
+            modsByFile.add(m);
+          }
+        }
+        invalidateModules(server, modsByFile, Date.now());
+        await Promise.all(
+          Array.from(modsByFile).map((mod) => server.reloadModule(mod))
+        );
+      });
+    },
+    transform(src, id) {
+      return {
+        code: transform(src, id),
+        map: null
+        // provide source map if available
+      };
+    }
+  };
+}
+function invalidateModules(server2, modules, timestamp) {
+  const seen = /* @__PURE__ */ new Set();
+  for (const mod of modules) {
+    server2.moduleGraph.invalidateModule(mod, seen, timestamp, true);
+  }
+  return modules;
+}
+function isSassOrScss(filename) {
+  return !fs.statSync(filename).isDirectory() && path.extname(filename).match(/\.sass|\.scss/i);
+}
+function transform(src, id) {
+  const fileName = path.basename(id);
+  const filePath = path.dirname(id);
+  const isSass = path.extname(fileName).match(/\.sass/i);
+  const searchBases = [filePath];
+  const ignorePaths = options.ignorePaths || [];
+  const contentLinesCount = src.split("\n").length;
+  for (let i = 0; i < contentLinesCount; i++) {
+    const result = [...src.matchAll(IMPORT_REGEX)];
+    if (result.length === 0) continue;
+    const [importRule, startComment, importType, globPattern, endComment] = result[0];
+    if (options.autoInvalidation) {
+      const projectGlob = path.relative(
+        projectRoot,
+        path.resolve(path.join(filePath, globPattern))
+      );
+      const hasGlob = globToModuleIds.has(projectGlob);
+      if (!globToModuleIds.get(projectGlob)?.has(id)) {
+        const modSet = globToModuleIds.get(projectGlob) ?? /* @__PURE__ */ new Set();
+        modSet.add(id);
+        globToModuleIds.set(projectGlob, modSet);
+        if (!hasGlob) {
+          const globDir = projectGlob.split("*")[0];
+          server.watcher.add(globDir);
+        }
+      }
+    }
+    let files = [];
+    let basePath = "";
+    for (let i2 = 0; i2 < searchBases.length; i2++) {
+      basePath = searchBases[i2];
+      files = globSync(path.join(basePath, globPattern), {
+        cwd: "./",
+        windowsPathsNoEscape: true
+      }).sort((a, b) => a.localeCompare(b, "en"));
+      const globPatternWithoutWildcard = globPattern.split("*")[0];
+      if (globPatternWithoutWildcard.length) {
+        const directoryExists = fs.existsSync(
+          path.join(basePath, globPatternWithoutWildcard)
+        );
+        if (!directoryExists) {
+          console.warn(
+            c.yellow(
+              `Sass Glob Import: Directories don't exist for the glob pattern "${globPattern}"`
+            )
+          );
+        }
+      }
+      if (files.length > 0) {
+        break;
+      }
+    }
+    const isGlobTrailStatic = !globPattern.split("/").at(-1)?.includes("*");
+    const imports = [];
+    files.forEach((anyFilename, index) => {
+      if (!isSassOrScss(anyFilename)) {
+        return;
+      }
+      const scssFilename = path.relative(basePath, anyFilename).replace(/\\/g, "/").replace(/^\//, "");
+      if (!ignorePaths.some((ignorePath) => {
+        return minimatch(scssFilename, ignorePath);
+      })) {
+        const file = isGlobTrailStatic ? `"${scssFilename}" as ${path.parse(scssFilename).name}_${index}` : `"${scssFilename}"`;
+        imports.push(`@${importType} ${file}${isSass ? "" : ";"}`);
+      }
+    });
+    if (startComment) {
+      imports.unshift(startComment);
+    }
+    if (endComment) {
+      imports.push(endComment);
+    }
+    const replaceString = imports.join("\n");
+    src = src.replace(importRule, replaceString);
+  }
+  return src;
+}
+export {
+  sassGlobImports as default
+};

package/package.json

@@ -1,9 +1,12 @@
 {
 	"name": "@moritzloewenstein/vite-plugin-sass-glob-import",
-	"version": "5.0.0",
+	"version": "5.0.2",
 	"description": "Use glob syntax for imports in your main Sass or SCSS file.",
 	"main": "./dist/index.mjs",
 	"types": "./dist/index.d.mts",
+	"files": [
+		"dist"
+	],
 	"scripts": {
 		"dev": "vitest",
 		"build": "tsup src/index.ts --format esm --dts",

package/.github/workflows/lint-test.yml

@@ -1,34 +0,0 @@
-name: Lint and Test
-
-on:
-  push:
-    branches: [ main ]
-  pull_request:
-    branches: [ main ]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v5
-
-      - uses: actions/setup-node@v5
-        with:
-          node-version: 22.x
-          cache: 'npm'
-
-      - uses: actions/cache@v4
-        with:
-          path: ~/.npm
-          key: npm-${{ hashFiles('package-lock.json') }}
-          restore-keys: npm-
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run Biome
-        run: npm run biome:ci
-
-      - name: Run tests
-        run: npm run test

package/.github/workflows/publish.yml

@@ -1,38 +0,0 @@
-name: Publish
-
-on:
-  workflow_run:
-    workflows: ["Lint and Test"]
-    branches: [main]
-    types:
-      - completed
-
-permissions:
-  id-token: write
-  contents: read
-
-jobs:
-  publish:
-    if: ${{ github.event.workflow_run.conclusion == 'success' }}
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v5
-    - uses: actions/setup-node@v5
-      with:
-        node-version: '22.x'
-        registry-url: 'https://registry.npmjs.org'
-    - uses: actions/cache@v4
-      with:
-        path: ~/.npm
-        key: npm-${{ hashFiles('package-lock.json') }}
-        restore-keys: npm-
-    - name: Install deps and build
-      run: |
-        set -e
-        npm ci
-        npm run build
-    - name: Publish to npm
-      run: npm publish --tag latest --access public --provenance
-      env:
-        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.nvmrc

@@ -1 +0,0 @@
-20

package/biome.json

@@ -1,54 +0,0 @@
-{
-	"$schema": "node_modules/@biomejs/biome/configuration_schema.json",
-	"assist": { "actions": { "source": { "organizeImports": "on" } } },
-	"files": {
-		"ignoreUnknown": true,
-		"includes": ["**", "!dist"]
-	},
-	"vcs": {
-		"enabled": true,
-		"clientKind": "git",
-		"defaultBranch": "main",
-		"useIgnoreFile": true
-	},
-	"linter": {
-		"enabled": true,
-		"rules": {
-			"recommended": true,
-			"complexity": {
-				"noForEach": "off"
-			},
-			"style": {
-				"noParameterAssign": "error",
-				"useAsConstAssertion": "error",
-				"useDefaultParameterLast": "error",
-				"useEnumInitializers": "error",
-				"useSelfClosingElements": "error",
-				"useSingleVarDeclarator": "error",
-				"noUnusedTemplateLiteral": "error",
-				"useNumberNamespace": "error",
-				"noInferrableTypes": "error",
-				"noUselessElse": "error"
-			}
-		}
-	},
-	"formatter": {
-		"enabled": true
-	},
-	"css": {
-		"formatter": {
-			"enabled": false
-		},
-		"linter": {
-			"enabled": false
-		}
-	},
-	"graphql": {
-		"formatter": {
-			"enabled": false
-		},
-		"linter": {
-			"enabled": false
-		}
-	}
-}

package/src/index.ts

@@ -1,122 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import c from "ansi-colors";
-import { globSync } from "glob";
-import { minimatch } from "minimatch";
-import type { Plugin } from "vite";
-import type { PluginOptions, TransformResult } from "./types";
-
-let IMPORT_REGEX: RegExp;
-let options: PluginOptions;
-export default function sassGlobImports(_options: PluginOptions = {}): Plugin {
-	IMPORT_REGEX =
-		/^([ \t]*(?:\/\*.*)?)@(import|use)\s+["']([^"']+\*[^"']*(?:\.scss|\.sass)?)["'];?([ \t]*(?:\/[/*].*)?)$/gm;
-	options = _options;
-	return {
-		name: "sass-glob-import",
-		enforce: "pre",
-		transform(src: string, id: string): TransformResult {
-			const fileName = path.basename(id);
-			const filePath = path.dirname(id);
-			return {
-				code: transform(src, fileName, filePath),
-				map: null, // provide source map if available
-			};
-		},
-	};
-}
-
-function isSassOrScss(filename: string) {
-	return (
-		!fs.statSync(filename).isDirectory() &&
-		path.extname(filename).match(/\.sass|\.scss/i)
-	);
-}
-
-function transform(src: string, fileName: string, filePath: string): string {
-	// Determine if this is Sass (vs SCSS) based on file extension
-	const isSass = path.extname(fileName).match(/\.sass/i);
-
-	// Store base locations
-	const searchBases = [filePath];
-	const ignorePaths = options.ignorePaths || [];
-	const contentLinesCount = src.split("\n").length;
-
-	for (let i = 0; i < contentLinesCount; i++) {
-		const result = [...src.matchAll(IMPORT_REGEX)];
-		if (result.length === 0) continue;
-
-		const [importRule, startComment, importType, globPattern, endComment] =
-			result[0];
-
-		let files: string[] = [];
-		let basePath = "";
-		for (let i = 0; i < searchBases.length; i++) {
-			basePath = searchBases[i];
-
-			files = globSync(path.join(basePath, globPattern), {
-				cwd: "./",
-				windowsPathsNoEscape: true,
-			}).sort((a, b) => a.localeCompare(b, "en"));
-
-			// Do directories exist matching the glob pattern?
-			const globPatternWithoutWildcard = globPattern.split("*")[0];
-			if (globPatternWithoutWildcard.length) {
-				const directoryExists = fs.existsSync(
-					path.join(basePath, globPatternWithoutWildcard),
-				);
-				if (!directoryExists) {
-					console.warn(
-						c.yellow(
-							`Sass Glob Import: Directories don't exist for the glob pattern "${globPattern}"`,
-						),
-					);
-				}
-			}
-
-			if (files.length > 0) {
-				break;
-			}
-		}
-
-		const isGlobTrailStatic = !globPattern.split("/").at(-1)?.includes("*");
-		const imports = [];
-		files.forEach((anyFilename: string, index: number) => {
-			if (!isSassOrScss(anyFilename)) {
-				return;
-			}
-
-			const scssFilename = path
-				// Remove parent base path
-				.relative(basePath, anyFilename)
-				.replace(/\\/g, "/")
-				// Remove leading slash
-				.replace(/^\//, "");
-			if (
-				!ignorePaths.some((ignorePath: string) => {
-					return minimatch(scssFilename, ignorePath);
-				})
-			) {
-				const file = isGlobTrailStatic
-					? `"${scssFilename}" as ${path.parse(scssFilename).name}_${index}`
-					: `"${scssFilename}"`;
-				imports.push(`@${importType} ${file}${isSass ? "" : ";"}`);
-			}
-		});
-
-		if (startComment) {
-			imports.unshift(startComment);
-		}
-
-		if (endComment) {
-			imports.push(endComment);
-		}
-
-		const replaceString = imports.join("\n");
-		// biome-ignore lint: easier for now
-		src = src.replace(importRule, replaceString);
-	}
-
-	// Return the transformed source
-	return src;
-}

package/src/types.ts

@@ -1,8 +0,0 @@
-export interface PluginOptions {
-	ignorePaths?: string[];
-}
-
-export interface TransformResult {
-	code: string;
-	map: null;
-}

package/test/basic.test.ts

@@ -1,107 +0,0 @@
-import { describe, expect, it, vi } from "vitest";
-import sassGlobImportPlugin from "../src";
-
-const source = `
-body {}
-@import "files/*.scss";
-`;
-
-describe("it correctly converts glob patterns to inline imports", () => {
-	// biome-ignore lint: TODO
-	const plugin: any = sassGlobImportPlugin();
-
-	it("for SCSS", () => {
-		const expected = `
-body {}
-@import "files/_file-a.scss";
-@import "files/_file-b.scss";
-`;
-		const path = `${__dirname}/virtual-file.scss`;
-		expect(plugin.transform(source, path)?.code).toEqual(expected);
-	});
-
-	it("for Sass", () => {
-		const expected = `
-body {}
-@import "files/_file-a.scss"
-@import "files/_file-b.scss"
-`;
-		const path = `${__dirname}/virtual-file.sass`;
-		expect(plugin.transform(source, path)?.code).toEqual(expected);
-	});
-
-	it("with @use", () => {
-		const source = `
-body {}
-@use "files/*.scss";
-`;
-		const expected = `
-body {}
-@use "files/_file-a.scss";
-@use "files/_file-b.scss";
-`;
-		const path = `${__dirname}/virtual-file.scss`;
-		expect(plugin.transform(source, path)?.code).toEqual(expected);
-	});
-});
-
-describe("it warns for invalid glob paths", () => {
-	// biome-ignore lint: TODO
-	const plugin: any = sassGlobImportPlugin();
-
-	it("for SCSS", () => {
-		const source = `
-body {}
-@use "foo/**/*.scss";
-`;
-		const expected = `
-body {}
-
-`;
-		const path = `${__dirname}/virtual-file.scss`;
-		vi.spyOn(console, "warn");
-		expect(plugin.transform(source, path)?.code).toEqual(expected);
-		expect(console.warn).toHaveBeenCalledTimes(1);
-	});
-});
-
-describe("it correctly converts glob patterns with static trail to namespace imports", () => {
-	// biome-ignore lint: TODO
-	const plugin: any = sassGlobImportPlugin();
-
-	it.todo("for SCSS", () => {
-		//TODO does this even work?
-		const expected = `
-body {}
-@import "files/a/foo.scss";
-@import "files/b/foo.scss";
-`;
-		const path = `${__dirname}/virtual-file.scss`;
-		expect(plugin.transform(source, path)?.code).toEqual(expected);
-	});
-
-	it.todo("for Sass", () => {
-		//TODO does this even work?
-		const expected = `
-body {}
-@import "files/a/foo.scss"
-@import "files/b/foo.scss"
-`;
-		const path = `${__dirname}/virtual-file.sass`;
-		expect(plugin.transform(source, path)?.code).toEqual(expected);
-	});
-
-	it("with @use", () => {
-		const source = `
-body {}
-@use "files/*/foo.scss";
-`;
-		const expected = `
-body {}
-@use "files/a/foo.scss" as foo_0;
-@use "files/b/foo.scss" as foo_1;
-`;
-		const path = `${__dirname}/virtual-file.scss`;
-		expect(plugin.transform(source, path)?.code).toEqual(expected);
-	});
-});

package/tsconfig.json

@@ -1,12 +0,0 @@
-{
-	"compilerOptions": {
-		"target": "ESNext",
-		"module": "ESNext",
-		"lib": ["ESNext", "DOM"],
-		"moduleResolution": "Node",
-		"allowSyntheticDefaultImports": true,
-		"strict": true,
-		"sourceMap": true
-	},
-	"include": ["./src"]
-}