Fix cache configuration property not being respected (#8599)

Author: ybiquitous

.changeset/loose-taxis-occur.md

@@ -0,0 +1,5 @@
+---
+"stylelint": patch
+---
+
+Fixed: `cache` configuration property not being respected

lib/__tests__/cli.test.mjs

@@ -32,25 +32,10 @@ jest.unstable_mockModule('stylelint-test-custom-formatter', () => ({ default: cu
 describe('buildCLI', () => {
 it('flags - default', () => {
 expect(buildCLI([]).flags).toEqual({
-allowEmptyInput: false,
-cache: false,
-color: false,
 computeEditInfo: false,
-disableDefaultIgnores: false,
-help: false,
-ignoreDisables: false,
 ignorePath: [],
 ignorePattern: [],
-printConfig: false,
-quiet: false,
-quietDeprecationWarnings: false,
-reportDescriptionlessDisables: false,
-reportInvalidScopeDisables: false,
-reportNeedlessDisables: false,
-reportUnscopedDisables: false,
-stdin: false,
 validate: true,
-version: false,
 });
 });
 
@@ -61,6 +46,7 @@ describe('buildCLI', () => {
 
 it('flags.cache', () => {
 expect(buildCLI(['--cache']).flags.cache).toBe(true);
+expect(buildCLI(['--no-cache']).flags.cache).toBe(false);
 });
 
 it('flags.cacheLocation', () => {

lib/__tests__/standalone-cache.test.mjs

@@ -347,14 +347,14 @@ describe('standalone cache uses a config file', () => {
 
 const configFile = path.join(cwd, '.stylelintrc.json');
 const lintedFile = path.join(cwd, 'a.css');
+const expectedCacheFilePath = path.join(cwd, '.stylelintcache');
 
 beforeEach(async () => {
 await writeFile(lintedFile, 'a {}');
 });
 
 afterEach(async () => {
-await rm(configFile, { force: true });
-await rm(lintedFile, { force: true });
+await rm(cwd, { recursive: true, force: true });
 });
 
 it('cache is discarded when a config file is changed', async () => {
@@ -382,6 +382,33 @@ describe('standalone cache uses a config file', () => {
 
 expect(resultsNew[0].warnings).toHaveLength(1);
 });
+
+it('enables cache in a config file', async () => {
+const options = { files: [lintedFile] };
+
+await writeFile(configFile, JSON.stringify({ cache: true, rules: {} }));
+await standalone(options);
+
+expect(existsSync(expectedCacheFilePath)).toBe(true);
+});
+
+it('disables cache when the option precedes, regardless of a config file', async () => {
+const options = { files: [lintedFile], cache: false };
+
+await writeFile(configFile, JSON.stringify({ cache: true, rules: {} }));
+await standalone(options);
+
+expect(existsSync(expectedCacheFilePath)).toBe(false);
+});
+
+it('disables cache when the config precedes, regardless of a config file', async () => {
+const config = { files: [lintedFile], config: { cache: false, rules: {} } };
+
+await writeFile(configFile, JSON.stringify({ cache: true, rules: {} }));
+await standalone(config);
+
+expect(existsSync(expectedCacheFilePath)).toBe(false);
+});
 });
 
 describe('standalone cache uses cacheStrategy', () => {

lib/__tests__/standalone.test.mjs

@@ -212,16 +212,26 @@ describe('standalone with nonexistent-file', () => {
 expect(errored).toBe(false);
 expect(report).toBe('[]');
 });
-});
 
-it('standalone ignoring passed "allowEmptyInput: false" option', async () => {
-const { errored } = await standalone({
-files: `${fixturesPath}/nonexistent-file.css`,
-configFile: `${fixturesPath}/config-allow-empty-input.json`,
-allowEmptyInput: false,
+it('allowEmptyInput disabled in options, regardless that it is enabled in config', async () => {
+await expect(
+standalone({
+files: `${fixturesPath}/nonexistent-file.css`,
+config: { ...configBlockNoEmpty, allowEmptyInput: true },
+allowEmptyInput: false,
+}),
+).rejects.toThrow(NoFilesFoundError);
 });
 
-expect(errored).toBe(false);
+it('allowEmptyInput disabled in options, regardless that it is enabled in config file', async () => {
+await expect(
+standalone({
+files: `${fixturesPath}/nonexistent-file.css`,
+configFile: `${fixturesPath}/config-allow-empty-input.json`,
+allowEmptyInput: false,
+}),
+).rejects.toThrow(NoFilesFoundError);
+});
 });
 
 describe('standalone passing code with syntax error', () => {

lib/cli.mjs

@@ -679,6 +679,9 @@ export function buildCLI(argv) {
 // See also https://github.com/sindresorhus/meow/blob/v12.0.1/source/validate.js#L75
 allowUnknownFlags: true,
 
+// NOTE: If CLI flags are unspecified (e.g., `--cache` nor `--no-cache`), we want to fall back to config properties (e.g., `cache`).
+booleanDefault: undefined,
+
 importMeta: import.meta,
 });
 }

lib/standalone.cjs

@@ -22,10 +22,11 @@ import getFormatter from './utils/getFormatter.mjs';
 import lintSource from './lintSource.mjs';
 import normalizeFixMode from './utils/normalizeFixMode.mjs';
 import prepareReturnValue from './prepareReturnValue.mjs';
+import resolveOptionValue from './utils/resolveOptionValue.mjs';
 
 const ALWAYS_IGNORED_GLOBS = ['**/node_modules/**'];
 
-/** @import {Formatter, FormatterType} from 'stylelint' */
+/** @import {InternalApi, LintResult} from 'stylelint' */
 
 /**
  * @type {import('stylelint').PublicApi['lint']}
@@ -84,6 +85,8 @@ export default async function standalone({
 }
 
 const stylelint = createStylelint({
+allowEmptyInput,
+cache,
 cacheLocation,
 cacheStrategy,
 config,
@@ -106,8 +109,6 @@ export default async function standalone({
 validate,
 });
 
-/** @type {Formatter} */
-
 /** @see https://github.com/stylelint/stylelint/issues/7447 */
 if (!quietDeprecationWarnings && formatter === 'github') {
 emitDeprecationWarning(
@@ -196,8 +197,7 @@ export default async function standalone({
 fileList = fileList.concat(ALWAYS_IGNORED_GLOBS.map((glob) => `!${glob}`));
 }
 
-// do not cache if config is explicitly overridden by option
-const useCache = cache ?? config?.cache ?? false;
+const useCache = await resolveOptionValue({ stylelint, name: 'cache', default: false });
 
 if (!useCache) {
 stylelint._fileCache.destroy();
@@ -283,7 +283,7 @@ export default async function standalone({
 });
 
 stylelintResults = await Promise.all(getStylelintResults);
-} else if (allowEmptyInput || config?.allowEmptyInput || (await canAllowEmptyInput(stylelint))) {
+} else if (await resolveOptionValue({ stylelint, name: 'allowEmptyInput', default: false })) {
 stylelintResults = await Promise.all([]);
 } else if (filePathsLengthBeforeIgnore) {
 // All input files ignored
@@ -313,7 +313,7 @@ export default async function standalone({
  * @import {CssSyntaxError} from 'stylelint'
  *
  * @param {unknown} error
- * @returns {import('stylelint').LintResult}
+ * @returns {LintResult}
  */
 function handleError(error) {
 if (error instanceof Error && error.name === 'CssSyntaxError') {
@@ -324,18 +324,8 @@ function handleError(error) {
 }
 
 /**
- * @param {import('stylelint').InternalApi} stylelint
- * @returns {Promise<boolean>}
- */
-async function canAllowEmptyInput(stylelint) {
-const config = await getConfigForFile({ stylelint });
-
-return Boolean(config?.config?.allowEmptyInput);
-}
-
-/**
- * @param {import('stylelint').InternalApi} stylelint
- * @param {import('stylelint').LintResult} stylelintResult
+ * @param {InternalApi} stylelint
+ * @param {LintResult} stylelintResult
  * @param {string} [filePath]
  * @returns {Promise<void>}
  */

lib/standalone.mjs

@@ -1,24 +1,20 @@
-import dynamicImport from './dynamicImport.mjs';
 import { existsSync } from 'node:fs';
+import { resolve } from 'node:path';
+
+import dynamicImport from './dynamicImport.mjs';
 import formatters from '../formatters/index.mjs';
-import getConfigForFile from '../getConfigForFile.mjs';
 import getFormatterOptionsText from './getFormatterOptionsText.mjs';
-import { resolve } from 'node:path';
+import resolveOptionValue from './resolveOptionValue.mjs';
 
-/** @import {Formatter, InternalApi} from 'stylelint' */
+/** @import {Formatter, FormatterType, InternalApi} from 'stylelint' */
 
 /**
  * @param {InternalApi} stylelint
  * @returns {Promise<Formatter>}
  */
 export default async function getFormatter(stylelint) {
-let formatter = stylelint._options.formatter;
-
-if (!formatter) {
-const config = await getConfigForFile({ stylelint, failIfNoConfig: false });
-
-formatter = config?.config.formatter;
-}
+/** @type {FormatterType | undefined} */
+let formatter = await resolveOptionValue({ stylelint, name: 'formatter' });
 
 if (typeof formatter === 'string') {
 let formatterFunction = formatters[formatter];