Discussed in #1

def clone [
    owner: string
    repo: string
    --host: string = "github.com"
    --protocol: string = "https"
] {(
    git clone
        ({
            scheme: $protocol,
            host: $host,
            path: $"/($owner)/($repo)",
        } | url join)
        ($env.GIT_REPOS_HOME | path join $host $owner $repo)
)}

Describe the bug

when Git has a version prior to 2.43.0, --bare and --origin are incompatible options of ^git clone, thus gm clone --bare will fail with

fatal: --bare and --origin foo options are incompatible.

How to reproduce

tk run {
    gm clone https://github.com/raphamorim/rio --bare
}

will fail on Ubuntu for instance.

Expected behavior

either

• https://github.com/raphamorim/rio should be installed as a bare repo
• there should be a nicer Nushell error

Configuration

> git --version
git version 2.34.1

Additional context

See commit 3b910d6 (22 Sep 2022) by Jeff King (peff).
(Merged by Junio C Hamano (gitster) in commit 7aeb0d4, 10 Oct 2022)

in the long run, i think we need unit and integration tests, as much as possible 👍

• a CI to run them all: #27
• unit tests: all the internals are tested
  • #26
  • #29
  • #39
  • #34
  • #44
• integration / end-to-end tests: make sure the gm commands work as expected with real repos
  • #48
• cover the modules of nu-git-manager-sugar
  • git-prompt
    • #121
    • #122

what do you think @melMass about adding some GitHub management scripts here? 😮

i have my gh module and that little script i just wrote to help me review nushell PRs 😋

def "nu-complete list-repos" [context: string] {
    let user = ($context | str replace 'gh\s*pr\s*open\s*' "" | split row " " | get 0)

    http get ({
        scheme: https,
        username: "",
        host: api.github.com,
        path: $"/orgs/($user)/repos",
        params: {
            sort: updated,
            per_page: 100,
            page: 1
        }
    } | url join)
    | select name description
    | rename value description
}

def "nu-complete gh-status" [] {[
    [value description];

    [failure "The CI does not pass."]
    [pending "The CI is currently running."]
    [success "All the CI jobs have passed."]
]}

def "nu-complete gh-review" [] {[
    [value description];

    [none "No review at all."]
    [changes-requested "There are changes to be applied."]
    [approved "The PR has been approved."]
]}

export def "gh pr open" [
    owner: string
    repo: string@"nu-complete list-repos"
    --draft: bool
    --ready: bool  # has precedence over `--draft`
    --status: string@"nu-complete gh-status"
    --review: string@"nu-complete gh-review"
] {
    let draft = (if $draft or $ready {
        $draft and (not $ready)
    })

    let query = [
        [is pr]
        [is open]
        [draft $draft]
        [status $status]
        [review $review]
    ]

    let url = ({
        scheme: https,
        host: github.com,
        path: $"/($owner)/($repo)/pulls",
        params: {
            q: (
                $query
                | where {|it| $it.1 != null}
                | each { str join "%3A" }
                | str join "+"
            )
        }
    } | url join)

    xdg-open $url
}

Note

• added context-aware completion for repo
• added --draft option
• do not add draft to the query if neither --draft nor --ready are raised

i also have a GitHub gist management script here.

let's say i update repos of my store manually:

• i git init a repo called manual/foo
• i git init a repo called manual/bar
• i rm a repo called auto/baz

when i run gm update-cache to remove auto/baz from it and add manual/foo and manual/bar to it, i think it would be cool to have an output like the following:

> gm update-cache
updating cache... done
#┬───name───┬status─
0│manual/foo│added
1│manual/bar│added
2│auto/baz  │removed
─┴──────────┴───────

this implies that the signature of gm update-cache would change a bit from

"gm update-cache" []: nothing -> nothing

to

"gm update-cache" []: nothing -> table<name: string, status: string>

use path join "foo" "bar" instead of path join "foo/bar" to abstract path joining.

right now, the error is not that great when running gh ... being logged out 🤔
and it does not fail in the sense that the LAST_EXIT_CODE is not set to 1 in that case 🤔

an idea that looks to be working: add gh auth status at the start

remaining things: what happens when the user is

• logged out: fails with You are not logged into any GitHub hosts. Run gh auth login to authenticate.
  • #20
• logged in: ??? => --logged-out option to query the API with http get

the module has been left unchecked for too long 😏

• git
  • #104
• gh
  • #31
• gist
  • #120

as per title, i would like to refactor the base directories of all the tests to be the same, to avoid messing around too much with the filesystem.

description

nu-git-manager is not able to clone Suckless software.

reproduce

> gm clone git://git.suckless.org/st
Cloning into '/home/amtoine/documents/repos/git.suckless.org/st/st'...
fatal: repository 'https://git.suckless.org/st/st/' not found

