cspell/dist/esm/util/cache/createCache.js

A Spelling Checker for Code!

import assert from 'node:assert';
import { stat } from 'node:fs/promises';
import path from 'node:path';
import { isError } from '../errors.js';
import { DiskCache } from './DiskCache.js';
import { DummyCache } from './DummyCache.js';
// cspell:word cspellcache
export const DEFAULT_CACHE_LOCATION = '.cspellcache';
const versionSuffix = '';
/**
 * Creates CSpellLintResultCache (disk cache if caching is enabled in config or dummy otherwise)
 */
export function createCache(options) {
    const { useCache, cacheLocation, cacheStrategy, reset } = options;
    const location = path.resolve(cacheLocation);
    const useChecksum = cacheStrategy === 'content';
    const version = normalizeVersion(options.version);
    const useUniversal = options.cacheFormat === 'universal';
    const cache = useCache ? new DiskCache(location, useChecksum, version, useUniversal) : new DummyCache();
    reset && cache.reset();
    return cache;
}
export async function calcCacheSettings(config, cacheOptions, root) {
    const cs = config.cache ?? {};
    const useCache = cacheOptions.cache ?? cs.useCache ?? false;
    const cacheLocation = await resolveCacheLocation(path.resolve(root, cacheOptions.cacheLocation ?? cs.cacheLocation ?? DEFAULT_CACHE_LOCATION));
    const cacheStrategy = cacheOptions.cacheStrategy ?? cs.cacheStrategy ?? 'metadata';
    const cacheFormat = cacheOptions.cacheFormat ?? cs.cacheFormat ?? 'universal';
    const optionals = {};
    if (cacheOptions.cacheReset) {
        optionals.reset = true;
    }
    return {
        ...optionals,
        useCache,
        cacheLocation,
        cacheStrategy,
        version: cacheOptions.version,
        cacheFormat,
    };
}
async function resolveCacheLocation(cacheLocation) {
    try {
        const s = await stat(cacheLocation);
        if (s.isFile())
            return cacheLocation;
        return path.join(cacheLocation, DEFAULT_CACHE_LOCATION);
    }
    catch (err) {
        if (isError(err) && err.code === 'ENOENT') {
            return cacheLocation;
        }
        throw err;
    }
}
/**
 * Normalizes the version and return only `major.minor + versionSuffix`
 * @param version The cspell semantic version.
 */
function normalizeVersion(version) {
    const parts = version.split('.').slice(0, 2);
    assert(parts.length === 2);
    return parts.join('.') + versionSuffix;
}
export const __testing__ = {
    normalizeVersion,
    versionSuffix,
};
//# sourceMappingURL=createCache.js.map