[feat:stash] add stash API for push, apply, pop, drop, list and clean #228 #980 #1878

[modesty]

I'm adding a new command: stash

• [✅ ] add as a new file in src/api (and src/commands if necessary)
• [✅ ] add command to src/index.js
• [ ✅] update __tests__/test-exports.js
• [ ✅] create a test in src/__tests__ - test-stash covers 22 test cases
• [ ✅] document the command with a JSDoc comment
• [ ✅] add page to the Docs Sidebar website/sidebars.json
• [ ✅]] add page to the v1 Docs Sidebar website/versioned_sidebars/version-1.x-sidebars.json
• [ ✅]] if this is your first time contributing, run npm run add-contributor and follow the prompts to add yourself to the README
• squash merge the PR with commit message "feat: Added 'X' command"

[jcubic]

You have a typo: https://github.com/isomorphic-git/isomorphic-git/actions/runs/8610074109/job/23604865135?pr=1898

[jcubic]

So far looks good, but there are few things:

• Can you test untracked files if they stay intact?
• Do you plan to add ref to stash commands? This is part of canonical git where you can pop or apply different stash entry based on ref (e.g.: stash@{21}) we can use index of entry.

[modesty]

So far looks good, but there are few things:

• Can you test untracked files if they stay intact?

Next commit will add three more test cases:

1. 'stash with untracked files - no other changes'
2. 'stash with untracked files - with other changes'
3. 'stash apply with untracked files - with other staged and unstaged changes'
   it'll bring the total test cases to be 26

• Do you plan to add ref to stash commands? This is part of canonical git where you can pop or apply different stash entry based on ref (e.g.: stash@{21}) we can use index of entry.

yep, it can be added

[modestysn]

new commit b9aec41 has added ref (the ref index of stash) to apply, pop and drop, also added more tests on untracked files, valid/invalid refIdx, default stash message, etc., total test cases are 34.

[jcubic]

Looks good, only a few minor things in tests that you can simplify

[jcubic]

I've added comments to the commit, they are not visible on the PR.