expected

i would like to be able to do something like

> gm clone git://git.suckless.org/st --fetch git --push git

to specify to use the GIT protocol to at least fetch, you probably won't push there.

related to

• nushell/nupm#43

Description

i would like to

• add a gm version command when it gets possible
• add a stronger dependency on Nupm in package.nuon

i stumbled upon the following interesting structure

module foo {
    export def main [] { help foo }
    export def bar [] { "foo bar" }
}

where foo would do nothing but give the help of the module 😏

> use foo

> foo bar
foo bar

> foo
Usage:
  > foo

Subcommands:
  foo bar -

Flags:
  -h, --help - Display the help message for this command

in the nushell/nu_scripts repo, we have the following files that could be interesting at some point

╭───┬───────────────────────────────────────────────────────────╮
│ 0 │ aliases/git/nu_alias_git.nu                               │
│ 1 │ custom-completions/auto-generate/completions/git-sizer.nu │
│ 2 │ custom-completions/auto-generate/completions/git.nu       │
│ 3 │ custom-completions/auto-generate/completions/gitk.nu      │
│ 4 │ modules/git/git.nu                                        │
│ 5 │ modules/git/git_branch_cleanup.nu                         │
│ 6 │ modules/prompt/async_git_prompt/async-git-prompt.nu       │
│ 7 │ modules/prompt/panache-git.nu                             │
│ 8 │ modules/prompt/powerline/power_git.nu                     │
│ 9 │ sourced/cool-oneliners/git_gone.nu                        │
╰───┴───────────────────────────────────────────────────────────╯

Note
generated with fd git | lines | find --invert themes before_v0.60 github gitlab custom-completions/git | find --invert --regex '/$'

there are also a bunch of things scattered around in my nu_scripts 👍
especially

• the gf module
• the dotfiles module

i've been thinking a bit about the user experience of nu-git-manager.
with #26, i feel the command API is quite good and simple (:crossed_fingers:)

however, here i would like to talk about the way the library definitions are imported 😋

cc/ @melMass

the namespace

i think all the commands from nu-git-manager should be subcommands of gm, to have

• a single namespace
• not clashing with external commands such as git or gh which can break external completers

imports

here is what i propose, the implementation is really a detail in the scope of this issue 👌

• main commands

use nu-git-manager main [gm, "gm list", "gm clone", ...]
use nu-git-manager main *

• Git commands from sugar

use nu-git-manager sugar git ["gm branch", "gm fetch", ...]
use nu-git-manager sugar git *

• Github commands from sugar

use nu-git-manager sugar gh ["gm pr checkout", ...]
use nu-git-manager sugar gh *

• all of sugar?

# would import all `gm branch`, `gm fetch`, `gm pr checkout`, ..., without `sugar` as prefix
use nu-git-manager sugar *

• everything?

# would import all `gm clone`, `gm pr checkout`, ..., without `sugar` nor `main` as prefixes
use nu-git-manager *

Describe the bug

when using gm repo branches --clean when checked out on a dangling branch, the command will halt because git branch -D fails.

How to reproduce

tk run --clean {
    # setup the repo
    let repo = $nu.temp-path | path join foo
    if ($repo | path exists) {
        rm -f -r $repo
    }
    git init $repo
    cd $repo
    git checkout --orphan main
    git commit --allow-empty --no-gpg-sign --message "init"

    # create two branches and checkout the first one
    git branch bar
    git branch foo
    git checkout bar

    print $"dangling branches: (gm repo branches | where ($it.remotes | is-empty) | get branch)"
    gm repo branches --clean
}

Initialized empty Git repository in /tmp/foo/.git/
Switched to a new branch 'main'
[main (root-commit) e35547d] init
Switched to branch 'bar'
dangling branches: [bar, foo, main]
2023-12-06T16:33:36.290|INF|deleting branch `bar`
error: Cannot delete branch 'bar' checked out at '/tmp/foo'

Expected behavior

i expected gm repo branches --clean to skip branch bar and remove foo without an error.

Configuration

Additional context

No response

Describe the bug

related to

• nushell/nushell#11648
• nushell/nushell#11649

How to reproduce

1. look at the source of nu-git-manager => it has a usage and extra usage
2. look at the documentation of the module => there is only the usage

Expected behavior

i expected to see the extra usage as well

Configuration

Additional context

No response

i've noticed a bunch of

str replace (get-repo-store-path) '' | str trim --left --char "/"

or similar in the source base 🤔

i think they should be refactored into something like path trim-root.

This is what initially happens when you bring nu-git-manager out of the box...

In other words the first time installing it...

I started off by running

gm clone https://github.com/amtoine/nu-git-manager

And then got the message that "cache not found"

