Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doggy8088/git-setup
A Quick Git Setup Tool ( npx @willh/git-setup )
https://github.com/doggy8088/git-setup
Last synced: 11 days ago
JSON representation
A Quick Git Setup Tool ( npx @willh/git-setup )
- Host: GitHub
- URL: https://github.com/doggy8088/git-setup
- Owner: doggy8088
- License: mit
- Created: 2020-02-08T12:06:51.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-10T08:20:05.000Z (6 months ago)
- Last Synced: 2024-09-14T22:45:20.879Z (about 2 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@willh/git-setup
- Size: 18.6 KB
- Stars: 61
- Watchers: 5
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# git-setup
本工具會全自動設定 Git 版控環境，並且跨平台支援 Windows, Linux, macOS 等作業系統的命令列環境，尤其針對中文環境經常會出現亂碼的問題都會完美的解決。
## 先決條件
- [Node.js](https://nodejs.org/en/) 10.13.0 以上版本
- [Git](https://git-scm.com/) 任意版本 (建議升級到最新版)
## 使用方式
```sh
npx @willh/git-setup
```
- 設定過程會詢問你的 `user.name` 與 `user.email` 資訊
- Email 會進行格式驗證，格式錯誤會拒絕設定下去
- 所有 Git 設定都會以 `--global` 為主 (`~/.gitconfig`)
- Windows 平台會自動設定 `LC_ALL` 與 `LANG` 使用者環境變數
- Linux, macOS 平台會提醒進行設定
## 設定內容
若為 Windows 平台，請記得使用 Command Prompt 執行以下命令，並跳過 Linux/macOS 專屬的命令。
```sh
git config --global user.name ${name}
git config --global user.email ${email}
# 設定打錯命令時 3 秒內會自動做出判斷
git config --global help.autocorrect 30
# 現在大多編輯器都已經能正確處理 CRLF 字元，不再需要自動轉換了！
git config --global core.autocrlf false
# 為了能正確顯示 UTF-8 中文字
git config --global core.quotepath false
# 在命令列環境下自動標示顏色
git config --global color.diff auto
git config --global color.status auto
git config --global color.branch auto
# 常用的 Git Alias 命令
git config --global alias.ci commit
git config --global alias.cm "commit --amend -C HEAD"
git config --global alias.co checkout
git config --global alias.st status
git config --global alias.sts "status -s"
git config --global alias.br branch
git config --global alias.re remote
git config --global alias.di diff
git config --global alias.type "cat-file -t"
git config --global alias.dump "cat-file -p"
git config --global alias.lo "log --oneline"
git config --global alias.ls "log --show-signature"
git config --global alias.ll "log --pretty=format:'%h %ad | %s%d [%Cgreen%an%Creset]' --graph --date=short"
git config --global alias.lg "log --graph --pretty=format:'%Cred%h%Creset %ad |%C(yellow)%d%Creset %s %Cgreen(%cr)%Creset [%Cgreen%an%Creset]' --abbrev-commit --date=short"
git config --global alias.alias "config --get-regexp ^alias\."
# 必須是 Windows 平台才會執行以下設定
git config --global alias.ignore "!gi() { curl -sL https://www.gitignore.io/api/$@ ;}; gi"
git config --global alias.iac "!giac() { git init -b main && git add . && git commit -m 'Initial commit' ;}; giac"
git config --global alias.acp "!gacp() { git add . && git commit --amend -C HEAD && git push -f ;}; gacp"
git config --global alias.cc "!grcc() { git reset --hard && git clean -fdx ;}; read -p 'Do you want to run the <<< git reset --hard && git clean -fdx >>> command? (Y/N) ' answer && [[ $answer == [Yy] ]] && grcc"
# 必須是 Linux/macOS 平台才會執行以下設定
git config --global alias.ignore '!'"gi() { curl -sL https://www.gitignore.io/api/\$@ ;}; gi"
git config --global alias.iac '!'"giac() { git init -b main && git add . && git commit -m 'Initial commit' ;}; giac"
git config --global alias.acp '!'"gacp() { git add . && git commit --amend -C HEAD && git push -f ;}; gacp"
git config --global alias.cc '!'"grcc() { git reset --hard && git clean -fdx ;}; read -p 'Do you want to run the <<< git reset --hard && git clean -fdx >>> command? (Y/N) ' answer && [[ $answer == [Yy] ]] && grcc"
# 必須是 Windows 平台且有安裝 TortoiseGit 才會設定 tlog 這個 alias
git config --global alias.tlog "!start 'C:\\PROGRA~1\\TortoiseGit\\bin\\TortoiseGitProc.exe' /command:log /path:."
# 必須是 Windows 平台才會將預設編輯器設定為 notepad
git config --global core.editor notepad
```
## 其他調整建議
1. `core.editor`
在選擇 `git commit` 所使用的文字編輯器時，每個人都有不同的偏好，但是 Git 預設的 `vim` 應該是大多數人不熟悉的，所以這個工具的預設會選擇 `notepad` (記事本) 為主要編輯器，這是因為在 Windows 作業系統上，這是唯一所有人都有的應用程式，不需要額外安裝。
如果你想調整用 Visual Studio Code 作為預設編輯器，可以執行以下指令：
```sh
git config --global core.editor "code --wait"
```
如果習慣用 Visual Studio Code Insider 版本，可以執行以下指令：
```sh
git config --global core.editor "code-insiders --wait"
```
2. `core.autocrlf`
在 Windows 平台上安裝 Git 時，預設 `core.autocrlf` 設定值為 `true`，而本工具則設定為 `false` 為主。
在 Windows 平台上，Git 預設會將檔案的換行符號 `LF` 字元轉換成 `CRLF` 字元，這是因為 Windows 作業系統的檔案換行符號是 `CRLF` 字元，但是在 Linux 與 macOS 作業系統上，檔案換行符號是 `LF` 字元。
由於現在 Windows 大多數的編輯器都已經能正確處理 `LF` 字元，不再需要自動轉換了。如果你所參與的專案，同時有 Windows 與 macOS 開發人員，我也建議設定為 `false` 以避免發生詭異的問題。
如果想調整回預設值，可以執行以下指令：
```sh
git config --global core.autocrlf true
```
3. `pull.rebase`
在 `git pull` 時，預設會使用 `merge` 的方式合併分支，但是有些人習慣使用 `rebase` 的方式合併分支，這樣可以讓歷史紀錄更加乾淨，不會有多餘的合併紀錄。
如果你想調整為 `rebase` 的方式，可以執行以下指令：
```sh
git config --global pull.rebase true
```
## 提供建議
如果您對本工具有任何想法，歡迎到[這裡](https://github.com/doggy8088/git-setup/issues)留言討論！
## 作者資訊
- **Will 保哥**
- 部落格：https://blog.miniasp.com/
- 粉絲團：https://www.facebook.com/will.fans
- 實體課程：https://coolrare.accupass.com/
- 線上課程：https://www.udemy.com/user/coolrare (可私訊粉絲團索取優惠券代碼)
## 相關連結
- [2.7 Git 基礎 - Git Aliases](https://git-scm.com/book/zh-tw/v2/Git-%E5%9F%BA%E7%A4%8E-Git-Aliases)
- [Creating CLI Executable global npm module](https://medium.com/@thatisuday/creating-cli-executable-global-npm-module-5ef734febe32)