git-improved 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e11e5f761930d6144256491b8a70969fc476a3f69a46279b5cd3bc202d5a5fb0
+  data.tar.gz: d921d52ba6e620b61c1c0e8d2258dd386025b865a1c97a854c672aeb9df3a2af
+SHA512:
+  metadata.gz: 9ac92a732673c69a58c50c2d5036b3f9e0ca76bcf0e47af8d2d1324386e88ffc1c58a28a7e14c89297babd26823c5eeff16a69174d2f1b9b85dc5f2620e1713b
+  data.tar.gz: e86c62fcf12164acbc3b3fc97ffd16965f851217a28a3c9a9e5f7d265c524a79a1f827f25d61df19c306967e98e816571e0a7d0689c2a9d4a638a4c775fa5352

data/CHANGES.md

@@ -0,0 +1,8 @@
+ChangeLog
+=========
+
+
+Release 0.1.0 (2023-11-26)
+--------------------------
+
+* First public release.

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 kwatch@gmail.com
+
+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.

data/README.md

@@ -0,0 +1,307 @@
+# GitImproved
+
+
+## What's This?
+
+GitImproved is a wrapper script for Git command.
+It provides a much better interface than Git.
+
+* Intuitive
+* Easy to understand
+* Fewer commands
+
+Links:
+
+* Document: <https://kwatch.github.io/git-improved/>
+* GitHub: <https://github.com/kwatch/git-improved>
+* Changes: <https://github.com/kwatch/git-improved/CHANGES.md>
+
+
+### Table of Contents
+
+<!-- TOC -->
+
+* [What's This?](#whats-this)
+* [Install](#install)
+* [Quick Example](#quick-example)
+* [Actions](#actions)
+  * [Branch](#branch)
+  * [Commit](#commit)
+  * [Config](#config)
+  * [File](#file)
+  * [Help](#help)
+  * [History](#history)
+  * [Misc](#misc)
+  * [Repo](#repo)
+  * [Staging](#staging)
+  * [Stash](#stash)
+  * [Status](#status)
+  * [Sync](#sync)
+  * [Tag](#tag)
+* [Aliases](#aliases)
+* [License and Copyright](#license-and-copyright)
+
+<!-- /TOC -->
+
+
+## Install
+
+GitImproved requires Ruby >= 2.3.
+
+```console
+$ gem install git-improved
+$ gi --version
+1.0.0
+```
+
+
+## Quick Example
+
+```console
+## help
+$ gi -h | less                # help message
+$ gi -l | less                # list actions
+$ gi -h commit:create         # help of an action
+
+## create a repo
+$ mkdir mysample              # or: gi repo:clone github:<user>/<repo>
+$ cd mysample
+$ gi repo:init -u yourname -e yourname@gmail.com
+
+## add files
+$ vi README.md                # create a new file
+$ gi track README.md          # register files into the repository
+$ gi                          # show current status
+$ gi cc "add README file"     # commit changes
+
+## edit files
+$ vi README.md                # update an existing file
+$ gi stage .                  # add changes into staging area
+$ gi                          # show current status
+$ gi staged                   # show changes in staging area
+$ gi cc "update README file"  # commit changes
+
+## upload changes
+$ gi repo:remote:seturl github:yourname/mysample
+$ gi push                     # upload local commits to remote repo
+```
+
+
+## Actions
+
+
+### Branch
+
+```
+branch:checkout     : create a new local branch from a remote branch
+branch:create       : create a new branch, not switch to it
+                      (alias: branch)
+branch:current      : show current branch name
+branch:delete       : delete a branch
+branch:echo         : print CURR/PREV/PARENT branch name
+branch:fork         : create a new branch and switch to it
+                      (alias: fork)
+branch:join         : merge current branch into previous or other branch
+                      (alias: join)
+branch:list         : list branches
+                      (alias: branches)
+branch:merge        : merge previous or other branch into current branch
+                      (alias: merge)
+branch:parent       : show parent branch name (EXPERIMENTAL)
+branch:previous     : show previous branch name
+branch:rebase       : rebase (move) current branch on top of other branch
+branch:rename       : rename the current branch to other name
+branch:reset        : change commit-id of current HEAD
+branch:switch       : switch to previous or other branch
+                      (alias: sw, switch)
+branch:update       : git pull && git stash && git rebase && git stash pop
+                      (alias: update)
+branch:upstream     : print upstream repo name of current branch
+```
+
+
+### Commit
+
+```
+commit:apply        : apply a commit to curr branch (known as 'cherry-pick')
+commit:correct      : correct the last commit
+                      (alias: correct)
+commit:create       : create a new commit
+                      (alias: cc, commit)
+commit:fixup        : correct the previous commit
+                      (alias: fixup)
+commit:revert       : create a new commit which reverts the target commit
+commit:rollback     : cancel recent commits up to the target commit-id
+commit:show         : show commits in current branch
+                      (alias: commits)
+```
+
+
+### Config
+
+```
+config              : list/get/set/delete config values
+config:alias        : list/get/set/delete aliases of 'git' (not of 'gi')
+config:setuser      : set user name and email
+```
+
+
+### File
+
+```
+file:blame          : print commit-id, author, and timestap of each line
+file:changes        : show changes of files
+                      (alias: changes)
+file:delete         : delete files or directories
+file:egrep          : find by pattern
+file:list           : list (un)tracked/ignored/missing files
+                      (alias: files)
+file:move           : move files into a directory
+file:rename         : rename a file or directory to new name
+file:restore        : restore files (= clear changes)
+file:track          : register files into the repository
+                      (alias: register, track)
+```
+
+
+### Help
+
+```
+help                : print help message (of action if specified)
+```
+
+
+### History
+
+```
+history             : show commit history in various format
+                      (alias: hist (with '-F graph'))
+history:edit:cancel : cancel (or abort) `git rebase -i`
+history:edit:resume : resume (= conitnue) suspended `git rebase -i`
+history:edit:skip   : skip current commit and resume
+history:edit:start  : start `git rebase -i` to edit commit history
+                      (alias: histedit)
+history:notuploaded : show commits not uploaded yet
+```
+
+
+### Misc
+
+```
+misc:initfile       : generate a init file, or print to stdout if no args
+```
+
+
+### Repo
+
+```
+repo:clone          : copy a repository ('github:<user>/<repo>' is available)
+repo:create         : create a new directory and initialize it as a git repo
+repo:init           : initialize git repository with empty initial commit
+repo:remote         : list/get/set/delete remote repository
+repo:remote:origin  : get/set/delete origin (= default remote repository)
+```
+
+
+### Staging
+
+```
+staging:add         : add changes of files into staging area
+                      (alias: pick (with '-p'), stage)
+staging:clear       : delete all changes in staging area
+                      (alias: unstage)
+staging:edit        : edit changes in staging area
+staging:show        : show changes in staging area
+                      (alias: staged)
+```
+
+
+### Stash
+
+```
+stash:drop          : delete latest changes from stash
+stash:list          : list stash history
+stash:pop           : restore latest changes from stash
+stash:put           : save current changes into stash
+stash:show          : show changes on stash
+```
+
+
+### Status
+
+```
+status:compact      : show status in compact format
+                      (alias: status)
+status:default      : show status in default format
+status:here         : same as 'stats:compact .'
+status:info         : show various infomation of current status
+```
+
+
+### Sync
+
+```
+sync:both           : download and upload commits
+                      (alias: sync)
+sync:pull           : download commits from remote and apply them to local
+                      (alias: dl, download, pull)
+sync:push           : upload commits to remote
+                      (alias: push, up, upload)
+```
+
+
+### Tag
+
+```
+tag                 : list/show/create/delete tags
+tag:create          : create a new tag
+tag:delete          : delete a tag
+tag:download        : download tags
+tag:list            : list tags
+                      (alias: tags)
+tag:upload          : upload tags
+```
+
+
+## Aliases
+
+```
+branch              : alias for 'branch:create'
+fork                : alias for 'branch:fork'
+join                : alias for 'branch:join'
+branches            : alias for 'branch:list'
+merge               : alias for 'branch:merge'
+sw                  : alias for 'branch:switch'
+switch              : alias for 'branch:switch'
+update              : alias for 'branch:update'
+correct             : alias for 'commit:correct'
+cc                  : alias for 'commit:create'
+commit              : alias for 'commit:create'
+fixup               : alias for 'commit:fixup'
+commits             : alias for 'commit:show'
+changes             : alias for 'file:changes'
+files               : alias for 'file:list'
+register            : alias for 'file:track'
+track               : alias for 'file:track'
+hist                : alias for 'history -F graph'
+histedit            : alias for 'history:edit:start'
+pick                : alias for 'staging:add -p'
+stage               : alias for 'staging:add'
+unstage             : alias for 'staging:clear'
+staged              : alias for 'staging:show'
+status              : alias for 'status:compact'
+sync                : alias for 'sync:both'
+dl                  : alias for 'sync:pull'
+download            : alias for 'sync:pull'
+pull                : alias for 'sync:pull'
+push                : alias for 'sync:push'
+up                  : alias for 'sync:push'
+upload              : alias for 'sync:push'
+tags                : alias for 'tag:list'
+```
+
+
+## License and Copyright
+
+* $License: MIT License $
+* $Copyright: copyright(c) 2023 kwatch@gmail.com $

data/bin/gi

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+# frozen_string_literal: true
+
+require 'git-improved'
+
+exit GitImproved.main()

data/git-improved.gemspec

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+Gem::Specification.new do |spec|
+  spec.name            = "git-improved"
+  spec.version         = "$Release: 0.1.0 $".split()[1]
+  spec.author          = "kwatch"
+  spec.email           = "kwatch@gmail.com"
+  spec.platform        = Gem::Platform::RUBY
+  spec.homepage        = "https://kwatch.github.io/git-improved/"
+  spec.summary         = "Improved interface for Git command"
+  spec.description     = <<-"END"
+Git-Improved is a wrapper script for Git command.
+It provides much better interface than Git.
+
+See #{spec.homepage} for details.
+END
+  spec.license         = "MIT"
+  spec.files           = Dir[
+                           "README.md", "MIT-LICENSE", "CHANGES.md",
+                           "#{spec.name}.gemspec",
+                           "lib/**/*.rb", "test/**/*.rb", "bin/*",
+                          #"doc/*.html", "doc/css/*.css",
+                         ]
+  spec.executables     = ["gi"]
+  spec.bindir          = "bin"
+  spec.require_path    = "lib"
+  spec.test_files      = Dir["test/**/*_test.rb"]   # or: ["test/run_all.rb"]
+  #spec.extra_rdoc_files = ["README.md", "CHANGES.md"]
+
+  spec.required_ruby_version = ">= 2.3"
+  spec.add_runtime_dependency     "benry-cmdapp"      , "~> 1"
+  spec.add_runtime_dependency     "benry-unixcommand" , "~> 1"
+  spec.add_development_dependency "oktest"            , "~> 1"
+end