Added partial support for the "--config-precedence" option

prettier · Apr 27, 2024 · e148041 · e148041
1 parent de93432
commit e148041
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 3 deletions.
diff --git a/src/bin.ts b/src/bin.ts
@@ -78,11 +78,19 @@ const makeBin = (): Bin => {
  section: "Format",
  })
  /* CONFIG OPTIONS */
- .option("--config-path <path>", "Path to a Prettier configuration file (.prettierrc, package.json, prettier.config.js)", { section: "Config" })
  .option("--no-config", "Do not look for a configuration file", {
  section: "Config",
  default: true,
  })
+ .option("--config-path <path>", "Path to a Prettier configuration file (.prettierrc, package.json, prettier.config.js)", { section: "Config" })
+ .option(
+ "--config-precedence <cli-override|file-override>",
+ 'Define in which order config files and CLI options should be evaluated.\nDefaults to "cli-override"',
+ {
+ section: "Config",
+ enum: ["cli-override", "file-override"],
+ },
+ )
  .option("--no-editorconfig", "Don't take .editorconfig into account when parsing configuration", {
  section: "Config",
  default: true,
@@ -230,6 +238,10 @@ const makeWarnedPluggableBin = async (): Promise<Bin> => {
  exit('The "--find-config-path" is not currently supported, please open an issue on GitHub if you need it');
  }
 
+ if (args["config-precedence"] === "prefer-file") {
+ exit('The "prefer-file" value for "--config-precedence" is not currently supported, please open an issue on GitHub if you need it');
+ }
+
  const bin = await makePluggableBin();
  return bin;
 };

diff --git a/src/prettier_serial.ts b/src/prettier_serial.ts
@@ -18,11 +18,12 @@ async function format(filePath: string, fileContent: string, formatOptions: Lazy
  formatOptions = await resolve(formatOptions);
  const pluginsBuiltin = await getPluginsBuiltin();
  const plugins = await getPlugins(formatOptions.plugins || []);
+ const pluginsOverride = contextOptions.configPrecedence !== 'file-override';
 
  const options = {
  ...pluginsDefaultOptions,
- ...formatOptions,
- ...pluginsCustomOptions,
+ ...(pluginsOverride ? formatOptions : pluginsCustomOptions),
+ ...(pluginsOverride ? pluginsCustomOptions : formatOptions),
  ...contextOptions,
  filepath: filePath,
  plugins: [

diff --git a/src/types.ts b/src/types.ts
@@ -1,6 +1,7 @@
 type Bin = ReturnType<typeof import("tiny-bin").default>;
 
 type ContextOptions = {
+ configPrecedence?: "cli-override" | "file-override";
  cursorOffset?: number;
  rangeEnd?: number;
  rangeStart?: number;

diff --git a/src/utils.ts b/src/utils.ts
@@ -345,6 +345,13 @@ function normalizeContextOptions(options: unknown): ContextOptions {
 
  const contextOptions: ContextOptions = {};
 
+ if ("configPrecedence" in options) {
+ const value = options.configPrecedence;
+ if (isString(value) && (value === "cli-override" || value === "file-override")) {
+ contextOptions.configPrecedence = value;
+ }
+ }
+
  if ("cursorOffset" in options) {
  const value = Number(options.cursorOffset);
  if (isInteger(value) && value >= 0) {