Support Configuration Overrides for the experimental cli.

[Standard8]

I've been trying out the new experimental CLI, and it is indeed seeming to be a lot faster.

Something I've noticed is that it appears there's no current support for Configuration Overrides. I suspect it just hasn't been added yet, which is fine, but as I couldn't see an existing issue for it, I thought I'd file one for helping with tracking.

STR

1. Set up a repo with a .prettierrc.js such as the one below:

module.exports = {
  arrowParens: "avoid",
  endOfLine: "lf",
  printWidth: 80,
  tabWidth: 2,
  trailingComma: "es5",
  overrides: [
    {
      files: "*.css",
      options: {
        parser: "css",
        // Using a larger printWidth to avoid wrapping selectors.
        printWidth: 160,
      },
    },
  ],
};

2. Run the formatter

Expected Results

The CSS files are formatted correctly, with line width 160.

Actual Results

The CSS files are formatted with line width 80.

[fisker]

Can you try

module.exports = {
  arrowParens: "avoid",
  endOfLine: "lf",
  printWidth: 80,
  tabWidth: 2,
  trailingComma: "es5",
  overrides: [
    {
-      files: "*.css",
+      files: "**/*.css",
      options: {
        parser: "css",
        // Using a larger printWidth to avoid wrapping selectors.
        printWidth: 160,
      },
    },
  ],
};

I think it should work.

[fisker]

@43081j I thought this was fixed? Related PR #34

[Standard8]

Using files: "**/*.css", does work. Thank you.

[Abreuvoir]

I have the same issue, my overrides are not working. Here's my config file:

{
  "printWidth": 80,
  "tabWidth": 2,
  "useTabs": false,
  "semi": true,
  "singleQuote": true,
  "quoteProps": "as-needed",
  "jsxSingleQuote": false,
  "trailingComma": "none",
  "bracketSpacing": true,
  "bracketSameLine": false,
  "arrowParens": "always",
  "proseWrap": "preserve",
  "endOfLine": "auto",
  "singleAttributePerLine": true,
  "plugins": ["@ianvs/prettier-plugin-sort-imports"],
  "importOrder": [
    "",
    "<BUILTIN_MODULES>",
    "",
    "<THIRD_PARTY_MODULES>",
    "",
    "^[.]"
  ],
  "importOrderParserPlugins": ["typescript", "jsx", "decorators-legacy"],
  "importOrderTypeScriptVersion": "5.8.0",
  "overrides": [
    {
      "files": ["**/*.scss", "**/*.css"],
      "options": {
        "printWidth": 120
      }
    }
  ]
}

With the experimental cli, my css files are formated with a 80 printWidth

[fabiospampinato]

@fisker I think we have a TODO left about prefixing globs with **/ automatically unless they start with ./, assuming that's what the old CLI does, that hasn't been implemented yet. That said @Abreuvoir's config doesn't seem to be affected by that problem, so there might be another bug 🤔 I'll try to reproduce it once I get back home.

[Mathias-S]

Sorry for going a bit off-topic, but I also had an issue with the @ianvs/prettier-plugin-sort-imports plugin's importOrder mentioned in @Abreuvoir's config, so there may be a compatibility issue between the new CLI and that plugin (it seemed like the importOrder property wasn't read correctly, or possibly at all, with the new CLI).

[fabiospampinato]

@Mathias-S Interestingly, thanks, I'll have a look 👍

[oprypkhantc]

@Mathias-S @fabiospampinato It doesn't seem related to @ianvs/prettier-plugin-sort-imports at all. For me, even with experimental CLI turned off, and with an option like singleQuote: false it still doesn't pick up on the overrides. Even a glob for all files still doesn't seem to match anything: - files: '**/*'

[Standard8]

Are you using Prettier 3.6.0? That's the version that was working for me with files: "**/*.css",.

[tryone144]

it seemed like the importOrder property wasn't read correctly, or possibly at all, with the new CLI

This should probably be its own issue. overrides currently only pass on normalized configuration directives, no plugin options:

prettier-cli/src/utils.ts

Lines 659 to 660 in 4b1a66a

	const options = normalizeFormatOptions(overrideRaw.options);
	overrides.push({ filesPositive, filesNegative, folder, options });

This is in contrast to the top-level configuration object which keeps everything (therefore also unknown plugin options) and only normalizes known directives:

prettier-cli/src/config_prettier.ts

Line 94 in 4b1a66a

const normalize = (config: unknown) => (isObject(config) ? { ...config, ...normalizePrettierOptions(config, folderPath) } : undefined);

prettier-cli/src/utils.ts

Lines 640 to 643 in 4b1a66a

	function normalizePrettierOptions(options: unknown, folderPath: string): PrettierConfigWithOverrides {
	if (!isObject(options)) exit("Invalid options object");
	const config: PrettierConfigWithOverrides = normalizeFormatOptions(options);

[eamodio]

On 3.6.0, with config:

{
	"arrowParens": "avoid",
	"endOfLine": "lf",
	"trailingComma": "all",
	"printWidth": 120,
	"singleQuote": true,
	"tabWidth": 4,
	"useTabs": true,
	"overrides": [
		{
			"files": ".prettierrc",
			"options": { "parser": "json" }
		},
		{
			"files": "**/*.md",
			"options": { "tabWidth": 2 }
		}
	]
}

Using --experimental-cli doesn't honor the markdown tabWidth.

I originally had "files": "*.md", and it didn't work, so I tried "files": "**/*.md", and don't see any difference

[tryone144]

A shot in the dark, but could be Windows paths be the common denominator? In contrast to the cases where adding **/ to the glob has fixed the issue.

EDIT: Can't reproduce the issue of **/-prefix not working on windows…

[oprypkhantc]

No, I have the issue in a Linux Docker container. I see the same issue as @eamodio, where even standard Prettier options are not being respected.