TESTING.md

Manual Tests for @johnlindquist/worktree CLI

Manual Test for CLI Command Name Change

1. Install the package globally:

   pnpm install -g .

2. Run the command help to verify the new command:

   wt --help

3. Optionally, test additional commands:
   • Create a new worktree:

     wt new feature/test

   • List worktrees:

     wt list

   • Remove a worktree:

     wt remove feature/test

New Worktree Sibling Directory Test

1. In a test repository, run:

   wt new editor

2. Verify that a new sibling directory named <currentDirectoryName>-editor is created.
3. Confirm that the worktree is added to the Git repository and that the Cursor editor opens the new directory.

Remove Worktree Force Flag Test

1. Create a test worktree:

   wt new test-branch

2. Make some changes in the worktree that would prevent normal removal
3. Try removing the worktree without the force flag:

   wt remove test-branch

   This should fail if there are uncommitted changes
4. Try removing the worktree with the force flag:

   wt remove --force test-branch

   This should succeed and remove the worktree regardless of its state
5. Verify that the worktree directory is removed and the Git worktree reference is cleaned up

Manual Test for Merge Command

1. Setup a Test Worktree:
   • Create a new worktree for a test branch:

     wt new test-merge

2. Make Changes in the Test Worktree:
   • Navigate to the test worktree directory, edit a file, and save your changes.
3. Run the Merge Command:
   • Go back to your main worktree (current branch) and execute:

     wt merge test-merge

4. Verify the Merge:
   • Confirm that the changes from test-merge are merged into the current branch.
   • Check that the test worktree is removed.
5. Test with Force Flag:
   • Create another test worktree:

     wt new test-merge-force

   • Make changes that would prevent normal removal (e.g., untracked files)
   • Run the merge with force flag:

     wt merge test-merge-force --force

   • Verify that the merge succeeds and the worktree is forcibly removed.

Manual Test for CI Publish Workflow

1. Push a commit to the main branch (or merge the PR) to trigger the workflow.
2. Check the Actions tab in your GitHub repository to see that the "Publish to npm" workflow runs successfully.
3. Verify that the package is published to npm with the expected version (0.0.0-development) without any new commits from the workflow.

Important Notes

• The CI workflow will not make any commits or version bumps
• Version updates should be handled manually outside of CI
• Make sure you have set up the NPM_TOKEN secret in your GitHub repository settings

Manual Test for Purge Command

1. Setup Test Worktrees:
   • Create two new worktrees on branches other than main:

     wt new test-branch1
     wt new test-branch2

2. Execute Purge Command:
   • Run the purge command:

     wt purge

3. Confirmation:
   • For each listed worktree, verify that the branch and path are displayed.
   • When prompted, enter y to remove a worktree or any other key to skip.
4. Verification:
   • After purging, run:

     git worktree list

     Ensure that only the main branch worktree remains (or those you opted not to remove).