So I went ahead and ran the command

gm update-cache

And this is what happend --- nushell crashed and paniced with this error message

updating cache... Error:   × Deprecated option
    ╭─[/Users/ma/j/tmp17/nu-git-manager/nu-git-manager/fs/store.nu:38:1]
 38 │     cd (get-repo-store-path)
 39 │     let heads: list<string> = glob "**/HEAD" --not [
    ·                               ──┬─
    ·                                 ╰── `glob --not {list<string>}` is deprecated and will be removed in 0.88.
 40 │             **/.git/**/refs/remotes/**/HEAD,
    ╰────
  help: Please use `glob --exclude {list<string>}` instead.


thread 'main' panicked at 'attempt to add with overflow', crates/nu-command/src/filters/range.rs:108:58
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

This happens on both the main branch and the release of nushell 0.86

Both error out in the exact same spot...

https://github.com/nushell/nushell/blob/main/crates/nu-command/src/filters/range.rs#L108

Describe the bug

as per title

How to reproduce

1. run

git checkout ea557bb8ebaed2bb40951ea434ab89712a718de5

2. apply the following patch

diff --git a/src/nu-git-manager/mod.nu b/src/nu-git-manager/mod.nu
index 488854b..c3b82be 100644
--- a/src/nu-git-manager/mod.nu
+++ b/src/nu-git-manager/mod.nu
@@ -324,5 +324,7 @@ export def "gm remove" [
     check-cache-file $cache_file
     remove-from-cache $cache_file ($root | path join $repo_to_remove)
 
+    "foo" | path sanitize
+
     null
 }

3. run use toolkit.nu; toolkit test => it runs just fine
4. try to use ./src/nu-git-manager/ * and see the following error

Error: nu::parser::extra_positional

  × Extra positional argument.
     ╭─[/home/amtoine/documents/repos/github.com/amtoine/nu-git-manager/src/nu-git-manager/mod.nu:326:1]
 326 │
 327 │     "foo" | path sanitize
     ·                  ────┬───
     ·                      ╰── extra positional argument
 328 │
     ╰────
  help: Usage: path

Expected behavior

i expected the tests to fail

Configuration

Additional context

No response

Describe the bug

found the use of a deprecated command just after releasing 0.3.0 and trying out gm clean 😋

unfold is going to be renamed generate very soon 😏

How to reproduce

1. tk run --clean { gm clone https://github.com/amtoine/nu-git-manager --depth 1 }
2. tk run { gm update-cache; gm clean }
3. see

Error:   × Deprecated option
   ╭─[/home/amtoine/.local/share/nupm/modules/nu-git-manager/fs/dir.nu:6:1]
 6 │ export def clean-empty-directories-rec []: list<path> -> list<path> {
 7 │     let deleted = unfold $in {|directories|
   ·                   ───┬──
   ·                      ╰── `unfold` is deprecated and will be removed in 0.88.
 8 │         let next = $directories | each {|it|
   ╰────
  help: Please use `generate` instead.

Expected behavior

no deprecation warning

Configuration

Additional context

No response

let's say i have already the nushell/nushell repo cloned.
when i gm clone https://github.com/amtoine/nushell, i.e. my fork of the Nushell repo, a new amtoine/nushell repo gets created in the store of nu-git-manager.

i would like gm to merge the two local copies, e.g. put everything in nushell/nushell and create two remotes

• nushell which points to nushell/nushell
• amtoine which points to amtoine/nushell

for my future self: a command to get the list of all the forks with their paths and root commit 👌

def get-forks []: nothing -> table<root: string, paths: list<string>> {
    gm list --full-path
        | each {{
            repo: $in,
            root: (^git -C $in rev-list HEAD | lines | last)
        }}
        | group-by root
        | transpose k v
        | where ($it.v | length) > 1
        | select k v.repo
        | rename --column { k: "root", v_repo: "paths" }
}

def is-grafted [repo?: path] {
    let repo = if $repo == null {
        pwd
    } else {
        if not ($repo | path exists) {
            error make {
                msg: $"(ansi red_bold)directory_not_found(ansi reset)"
                label: {
                    text: "no such directory"
                    start: (metadata $repo).span.start
                    end: (metadata $repo).span.end
                }
            }
        }

        $repo
    }

    let root_commit = ^git -C $repo rev-list HEAD | lines | last
    ^git -C $repo log --oneline --decorate $root_commit
        | parse --regex '[0-9a-f]+ \(grafted.*'
        | is-empty
        | not $in
}

Just dumping that here, as not everyone keep track of nushell version I think there should be a requirement section on the readme (could also be used to list other dependencies, like gh (optional).

Since a recent commit gm doesn't work on 0.79.1:

So I think it should also specify nushell 0.8.0+

the usage section of the README is already out of date...

i think it would be great and time to have some script to generate all the available modules and list the commands in them.

something in the CI would be great.

Describe the bug

as per title

How to reproduce

first run

tk run --clean {
    gm update-cache

    # clone two forks
    gm clone https://github.com/amtoine/nushell
    gm clone https://github.com/nushell/nushell

    # setup `nushell` as a remote of `amtoine`
    ^git -C ($env.GIT_REPOS_HOME | path join "github.com/amtoine/nushell") remote add nushell https://github.com/nushell/nushell

    # try to squash into `amtoine`
    gm squash-forks --non-interactive-preselect {
        8f3b273337b53bd86d5594d5edc9d4ad7242bd4c: "github.com/amtoine/nushell"
    }
}

deleted /tmp/nu-git-manager/repos
deleted /tmp/nu-git-manager/repos.cache
updating cache... done
Cloning into '/tmp/nu-git-manager/repos/github.com/amtoine/nushell'...
remote: Enumerating objects: 102625, done.
remote: Counting objects: 100% (102625/102625), done.
remote: Compressing objects: 100% (27930/27930), done.
remote: Total 102625 (delta 73950), reused 101765 (delta 73656), pack-reused 0
Receiving objects: 100% (102625/102625), 38.30 MiB | 21.49 MiB/s, done.
Resolving deltas: 100% (73950/73950), done.
updating cache... done
Cloning into '/tmp/nu-git-manager/repos/github.com/nushell/nushell'...
remote: Enumerating objects: 102194, done.
remote: Counting objects: 100% (102194/102194), done.
remote: Compressing objects: 100% (27838/27838), done.
remote: Total 102194 (delta 73627), reused 101309 (delta 73323), pack-reused 0
Receiving objects: 100% (102194/102194), 38.24 MiB | 12.13 MiB/s, done.
Resolving deltas: 100% (73627/73627), done.
Warning:   ⚠ cloning_fork
| this repo is a fork of 1 other repo because they share the same root commit: 8f3b273337b53bd86d5594d5edc9d4ad7242bd4c
| - github.com/amtoine/nushell
updating cache... done
error: remote nushell already exists.

Note
see the error at the bottom

now, if we list the repos, we still see nushell...

tk run { gm list }

─┬──────────────────────────
0│github.com/amtoine/nushell
1│github.com/nushell/nushell
─┴──────────────────────────

Expected behavior

i expected tk run { gm list } to only return the amtoine fork.

Configuration

Additional context

No response

in the long run, i'd like to have more external and custom completions inside both gm and sugar 👍

in gm

• custom completion on all the exported commands, e.g. host + user + project completion, possibly by pulling GitHub (? 😮)

in sugar

external completions

• the gh CLI command of GitHub in sugar completions gh: based on gh version 2.28.0 (2023-04-25)?
• the usual git command
  • draw the full list of commands and options
  • write them all, even empty, for completeness
  • write custom completion for them
  • split the externals into modules, e.g. core, cherry, remote, worktree, ..., to allow importing only usefull commands more easily

custom completions

• sugar git
• sugar gist (removed)
• sugar gh
• sugar dotfiles (removed)

i would like to split the tests

• tests internals from the current tests
  • maybe further splitting this as well
• tests gm from #48
  • maybe a sub tests gm clone for all the clone tests

Describe the bug

as per title

How to reproduce

tk run --clean {
    gm update-cache

    gm clone --depth 1 https://github.com/amtoine/nu-git-manager
    let repo = gm list --full-path | find nu-git-manager | get 0
    cd $repo
    gm remove --no-confirm nu-git-manager
}

will give

Error:   × Cannot remove any parent directory
     ╭─[/home/amtoine/.local/share/nupm/modules/nu-git-manager/mod.nu:433:1]
 433 │
 434 │     rm --recursive --force --verbose $repo_to_remove
     ·                                      ───────┬───────
     ·                                             ╰── cannot remove any parent directory
 435 │
     ╰────

Expected behavior

i expected either the repo to be removed or at least a nice error

Configuration

Additional context

No response

Describe the bug

when using gm remove empty parent directories are left there untouched.
this could break manual scripts that try to list stuff in the store...

How to reproduce

tk run --clean {
    gm update-cache
    gm clone https://github.com/amtoine/nu-git-manager --depth 1
    gm remove --no-confirm nu-git-manager

    print ($env.GIT_REPOS_HOME | path join "github.com/amtoine" | path exists)
    print ($env.GIT_REPOS_HOME | path join "github.com/amtoine" | ls $in | is-empty)
}

will print

true
true

Expected behavior

i expected gm remove to clean the empty mess and thus the repro snippet above to print false twice.

Configuration

Additional context

No response

really just a question 😌