GitSpaces v2 first release

Author: David May

.cobra.yaml

@@ -0,0 +1,3 @@
+author: David May <davfive@gmail.com>
+license: MIT
+useViper: true

.gitignore

@@ -0,0 +1,3 @@
+build
+gitspaces
+__debug*

.golangci.yml

@@ -0,0 +1,12 @@
+linters:
+  disable-all: true
+  enable:
+    - govet
+    - gofmt
+    - revive
+    - staticcheck
+    - errcheck
+    - nilerr
+    - gosec
+
+# Path: .golangci.yml

.vscode/launch.json

@@ -0,0 +1,38 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "gitspaces create",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}",
+            "cwd": "/Users/davidmay/code/davfive/testarea",
+            "args": ["create", "https://github.com/davfive/gitspaces2.git", "-n", "3"],
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "gitspaces switch",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}",
+            "cwd": "/Users/davidmay/code/davfive",
+            "args": ["switch"],
+            "console": "integratedTerminal"
+        },
+        {
+            "name": "gitspaces <empty>",
+            "type": "go",
+            "request": "launch",
+            "mode": "auto",
+            "program": "${workspaceFolder}",
+            "cwd": "/Users/davidmay/code/davfive/testarea",
+            "args": [],
+            "console": "integratedTerminal"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,6 @@
+{
+    "go.lintTool": "golangci-lint",
+    "go.lintFlags": [
+        "[\"--fast\"]"
+    ]
+}

LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2019 David May
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

README.md

@@ -2,133 +2,4 @@
 
 # gitspaces - A git development workspace manager
 
-> NOTE: I am calling all things "scripts". They are actually no scripts at all that are called from the cmdline. They are all bash aliases and functions, but to have one word, I call everything scripts.
-
-## Upcoming Work
-
-- [ ] Convert bash scripts into either python or golang with a light shell wrapper (to support changing directories)
-
-## Overview
-
-GitSpaces is a set of bash scripts for managing git-based development workspaces. The main features are
-
-1. Space management
-   * Multiple spaces
-   * Multiple repositories per space
-   * Space hibernation
-   * Space renaming
-   * Per user, space configuration overrides
-2. Cross-repository branch management
-   * Common Development aids (multi-repo branch sets for ensuring on Development/Production/... branches)
-   * Common (and uncommon) git alias
-   * Directory change aliases (to each repository)
-   * Visual Studio Code  per workspace
-
-## Background
-
-The general idea is that for any given project you might be working on a feature here, a hotfix there, another feature there, 
-and a bugfix somewhere else. You may handle all of these "concurrent" activities by forcing yourself to commit on your branch,
-change branches, or stash stuff. I've found that to be a lot of overhead especially if you are coordinating this across multiple
-repositories in a project.
-
-For those of you with a, ahem, ClearCase background, you're familiar with the concept of ClearCase Views. Essentially it's an
-isolated workspace that has all of your project code where you can work on ONE THING. If you are asked to fix a bug or
-something else concurrently, you just create a new view (they're cheap) and work there. Unfortunately, git has no concept
-like this. Clones are expensive, committing just to context switch is a pain and messes up your commit history to boot.
-
-Gitspaces are essentially a lightweight implementation of ClearCase Views for git projects.
-
-## Command overview
-
-Once gitspaces scripts are available in your environment, all gitspaces commands are prefixed with `gs`. e.g.
-
-Command     | Description
-------------|------------------------
-`gs switch` | Switch to a different top-level gitspace project.
-`gs ls`     | List repository information (e.g., what branch they are on)
-`gs mv`     | Rename a current gitspace
-`gs sleep`  | Archive a gitspace (not using it currently - renames to _.zzz-# and hides from lists)
-`gs cd`     | cd around a gitspaces project. Switch gitspace, repos, folder
-`gs cd -`   | Switch to a different gitspace (allows you wake one up you put to sleep to use fresh)
-`gs co`     | Choose from a list of 'BranchSet's (in gsconfig.ini) and will git pull each repos to it's specified branch
-`gs code`   | Launches Visual Studio Code with .code-workspace file updated with proper paths for debugging
-`gs init`   | _TODO_: Creates project gitspaces.ini, spaces-dir, and first gs space folder (firstspace)
-`gs cp`     | _TODO_: Copies an existing gitspace folder to create another (and puts it to sleep)
-
-
-## Quick Setup
-
-1. Download/Clone gitspaces repo and add it to your .bashrc file
-
-   ```
-   cd ~
-   git clone <repo-path> .gitspaces
-   echo ". ~/.gitspaces/gitspaces.sh" >> ~/.bashrc
-   cp ~/.gitspaces/userfiles/.gitspacesrc.sh  ~/
-   perl -pi -e "s/^#alias/alias/ ~/.gitspacesrc.sh  # aliases gs=gitspaces, cds='gs cd'
-   . ~/.bashrc
-   ```
-   
-2. Create a code project folder (will house projectA's gitspaces)
-
-   ```
-   mkdir -p ~/code/projectA
-   ```
-
-3. Setup a GitSpaces project folder
-   > Future: this is what 'gs init' will do
-   ```
-   cd ~/code/projectA
-   cp ~/.gitspaces/userfiles/gitspaces.ini .        # See file comments for details
-   mkdir $GITSPACES_SPACESDIR  # defaults to '_'    # Where all of your project spaces will live
-   mkdir -p $GITSPACES_SPACESDIR/firstspace         # First project space, you can rename it later
-   cd $GITSPACES_SPACESDIR/firstspace
-
-   # A GitSpaces project folder has the following structure:
-   ~/code/projectA/
-    |- gitspaces.ini
-    |- _/
-       +- space-1/
-          +- projectA-repo-1
-          ...
-          +- projectA-repo-N
-       ...
-       +- space-N/
-          +- projectA-repo-1
-          ...
-          +- projectA-repo-N
-   ```
-
-4. Clone all of your repositories into the \_.first gitspace folder
-
-   ```
-   cd ~/code/projectA/_/firstspace
-   git clone <projectA-repo1>
-   ...
-   git clone <projectA-repoN>
-   ```
-   
-5. Create additional GitSpaces for projectA
-   > Simply 'cp -R firstspace secondspace' (way faster usually than re-cloning)  
-   > Note the copy operation is way quicker if you clean your firstspace repos' (git clean -dx -f)  
-   ```
-   cd ~/code/projectA
-   cp -R firstspace secondspace
-   ...
-   cp -R firstspace nthspace
-   ```
-  
-   You can add a new gitspace folder anytime you want when you need more. I've generally found that 5 are sufficient.
-
-6. Add your new GitSpaces project to GITSPACES_PROJDIRS in ~/.gitspacesrc.sh and resource
-
-7. Start using GitSpaces
-
-8. Optional: Include ~/.gitspaces/userfiles/gitconfig
-
-   My common git aliases are in the userfiles folder. Just add the following to your ~/.gitconfig
-   
-   ```
-   [include]
-   path = ~/.gitspaces/userfiles/gitconfig
-   ```
+TODO update docs for v2 (golang, simplified, edition)

cmd/code.go

@@ -0,0 +1,30 @@
+package cmd
+
+import (
+	"gitspaces/internal/console"
+	"gitspaces/internal/gitspaces"
+
+	"github.com/spf13/cobra"
+)
+
+// codeCmd represents the code command
+var codeCmd = &cobra.Command{
+	Use:   "code",
+	Short: "Open space as a workspace in Visual Studio Code",
+	Args:  cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		space, err := gitspaces.GetSpace()
+		if err != nil {
+			return err
+		}
+
+		if err = space.OpenVSCode(); err != nil {
+			return console.Errorln("Failed to open Visual Studio Code: %s", err)
+		}
+		return nil
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(codeCmd)
+}

cmd/create.go

@@ -0,0 +1,53 @@
+package cmd
+
+import (
+	"fmt"
+
+	"gitspaces/internal/console"
+	"gitspaces/internal/gitspaces"
+	"gitspaces/internal/helper"
+
+	"github.com/spf13/cobra"
+)
+
+// createCmd represents the create command
+var createCmd = &cobra.Command{
+	Use:   "create [flags] URL [DIR]",
+	Short: "Creates a GitSpace from the provided repo url",
+	Long:  "Creates a GitSpace from the provided repo url.",
+	Args: func(cmd *cobra.Command, args []string) error {
+		if len(args) < 1 {
+			return fmt.Errorf("requires a URL argument")
+		}
+		if len(args) > 2 {
+			return fmt.Errorf("unexpected positional arguments after URL [DIR]")
+		}
+		return nil
+	},
+	RunE: func(cmd *cobra.Command, args []string) (err error) {
+		url := args[0]
+		dir := helper.GetStringAtIndex(args, 1, "")
+		numClones, _ := cmd.Flags().GetInt("num_clones")
+
+		var project *gitspaces.ProjectStruct
+		var space *gitspaces.SpaceStruct
+
+		if project, err = gitspaces.CreateProject(url, dir, numClones); err != nil {
+			return err
+		}
+
+		if space, err = project.WakeupSpace(); err != nil {
+			return err
+		}
+
+		console.Println("\nCreated GitSpace at '%s' with %d clones", project.Path, numClones)
+
+		gitspaces.User.WriteCdToPath(space.Path)
+		return nil
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(createCmd)
+	createCmd.Flags().IntP("num_clones", "n", 3, "Number of sleeper clones to create")
+}

cmd/rename.go

@@ -0,0 +1,35 @@
+/*
+Copyright © 2024 NAME HERE <EMAIL ADDRESS>
+*/
+package cmd
+
+import (
+	"gitspaces/internal/console"
+	"gitspaces/internal/gitspaces"
+
+	"github.com/spf13/cobra"
+)
+
+// renameCmd represents the rename command
+var renameCmd = &cobra.Command{
+	Use:   "rename",
+	Short: "Rename the current space",
+	Long:  `Rename the current space`,
+	RunE: func(cmd *cobra.Command, args []string) (err error) {
+		space, err := gitspaces.GetSpace()
+		if err != nil {
+			return err
+		}
+
+		if err = space.Rename(); err != nil {
+			return console.Errorln("Failed to rename space: %s", err)
+		}
+
+		gitspaces.User.WriteCdToPath(space.Path)
+		return nil
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(renameCmd)
+}