Skip to content

fix(rstack): clarify forced setup output #405

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
chenjiahan merged 1 commit into from
Aug 24, 2026
+17 −12
Merged

fix(rstack): clarify forced setup output #405

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
15 changes: 8 additions & 7 deletions packages/rstack/src/setup/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,24 @@ export const runSetupCLI = async (args: string[]): Promise<void> => {
const result = installHooks({ force: values.force, hooksDir });

if (result.status === 'installed') {
// Warn when `--force` preserves an existing hooks setup but makes it inactive.
// Explain the result when `--force` preserves an existing hooks setup but makes it inactive.
if (result.inactiveHooks) {
const { hooks, path, restore } = result.inactiveHooks;
const hooksMessage = hooks.length
? `: ${color.yellow(hooks.join(', '))}`
: '';
logger.warn(
`The previous Git hooks path "${color.yellow(path)}" is now inactive${hooksMessage}.`,
logger.info(
`Rstack now manages Git hooks at "${color.yellow(result.hooksPath)}".`,
);
logger.info(
`Existing hooks in "${color.yellow(path)}" were preserved but will no longer run${hooksMessage}.`,
);

if (restore === 'unset') {
logger.info(
`The existing files were preserved and will become active again if ${color.yellow('core.hooksPath')} is unset.`,
);
logger.info(`Unset ${color.yellow('core.hooksPath')} to restore them.`);
} else {
logger.info(
`The existing files were preserved. Set ${color.yellow('core.hooksPath')} back to this path to use them again.`,
`Set ${color.yellow('core.hooksPath')} back to "${color.yellow(path)}" to restore them.`,
);
}
}
Expand Down
14 changes: 9 additions & 5 deletions packages/rstack/tests/cli/setup/index.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,12 @@ test('guides and forces setup while preserving existing hooks', ({

const forcedOutput = runSetupSuccessfully(['--force']);
expect(forcedOutput).toContain(
'The previous Git hooks path ".git/hooks" is now inactive: pre-commit.',
'info Rstack now manages Git hooks at ".rstack/hooks/_".',
);
expect(forcedOutput).toContain(
'The existing files were preserved and will become active again if core.hooksPath is unset.',
'Existing hooks in ".git/hooks" were preserved but will no longer run: pre-commit.',
);
expect(forcedOutput).toContain('Unset core.hooksPath to restore them.');
expect(git(['config', '--local', '--get', 'core.hooksPath'])).toBe(hooksPath);

git(['hook', 'run', 'pre-commit']);
Expand All @@ -155,7 +156,7 @@ test('guides and forces setup while preserving existing hooks', ({
expect(existsSync(path.join(cwd, 'old-hook-ran'))).toBe(true);

expect(runSetupSuccessfully(['-f'])).toContain(
'The previous Git hooks path ".git/hooks" is now inactive: pre-commit.',
'Existing hooks in ".git/hooks" were preserved but will no longer run: pre-commit.',
);
});

Expand All @@ -171,10 +172,13 @@ test('reports how to restore a replaced hooks path', ({ expect }) => {

const output = runSetupSuccessfully(['--force']);
expect(output).toContain(
'The previous Git hooks path ".husky/_" is now inactive: pre-commit.',
'info Rstack now manages Git hooks at ".rstack/hooks/_".',
);
expect(output).toContain(
'The existing files were preserved. Set core.hooksPath back to this path to use them again.',
'Existing hooks in ".husky/_" were preserved but will no longer run: pre-commit.',
);
expect(output).toContain(
'Set core.hooksPath back to ".husky/_" to restore them.',
);
});

Expand Down