Skip to content

Remove claim, untrue since over 5 years ago, that cursorOffset is incompatible with rangeStart/rangeEnd #15750

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
thorn0 merged 12 commits into from
Dec 8, 2023
Merged

Remove claim, untrue since over 5 years ago, that cursorOffset is incompatible with rangeStart/rangeEnd #15750

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
927cb59
Remove claim, untrue since over 5 years ago, that cursorOffset is inc…
ExplodingCabbage Dec 4, 2023
fcf8838
Add changelog entry
ExplodingCabbage Dec 4, 2023
fd76a44
Merge branch 'main' into remove-false-claim-about-incompatible-options
ExplodingCabbage Dec 4, 2023
0de9fc5
Change CursorOptions type to no longer forbid rangeStart/rangeEnd acc…
ExplodingCabbage Dec 5, 2023
7ffecef
Merge branch 'remove-false-claim-about-incompatible-options' of githu…
ExplodingCabbage Dec 5, 2023
43c6944
Eliminate CursorOptions type; treat cursorOffset just like any other …
ExplodingCabbage Dec 5, 2023
415bc37
Merge branch 'main' into remove-false-claim-about-incompatible-options
ExplodingCabbage Dec 5, 2023
7c66b07
Revert "Eliminate CursorOptions type; treat cursorOffset just like an…
ExplodingCabbage Dec 5, 2023
0a3a99d
Merge branch 'remove-false-claim-about-incompatible-options' of githu…
ExplodingCabbage Dec 5, 2023
6521782
Merge branch 'main' into remove-false-claim-about-incompatible-options
ExplodingCabbage Dec 5, 2023
f0cccf5
Merge branch 'main' into remove-false-claim-about-incompatible-options
ExplodingCabbage Dec 6, 2023
a14986b
Remove no-longer-neededs @ts-expect-error directives
ExplodingCabbage Dec 6, 2023
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
Prev Previous commit
Next Next commit
Eliminate CursorOptions type; treat cursorOffset just like any other … 
…option
  • Loading branch information
@ExplodingCabbage
ExplodingCabbage committed Dec 5, 2023
commit 43c69445e92e319ab4614e83e534de743e569455
14 changes: 6 additions & 8 deletions src/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,11 @@ export interface RequiredOptions extends doc.printer.Options {
* @deprecated use bracketSameLine instead
*/
jsxBracketSameLine: boolean;
/**
* Specify where the cursor is.
* @default -1
*/
cursorOffset: number;
/**
* Format only a segment of a file.
* @default 0
Expand Down Expand Up @@ -543,13 +548,6 @@ export interface Printer<T = any> {
| undefined;
}

export interface CursorOptions extends Options {
/**
* Specify where the cursor is.
*/
cursorOffset: number;
}

export interface CursorResult {
formatted: string;
cursorOffset: number;
Expand All @@ -574,7 +572,7 @@ export function check(source: string, options?: Options): Promise<boolean>;
*/
export function formatWithCursor(
source: string,
options: CursorOptions,
options: Options,
): Promise<CursorResult>;

export interface ResolveConfigOptions {
Expand Down
4 changes: 2 additions & 2 deletions src/standalone.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { CursorOptions, CursorResult, Options, SupportInfo } from "./index.js";
import { CursorResult, Options, SupportInfo } from "./index.js";

/**
* formatWithCursor both formats the code, and translates a cursor position from unformatted code to formatted code.
Expand All @@ -13,7 +13,7 @@ import { CursorOptions, CursorResult, Options, SupportInfo } from "./index.js";
*/
export function formatWithCursor(
source: string,
options: CursorOptions,
options: Options,
): Promise<CursorResult>;

/**
Expand Down