From 19166acac2c2cdcfc1d8c215d745902fbb785335 Mon Sep 17 00:00:00 2001 From: neverland Date: Tue, 4 Aug 2026 14:47:57 +0800 Subject: [PATCH 1/3] fix(fmt): align help option descriptions --- packages/rstack/src/fmt/cli.ts | 12 ++++++------ packages/rstack/tests/fmt/cli.test.ts | 19 +++++++++++-------- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/packages/rstack/src/fmt/cli.ts b/packages/rstack/src/fmt/cli.ts index 480acb8..ab56529 100644 --- a/packages/rstack/src/fmt/cli.ts +++ b/packages/rstack/src/fmt/cli.ts @@ -26,13 +26,13 @@ ${color.yellow(' $ rs fmt [options] [files/globs...]')} Format files with Prettier. ${color.cyan('Options')}: - --write Write formatted files in place (default) - --check Check whether files are formatted - --list-different Print paths of unformatted files - --ignore-path Path to an additional ignore file (repeatable) + --write Write formatted files in place (default) + --check Check whether files are formatted + --list-different Print paths of unformatted files + --ignore-path Path to an additional ignore file (repeatable) --parallel-workers Number of parallel workers - --stdin-filepath Format stdin as if it were saved at - -h, --help Display this help message`; + --stdin-filepath Format stdin as if it were saved at + -h, --help Display this help message`; const parseMaxWorkers = ( kebabValue: string | undefined, diff --git a/packages/rstack/tests/fmt/cli.test.ts b/packages/rstack/tests/fmt/cli.test.ts index bc97edb..e48413e 100644 --- a/packages/rstack/tests/fmt/cli.test.ts +++ b/packages/rstack/tests/fmt/cli.test.ts @@ -139,14 +139,17 @@ test('rejects file arguments with --stdin-filepath', () => { }); test('provides command help', () => { - expect(fmtHelpMessage).toContain('Usage:\n $ rs fmt [options] [files/globs...]'); - expect(fmtHelpMessage).toContain('--write'); - expect(fmtHelpMessage).toContain('--check'); - expect(fmtHelpMessage).toContain('--list-different'); - expect(fmtHelpMessage).toContain('--ignore-path '); - expect(fmtHelpMessage).toContain('--parallel-workers '); - expect(fmtHelpMessage).toContain('--stdin-filepath '); - expect(fmtHelpMessage).toContain('-h, --help'); + const helpMessage = stripVTControlCharacters(fmtHelpMessage); + + expect(helpMessage).toContain('Usage:\n $ rs fmt [options] [files/globs...]'); + expect(helpMessage).toContain(`Options: + --write Write formatted files in place (default) + --check Check whether files are formatted + --list-different Print paths of unformatted files + --ignore-path Path to an additional ignore file (repeatable) + --parallel-workers Number of parallel workers + --stdin-filepath Format stdin as if it were saved at + -h, --help Display this help message`); }); test.each([ From 50f0610c37370ebdcc5a36eb1d72c2d3068cc333 Mon Sep 17 00:00:00 2001 From: neverland Date: Tue, 4 Aug 2026 14:54:41 +0800 Subject: [PATCH 2/3] test(fmt): snapshot help output --- .../tests/fmt/__snapshots__/cli.test.ts.snap | 19 +++++++++++++++++++ packages/rstack/tests/fmt/cli.test.ts | 9 +-------- 2 files changed, 20 insertions(+), 8 deletions(-) create mode 100644 packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap diff --git a/packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap b/packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap new file mode 100644 index 0000000..9d61a34 --- /dev/null +++ b/packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap @@ -0,0 +1,19 @@ +// Rstest Snapshot v1 + +exports[`provides command help 1`] = ` +"Rstack v0.3.2 + +Usage: + $ rs fmt [options] [files/globs...] + +Format files with Prettier. + +Options: + --write Write formatted files in place (default) + --check Check whether files are formatted + --list-different Print paths of unformatted files + --ignore-path Path to an additional ignore file (repeatable) + --parallel-workers Number of parallel workers + --stdin-filepath Format stdin as if it were saved at + -h, --help Display this help message" +`; diff --git a/packages/rstack/tests/fmt/cli.test.ts b/packages/rstack/tests/fmt/cli.test.ts index e48413e..13a06ec 100644 --- a/packages/rstack/tests/fmt/cli.test.ts +++ b/packages/rstack/tests/fmt/cli.test.ts @@ -142,14 +142,7 @@ test('provides command help', () => { const helpMessage = stripVTControlCharacters(fmtHelpMessage); expect(helpMessage).toContain('Usage:\n $ rs fmt [options] [files/globs...]'); - expect(helpMessage).toContain(`Options: - --write Write formatted files in place (default) - --check Check whether files are formatted - --list-different Print paths of unformatted files - --ignore-path Path to an additional ignore file (repeatable) - --parallel-workers Number of parallel workers - --stdin-filepath Format stdin as if it were saved at - -h, --help Display this help message`); + expect(helpMessage).toMatchSnapshot(); }); test.each([ From 8ed20dd06ea2f149865d7163466b5176d5a11476 Mon Sep 17 00:00:00 2001 From: neverland Date: Tue, 4 Aug 2026 15:08:00 +0800 Subject: [PATCH 3/3] test(fmt): exclude version from help snapshot --- packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap | 4 +--- packages/rstack/tests/fmt/cli.test.ts | 2 +- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap b/packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap index 9d61a34..b22c256 100644 --- a/packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap +++ b/packages/rstack/tests/fmt/__snapshots__/cli.test.ts.snap @@ -1,9 +1,7 @@ // Rstest Snapshot v1 exports[`provides command help 1`] = ` -"Rstack v0.3.2 - -Usage: +"Usage: $ rs fmt [options] [files/globs...] Format files with Prettier. diff --git a/packages/rstack/tests/fmt/cli.test.ts b/packages/rstack/tests/fmt/cli.test.ts index 13a06ec..61cf2f4 100644 --- a/packages/rstack/tests/fmt/cli.test.ts +++ b/packages/rstack/tests/fmt/cli.test.ts @@ -139,7 +139,7 @@ test('rejects file arguments with --stdin-filepath', () => { }); test('provides command help', () => { - const helpMessage = stripVTControlCharacters(fmtHelpMessage); + const helpMessage = stripVTControlCharacters(fmtHelpMessage).replace(/^Rstack v.*\n\n/, ''); expect(helpMessage).toContain('Usage:\n $ rs fmt [options] [files/globs...]'); expect(helpMessage).toMatchSnapshot();