happy-css-modules 3.1.0 → 3.1.1

package/dist/locator/index.d.ts

@@ -0,0 +1,46 @@
+import type { Resolver } from '../resolver/index.js';
+import { type Transformer } from '../transformer/index.js';
+import { type Location } from './postcss.js';
+export { collectNodes, type Location } from './postcss.js';
+/** The exported token. */
+export type Token = {
+    /** The token name. */
+    name: string;
+    /** The name of the imported token. */
+    importedName?: string;
+    /** The original location of the token in the source file. */
+    originalLocation: Location;
+};
+/** The result of `Locator#load`. */
+export type LoadResult = {
+    /** The path of the file imported from the source file with `@import`. */
+    dependencies: string[];
+    /** The tokens exported by the source file. */
+    tokens: Token[];
+};
+export type LocatorOptions = {
+    /** The function to transform source code. */
+    transformer?: Transformer | undefined;
+    /** The function to resolve the path of the imported file. */
+    resolver?: Resolver | undefined;
+};
+/** The resolver that throws an exception if resolving fails. */
+export type StrictlyResolver = (...args: Parameters<Resolver>) => Promise<string>;
+/** This class collects information on tokens exported from CSS Modules files. */
+export declare class Locator {
+    private readonly cache;
+    private readonly transformer;
+    private readonly resolver;
+    private loading;
+    constructor(options?: LocatorOptions);
+    /** Returns `true` if the cache is outdated. */
+    private isCacheOutdated;
+    /**
+     * Reads the source file and returns the code.
+     * If transformer is specified, the code is transformed before returning.
+     */
+    private readCSS;
+    /** Returns information about the tokens exported from the CSS Modules file. */
+    load(filePath: string): Promise<LoadResult>;
+    private _load;
+}

package/dist/locator/index.js

