Skip to content

Accept readonly arrays in detect order option #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bluwy merged 1 commit into from
Oct 23, 2026
Merged

Accept readonly arrays in detect order option #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/readonly-detect-order.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@changesets/format": patch
---

Accept readonly arrays in the `order` option of `detect`.
2 changes: 1 addition & 1 deletion src/detect.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ export interface DetectOptions {
* The order of formatters to check for.
* @default ["dprint", "deno", "oxfmt", "biome", "prettier"] // from `defaultDetectOrder`
*/
order?: FormatterName[];
order?: readonly FormatterName[];

@Netail Netail Oct 22, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will break mutable arrays tho, in case we need to filter later again

@Andarist Andarist Oct 22, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

both are OK:

type Formatter = "dprint" | "deno" | "oxfmt" | "biome" | "prettier";

declare function test(options: { formatters?: readonly Formatter[] }): void;

declare const ro: readonly Formatter[];
declare const mutable: Formatter[];

test({
  formatters: ro, // ok
});
test({
  formatters: mutable, // ok
});

Internally we can always make a copy if needed, we shouldn't mutate the input array anyway.

}

/**
Expand Down
Loading