@@ -0,0 +1,173 @@
+import { readFile, stat } from 'fs/promises';
+import postcss from 'postcss';
+import { createDefaultResolver } from '../resolver/index.js';
+import { createDefaultTransformer } from '../transformer/index.js';
+import { unique, uniqueBy } from '../util.js';
+import { getOriginalLocationOfClassSelector, getOriginalLocationOfAtValue, generateLocalTokenNames, parseAtImport, collectNodes, parseAtValue, } from './postcss.js';
+export { collectNodes } from './postcss.js';
+/**
+ * Whether the specifier should be ignored.
+ * For example, specifiers starting with `http://` or `https://` should be ignored.
+ */
+function isIgnoredSpecifier(specifier) {
+    return specifier.startsWith('http://') || specifier.startsWith('https://');
+}
+/** This class collects information on tokens exported from CSS Modules files. */
+export class Locator {
+    constructor(options) {
+        this.cache = new Map();
+        this.loading = false;
+        this.transformer = options?.transformer ?? createDefaultTransformer();
+        this.resolver = async (specifier, resolverOptions) => {
+            const resolver = options?.resolver ?? createDefaultResolver();
+            const resolved = await resolver(specifier, resolverOptions);
+            if (resolved === false)
+                throw new Error(`Could not resolve '${specifier}' in '${resolverOptions.request}'.`);
+            return resolved;
+        };
+    }
+    /** Returns `true` if the cache is outdated. */
+    async isCacheOutdated(filePath) {
+        const entry = this.cache.get(filePath);
+        if (!entry)
+            return true;
+        const mtime = (await stat(filePath)).mtime.getTime();
+        if (entry.mtime !== mtime)
+            return true;
+        const { dependencies } = entry.result;
+        for (const dependency of dependencies) {
+            const entry = this.cache.get(dependency);
+            if (!entry)
+                return true;
+            // eslint-disable-next-line no-await-in-loop
+            const mtime = (await stat(dependency)).mtime.getTime();
+            if (entry.mtime !== mtime)
+                return true;
+        }
+        return false;
+    }
+    /**
+     * Reads the source file and returns the code.
+     * If transformer is specified, the code is transformed before returning.
+     */
+    async readCSS(filePath) {
+        const css = await readFile(filePath, 'utf-8');
+        if (!this.transformer)
+            return { css, map: undefined, dependencies: [] };
+        const result = await this.transformer(css, { from: filePath, resolver: this.resolver, isIgnoredSpecifier });
+        if (result === false)
+            return { css, map: undefined, dependencies: [] };
+        return {
+            css: result.css,
+            map: result.map,
+            dependencies: result.dependencies
+                .map((dep) => {
+                if (typeof dep === 'string')
+                    return dep;
+                if (dep.protocol !== 'file:')
+                    throw new Error(`Unsupported protocol: ${dep.protocol}`);
+                return dep.pathname;
+            })
+                .filter((dep) => {
+                // less makes a remote module inline, so it may be included in dependencies.
+                // However, the dependencies field of happy-css-modules is not yet designed to store http protocol URLs.
+                // Therefore, we exclude them from the dependencies field for now.
+                return !isIgnoredSpecifier(dep);
+            }),
+        };
+    }
+    /** Returns information about the tokens exported from the CSS Modules file. */
+    async load(filePath) {
+        if (this.loading)
+            throw new Error('Cannot call `Locator#load` concurrently.');
+        this.loading = true;
+        const result = await this._load(filePath).finally(() => {
+            this.loading = false;
+        });
+        return result;
+    }
+    async _load(filePath) {
+        if (!(await this.isCacheOutdated(filePath))) {
+            const cacheEntry = this.cache.get(filePath);
+            return cacheEntry.result;
+        }
+        const mtime = (await stat(filePath)).mtime.getTime();
+        const { css, map, dependencies } = await this.readCSS(filePath);
+        const ast = postcss.parse(css, { from: filePath, map: map ? { inline: false, prev: map } : { inline: false } });
+        // Get the local tokens exported by the source file.
+        // The tokens are fetched using `postcss-modules` plugin.
+        const localTokenNames = await generateLocalTokenNames(ast);
+        const tokens = [];
+        const { atImports, atValues, classSelectors } = collectNodes(ast);
+        // Load imported sheets recursively.
+        for (const atImport of atImports) {
+            const importedSheetPath = parseAtImport(atImport);
+            if (!importedSheetPath)
+                continue;
+            if (isIgnoredSpecifier(importedSheetPath))
+                continue;
+            // eslint-disable-next-line no-await-in-loop
+            const from = await this.resolver(importedSheetPath, { request: filePath });
+            // eslint-disable-next-line no-await-in-loop
+            const result = await this._load(from);
+            const externalTokens = result.tokens;
+            dependencies.push(from, ...result.dependencies);
+            tokens.push(...externalTokens);
+        }
+        // Traverse the source file to find a class selector that matches the local token.
+        for (const { rule, classSelector } of classSelectors) {
+            // Consider a class selector to be the origin of a token if it matches a token fetched by postcss-modules.
+            // NOTE: This method has false positives. However, it works as expected in many cases.
+            if (!localTokenNames.includes(classSelector.value))
+                continue;
+            const originalLocation = getOriginalLocationOfClassSelector(rule, classSelector);
+            tokens.push({
+                name: classSelector.value,
+                originalLocation,
+            });
+        }
+        for (const atValue of atValues) {
+            const parsedAtValue = parseAtValue(atValue);
+            if (parsedAtValue.type === 'valueDeclaration') {
+                tokens.push({
+                    name: parsedAtValue.tokenName,
+                    originalLocation: getOriginalLocationOfAtValue(atValue, parsedAtValue),
+                });
+            }
+            else if (parsedAtValue.type === 'valueImportDeclaration') {
+                if (isIgnoredSpecifier(parsedAtValue.from))
+                    continue;
+                // eslint-disable-next-line no-await-in-loop
+                const from = await this.resolver(parsedAtValue.from, { request: filePath });
+                // eslint-disable-next-line no-await-in-loop
+                const result = await this._load(from);
+                dependencies.push(from, ...result.dependencies);
+                for (const token of result.tokens) {
+                    const matchedImport = parsedAtValue.imports.find((i) => i.importedTokenName === token.name);
+                    if (!matchedImport)
+                        continue;
+                    if (matchedImport.localTokenName === matchedImport.importedTokenName) {
+                        tokens.push({
+                            name: matchedImport.localTokenName,
+                            originalLocation: token.originalLocation,
+                        });
+                    }
+                    else {
+                        tokens.push({
+                            name: matchedImport.localTokenName,
+                            importedName: matchedImport.importedTokenName,
+                            originalLocation: token.originalLocation,
+                        });
+                    }
+                }
+            }
+        }
+        const result = {
+            dependencies: unique(dependencies).filter((dep) => dep !== filePath),
+            tokens: uniqueBy(tokens, (token) => JSON.stringify(token)),
+        };
+        this.cache.set(filePath, { mtime, result });
+        return result;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/locator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/locator/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC7D,OAAO,EAAE,wBAAwB,EAAoB,MAAM,yBAAyB,CAAC;AACrF,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EACL,kCAAkC,EAClC,4BAA4B,EAC5B,uBAAuB,EACvB,aAAa,EAEb,YAAY,EACZ,YAAY,GACb,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,YAAY,EAAiB,MAAM,cAAc,CAAC;AAE3D;;;GAGG;AACH,SAAS,kBAAkB,CAAC,SAAiB;IAC3C,OAAO,SAAS,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;AAC7E,CAAC;AAmCD,iFAAiF;AACjF,MAAM,OAAO,OAAO;IAMlB,YAAY,OAAwB;QALnB,UAAK,GAA4B,IAAI,GAAG,EAAE,CAAC;QAGpD,YAAO,GAAG,KAAK,CAAC;QAGtB,IAAI,CAAC,WAAW,GAAG,OAAO,EAAE,WAAW,IAAI,wBAAwB,EAAE,CAAC;QACtE,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,SAAS,EAAE,eAAe,EAAE,EAAE;YACnD,MAAM,QAAQ,GAAG,OAAO,EAAE,QAAQ,IAAI,qBAAqB,EAAE,CAAC;YAC9D,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YAC5D,IAAI,QAAQ,KAAK,KAAK;gBAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,SAAS,SAAS,eAAe,CAAC,OAAO,IAAI,CAAC,CAAC;YAC7G,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC;IACJ,CAAC;IAED,+CAA+C;IACvC,KAAK,CAAC,eAAe,CAAC,QAAgB;QAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QACrD,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK;YAAE,OAAO,IAAI,CAAC;QAEvC,MAAM,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC,MAAM,CAAC;QACtC,KAAK,MAAM,UAAU,IAAI,YAAY,EAAE,CAAC;YACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;YACzC,IAAI,CAAC,KAAK;gBAAE,OAAO,IAAI,CAAC;YACxB,4CAA4C;YAC5C,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YACvD,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK;gBAAE,OAAO,IAAI,CAAC;QACzC,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,OAAO,CACnB,QAAgB;QAKhB,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC,IAAI,CAAC,WAAW;YAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACxE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAC5G,IAAI,MAAM,KAAK,KAAK;YAAE,OAAO,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QACvE,OAAO;YACL,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,YAAY,EAAE,MAAM,CAAC,YAAY;iBAC9B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;gBACX,IAAI,OAAO,GAAG,KAAK,QAAQ;oBAAE,OAAO,GAAG,CAAC;gBACxC,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO;oBAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;gBACvF,OAAO,GAAG,CAAC,QAAQ,CAAC;YACtB,CAAC,CAAC;iBACD,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;gBACd,4EAA4E;gBAC5E,wGAAwG;gBACxG,kEAAkE;gBAClE,OAAO,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC;YAClC,CAAC,CAAC;SACL,CAAC;IACJ,CAAC;IAED,+EAA+E;IAC/E,KAAK,CAAC,IAAI,CAAC,QAAgB;QACzB,IAAI,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9E,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE;YACrD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACvB,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,KAAK,CAAC,KAAK,CAAC,QAAgB;QAClC,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;YAC5C,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;YAC7C,OAAO,UAAU,CAAC,MAAM,CAAC;QAC3B,CAAC;QAED,MAAM,KAAK,GAAG,CAAC,MAAM,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QAErD,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,YAAY,EAAE,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAEhE,MAAM,GAAG,GAAG,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAEhH,oDAAoD;QACpD,yDAAyD;QACzD,MAAM,eAAe,GAAG,MAAM,uBAAuB,CAAC,GAAG,CAAC,CAAC;QAE3D,MAAM,MAAM,GAAY,EAAE,CAAC;QAE3B,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC;QAElE,oCAAoC;QACpC,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,iBAAiB,GAAG,aAAa,CAAC,QAAQ,CAAC,CAAC;YAClD,IAAI,CAAC,iBAAiB;gBAAE,SAAS;YACjC,IAAI,kBAAkB,CAAC,iBAAiB,CAAC;gBAAE,SAAS;YACpD,4CAA4C;YAC5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,iBAAiB,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;YAC3E,4CAA4C;YAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACtC,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC;YACrC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,GAAG,cAAc,CAAC,CAAC;QACjC,CAAC;QAED,kFAAkF;QAClF,KAAK,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,cAAc,EAAE,CAAC;YACrD,0GAA0G;YAC1G,sFAAsF;YACtF,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC;gBAAE,SAAS;YAE7D,MAAM,gBAAgB,GAAG,kCAAkC,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YAEjF,MAAM,CAAC,IAAI,CAAC;gBACV,IAAI,EAAE,aAAa,CAAC,KAAK;gBACzB,gBAAgB;aACjB,CAAC,CAAC;QACL,CAAC;QAED,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC/B,MAAM,aAAa,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;YAE5C,IAAI,aAAa,CAAC,IAAI,KAAK,kBAAkB,EAAE,CAAC;gBAC9C,MAAM,CAAC,IAAI,CAAC;oBACV,IAAI,EAAE,aAAa,CAAC,SAAS;oBAC7B,gBAAgB,EAAE,4BAA4B,CAAC,OAAO,EAAE,aAAa,CAAC;iBACvE,CAAC,CAAC;YACL,CAAC;iBAAM,IAAI,aAAa,CAAC,IAAI,KAAK,wBAAwB,EAAE,CAAC;gBAC3D,IAAI,kBAAkB,CAAC,aAAa,CAAC,IAAI,CAAC;oBAAE,SAAS;gBACrD,4CAA4C;gBAC5C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,QAAQ,EAAE,CAAC,CAAC;gBAC5E,4CAA4C;gBAC5C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBACtC,YAAY,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC;gBAChD,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;oBAClC,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,iBAAiB,KAAK,KAAK,CAAC,IAAI,CAAC,CAAC;oBAC5F,IAAI,CAAC,aAAa;wBAAE,SAAS;oBAC7B,IAAI,aAAa,CAAC,cAAc,KAAK,aAAa,CAAC,iBAAiB,EAAE,CAAC;wBACrE,MAAM,CAAC,IAAI,CAAC;4BACV,IAAI,EAAE,aAAa,CAAC,cAAc;4BAClC,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;yBACzC,CAAC,CAAC;oBACL,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,IAAI,CAAC;4BACV,IAAI,EAAE,aAAa,CAAC,cAAc;4BAClC,YAAY,EAAE,aAAa,CAAC,iBAAiB;4BAC7C,gBAAgB,EAAE,KAAK,CAAC,gBAAgB;yBACzC,CAAC,CAAC;oBACL,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,MAAM,GAAe;YACzB,YAAY,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,QAAQ,CAAC;YACpE,MAAM,EAAE,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;SAC3D,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAC5C,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}

package/dist/locator/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/locator/index.test.js

@@ -0,0 +1,393 @@
+import { readFile, writeFile } from 'fs/promises';
+import { randomUUID } from 'node:crypto';
+import { jest } from '@jest/globals';
+import dedent from 'dedent';
+import { Locator, createDefaultTransformer } from '../index.js';
+import { createFixtures, getFixturePath } from '../test-util/util.js';
+import { sleepSync } from '../util.js';
+const locator = new Locator();
+test('basic', async () => {
+    createFixtures({
+        '/test/1.css': dedent `
+    .a {}
+    .b {}
+    `,
+    });
+    const result = await locator.load(getFixturePath('/test/1.css'));
+    expect(result).toMatchInlineSnapshot(`
+    {
+      dependencies: [],
+      tokens: [
+        {
+          name: "a",
+          originalLocation: {
+            filePath: "<fixtures>/test/1.css",
+            start: { line: 1, column: 1 },
+            end: { line: 1, column: 2 },
+          },
+        },
+        {
+          name: "b",
+          originalLocation: {
+            filePath: "<fixtures>/test/1.css",
+            start: { line: 2, column: 1 },
+            end: { line: 2, column: 2 },
+          },
+        },
+      ],
+    }
+  `);
+});
+test('tracks other files when `@import` is present', async () => {
+    createFixtures({
+        '/test/1.css': dedent `
+    @import './2.css';
+    @import '3.css';
+    @import '${getFixturePath('/test/4.css')}';
+    @import './5.css';
+    `,
+        '/test/2.css': dedent `
+    .a {}
+    `,
+        '/test/3.css': dedent `
+    .b {}
+    `,
+        '/test/4.css': dedent `
+    .c {}
+    `,
+        '/test/5.css': dedent `
+    @import './5-recursive.css';
+    `,
+        '/test/5-recursive.css': dedent `
+    .d {}
+    `,
+    });
+    const result = await locator.load(getFixturePath('/test/1.css'));
+    expect(result).toMatchInlineSnapshot(`
+    {
+      dependencies: [
+        "<fixtures>/test/2.css",
+        "<fixtures>/test/3.css",
+        "<fixtures>/test/4.css",
+        "<fixtures>/test/5.css",
+        "<fixtures>/test/5-recursive.css",
+      ],
+      tokens: [
+        {
+          name: "a",
+          originalLocation: {
+            filePath: "<fixtures>/test/2.css",
+            start: { line: 1, column: 1 },
+            end: { line: 1, column: 2 },
+          },
+        },
+        {
+          name: "b",
+          originalLocation: {
+            filePath: "<fixtures>/test/3.css",
+            start: { line: 1, column: 1 },
+            end: { line: 1, column: 2 },
+          },
+        },
+        {
+          name: "c",
+          originalLocation: {
+            filePath: "<fixtures>/test/4.css",
+            start: { line: 1, column: 1 },
+            end: { line: 1, column: 2 },
+          },
+        },
+        {
+          name: "d",
+          originalLocation: {
+            filePath: "<fixtures>/test/5-recursive.css",
+            start: { line: 1, column: 1 },
+            end: { line: 1, column: 2 },
+          },
+        },
+      ],
+    }
+  `);
+});
+test('does not track other files by `composes`', async () => {
+    createFixtures({
+        '/test/1.css': dedent `
+    .a {
+      composes: b from './2.css';
+      composes: c from './3.css'; /* non-existent file */
+    }
+    `,
+        '/test/2.css': dedent `
+    .b {}
+    `,
+    });
+    const result = await locator.load(getFixturePath('/test/1.css'));
+    expect(result).toMatchInlineSnapshot(`
+    {
+      dependencies: [],
+      tokens: [
+        {
+          name: "a",
+          originalLocation: {
+            filePath: "<fixtures>/test/1.css",
+            start: { line: 1, column: 1 },
+            end: { line: 1, column: 2 },
+          },
+        },
+      ],
+    }
+  `);
+});
+test('tracks other files when `@value` is present', async () => {
+    createFixtures({
+        '/test/1.css': dedent `
+    @value a from './2.css';
+    @value b from '3.css';
+    @value c from '${getFixturePath('/test/4.css')}';
+    `,
+        '/test/2.css': dedent `
+    @value a: 1;
+    `,
+        '/test/3.css': dedent `
+    @value b: 2;
+    `,
+        '/test/4.css': dedent `
+    @value c: 3;
+    `,
+    });
+    const result = await locator.load(getFixturePath('/test/1.css'));
+    expect(result).toMatchInlineSnapshot(`
+    {
+      dependencies: ["<fixtures>/test/2.css", "<fixtures>/test/3.css", "<fixtures>/test/4.css"],
+      tokens: [
+        {
+          name: "a",
+          originalLocation: {
+            filePath: "<fixtures>/test/2.css",
+            start: { line: 1, column: 8 },
+            end: { line: 1, column: 9 },
+          },
+        },
+        {
+          name: "b",
+          originalLocation: {
+            filePath: "<fixtures>/test/3.css",
+            start: { line: 1, column: 8 },
+            end: { line: 1, column: 9 },
+          },
+        },
+        {
+          name: "c",
+          originalLocation: {
+            filePath: "<fixtures>/test/4.css",
+            start: { line: 1, column: 8 },
+            end: { line: 1, column: 9 },
+          },
+        },
+      ],
+    }
+  `);
+});
+test('unique tokens', async () => {
+    createFixtures({
+        '/test/1.css': dedent `
+    /* duplicate import */
+    @import './2.css';
+    @import '2.css';
+    .a {}
+    .a {} /* duplicate class selector */
+    `,
+        '/test/2.css': dedent `
+    .a {} /* class selector that duplicates the import source */
+    .b {}
+    `,
+    });
+    const result = await locator.load(getFixturePath('/test/1.css'));
+    expect(result).toMatchInlineSnapshot(`
+    {
+      dependencies: ["<fixtures>/test/2.css"],
+      tokens: [
+        {
+          name: "a",
+          originalLocation: {
+            filePath: "<fixtures>/test/2.css",
+            start: { line: 1, column: 1 },
+            end: { line: 1, column: 2 },
+          },
+        },
+        {
+          name: "b",
+          originalLocation: {
+            filePath: "<fixtures>/test/2.css",
+            start: { line: 2, column: 1 },
+            end: { line: 2, column: 2 },
+          },
+        },
+        {
+          name: "a",
+          originalLocation: {
+            filePath: "<fixtures>/test/1.css",
+            start: { line: 4, column: 1 },
+            end: { line: 4, column: 2 },
+          },
+        },
+        {
+          name: "a",
+          originalLocation: {
+            filePath: "<fixtures>/test/1.css",
+            start: { line: 5, column: 1 },
+            end: { line: 5, column: 2 },
+          },
+        },
+      ],
+    }
+  `);
+});
+test('returns the result from the cache when the file has not been modified', async () => {
+    createFixtures({
+        '/test/1.css': dedent `
+    @import './2.css';
+    @import './3.css';
+    `,
+        '/test/2.css': dedent `
+    .b {}
+    `,
+        '/test/3.css': dedent `
+    .c {}
+    .d {}
+    `,
+    });
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const readCSSSpy = jest.spyOn(locator, 'readCSS');
+    await locator.load(getFixturePath('/test/1.css'));
+    expect(readCSSSpy).toHaveBeenCalledTimes(3);
+    expect(readCSSSpy).toHaveBeenNthCalledWith(1, getFixturePath('/test/1.css'));
+    expect(readCSSSpy).toHaveBeenNthCalledWith(2, getFixturePath('/test/2.css'));
+    expect(readCSSSpy).toHaveBeenNthCalledWith(3, getFixturePath('/test/3.css'));
+    readCSSSpy.mockClear();
+    // update `/test/2.css`
+    sleepSync(1); // wait for the file system to update the mtime
+    await writeFile(getFixturePath('/test/2.css'), await readFile(getFixturePath('/test/2.css'), 'utf-8'));
+    // `3.css` is not updated, so the cache is used. Therefore, `readFile` is not called.
+    await locator.load(getFixturePath('/test/3.css'));
+    expect(readCSSSpy).toHaveBeenCalledTimes(0);
+    // `1.css` is not updated, but dependencies are updated, so the cache is used. Therefore, `readFile` is called.
+    await locator.load(getFixturePath('/test/1.css'));
+    expect(readCSSSpy).toHaveBeenCalledTimes(2);
+    expect(readCSSSpy).toHaveBeenNthCalledWith(1, getFixturePath('/test/1.css'));
+    expect(readCSSSpy).toHaveBeenNthCalledWith(2, getFixturePath('/test/2.css'));
+    // ``2.css` is updated, but the cache is already available because it was updated in the previous step. Therefore, `readFile` is not called.
+    await locator.load(getFixturePath('/test/2.css'));
+    expect(readCSSSpy).toHaveBeenCalledTimes(2);
+});
+describe('supports sourcemap', () => {
+    test('restores original locations from sourcemap', async () => {
+        const transformer = createDefaultTransformer();
+        const locator = new Locator({ transformer });
+        createFixtures({
+            '/test/1.scss': dedent `
+      .nesting {
+        dummy: '';
+        .nesting_child {
+          dummy: '';
+        }
+      }
+      `,
+        });
+        const result = await locator.load(getFixturePath('/test/1.scss'));
+        expect(result).toMatchInlineSnapshot(`
+      {
+        dependencies: [],
+        tokens: [
+          {
+            name: "nesting",
+            originalLocation: {
+              filePath: "<fixtures>/test/1.scss",
+              start: { line: 1, column: 1 },
+              end: { line: 1, column: 8 },
+            },
+          },
+          {
+            name: "nesting",
+            originalLocation: {
+              filePath: "<fixtures>/test/1.scss",
+              start: { line: 3, column: 3 },
+              end: { line: 3, column: 10 },
+            },
+          },
+          {
+            name: "nesting_child",
+            originalLocation: {
+              filePath: "<fixtures>/test/1.scss",
+              start: { line: 3, column: 3 },
+              end: { line: 3, column: 16 },
+            },
+          },
+        ],
+      }
+    `);
+    });
+    test('treats originalLocation as empty if sourcemap is broken', async () => {
+        const uuid = randomUUID();
+        createFixtures({
+            [`/${uuid}/postcss.config.js`]: dedent `
+      module.exports = {
+        plugins: [],
+      };
+      `,
+            '/test/1.css': dedent `
+      .selector_list_a_1, .selector_list_a_2 {}
+      /* In postcss, including newlines in the selector list breaks the sourcemap. */
+      .selector_list_b_1,
+      .selector_list_b_2 {}
+      `,
+        });
+        const transformer = createDefaultTransformer({ postcssConfig: getFixturePath(`/${uuid}/postcss.config.js`) });
+        const locator = new Locator({ transformer });
+        const result = await locator.load(getFixturePath('/test/1.css'));
+        expect(result).toMatchInlineSnapshot(`
+      {
+        dependencies: [],
+        tokens: [
+          {
+            name: "selector_list_a_1",
+            originalLocation: {
+              filePath: "<fixtures>/test/1.css",
+              start: { line: 1, column: 1 },
+              end: { line: 1, column: 18 },
+            },
+          },
+          {
+            name: "selector_list_a_2",
+            originalLocation: {
+              filePath: "<fixtures>/test/1.css",
+              start: { line: 1, column: 1 },
+              end: { line: 1, column: 18 },
+            },
+          },
+          { name: "selector_list_b_1", originalLocation: {} },
+          { name: "selector_list_b_2", originalLocation: {} },
+        ],
+      }
+    `);
+    });
+});
+test('ignores http(s) protocol file', async () => {
+    createFixtures({
+        '/test/1.css': dedent `
+    @import 'http://example.com/path/http.css';
+    @import 'https://example.com/path/https.css';
+    `,
+    });
+    const result = await locator.load(getFixturePath('/test/1.css'));
+    expect(result.dependencies).toStrictEqual([]);
+});
+test('block concurrent calls to load method', async () => {
+    createFixtures({
+        '/test/1.css': `.a {}`,
+    });
+    await expect(async () => {
+        await Promise.all([locator.load(getFixturePath('/test/1.css')), locator.load(getFixturePath('/test/1.css'))]);
+    }).rejects.toThrowError('Cannot call `Locator#load` concurrently.');
+});
+//# sourceMappingURL=index.test.js.map

package/dist/locator/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../../src/locator/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AACrC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAC;AACtE,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEvC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,IAAI,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;IACvB,cAAc,CAAC;QACb,aAAa,EAAE,MAAM,CAAA;;;KAGpB;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;GAsBpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,8CAA8C,EAAE,KAAK,IAAI,EAAE;IAC9D,cAAc,CAAC;QACb,aAAa,EAAE,MAAM,CAAA;;;eAGV,cAAc,CAAC,aAAa,CAAC;;KAEvC;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;QACD,uBAAuB,EAAE,MAAM,CAAA;;KAE9B;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;IAC1D,cAAc,CAAC;QACb,aAAa,EAAE,MAAM,CAAA;;;;;KAKpB;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;GAcpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;IAC7D,cAAc,CAAC;QACb,aAAa,EAAE,MAAM,CAAA;;;qBAGJ,cAAc,CAAC,aAAa,CAAC;KAC7C;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,eAAe,EAAE,KAAK,IAAI,EAAE;IAC/B,cAAc,CAAC;QACb,aAAa,EAAE,MAAM,CAAA;;;;;;KAMpB;QACD,aAAa,EAAE,MAAM,CAAA;;;KAGpB;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCpC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;IACvF,cAAc,CAAC;QACb,aAAa,EAAE,MAAM,CAAA;;;KAGpB;QACD,aAAa,EAAE,MAAM,CAAA;;KAEpB;QACD,aAAa,EAAE,MAAM,CAAA;;;KAGpB;KACF,CAAC,CAAC;IACH,8DAA8D;IAC9D,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,SAAgB,CAAC,CAAC;IACzD,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAClD,MAAM,CAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7E,MAAM,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7E,MAAM,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7E,UAAU,CAAC,SAAS,EAAE,CAAC;IAEvB,uBAAuB;IACvB,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,+CAA+C;IAC7D,MAAM,SAAS,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,MAAM,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC;IAEvG,qFAAqF;IACrF,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAClD,MAAM,CAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAE5C,+GAA+G;IAC/G,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAClD,MAAM,CAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAC5C,MAAM,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7E,MAAM,CAAC,UAAU,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAE7E,4IAA4I;IAC5I,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IAClD,MAAM,CAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAI,CAAC,4CAA4C,EAAE,KAAK,IAAI,EAAE;QAC5D,MAAM,WAAW,GAAG,wBAAwB,EAAE,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7C,cAAc,CAAC;YACb,cAAc,EAAE,MAAM,CAAA;;;;;;;OAOrB;SACF,CAAC,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAAC;QAClE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KA8BpC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,yDAAyD,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,IAAI,GAAG,UAAU,EAAE,CAAC;QAC1B,cAAc,CAAC;YACb,CAAC,IAAI,IAAI,oBAAoB,CAAC,EAAE,MAAM,CAAA;;;;OAIrC;YACD,aAAa,EAAE,MAAM,CAAA;;;;;OAKpB;SACF,CAAC,CAAC;QACH,MAAM,WAAW,GAAG,wBAAwB,CAAC,EAAE,aAAa,EAAE,cAAc,CAAC,IAAI,IAAI,oBAAoB,CAAC,EAAE,CAAC,CAAC;QAC9G,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC7C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;QACjE,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;KAwBpC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;IAC/C,cAAc,CAAC;QACb,aAAa,EAAE,MAAM,CAAA;;;KAGpB;KACF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC;IACjE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AAChD,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;IACvD,cAAc,CAAC;QACb,aAAa,EAAE,OAAO;KACvB,CAAC,CAAC;IACH,MAAM,MAAM,CAAC,KAAK,IAAI,EAAE;QACtB,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;IAChH,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,0CAA0C,CAAC,CAAC;AACtE,CAAC,CAAC,CAAC"}