This repo is about, yeah you guessed it right, Git & GitHub. I will be exposing most of the magic spells that I have learned and the magic wands that I use regularly.
Found this Helpful?
Show some support to help improve this repo and expose more magic spells!
- 1. Magic Wands
- 2. Avada Kedavra
- 3. Reparo
- 4. Expecto Patronum
- 5. Obliviate
- 6. Riddikulus
- 7. Markdown Beautifio
- 8. The THANK YOU Spell ❤️
Magic Wands are the tools and the extensions that you can use to improve your workflow and magic skills.
- hub: A command-line tool that makes git easier to use with GitHub.
- git-sizer: Compute various size metrics for a Git repository, flagging those that might cause problems.
- git-quick-stats: A simple and efficient way to access various statistics in git repository.
- GitHub-Dark + Overlay-Scrollbars: Dark GitHub style.
- octolinker: Allow navigation through code on GitHub more efficiently.
- github-repo-size: Display repository size on GitHub.
- git-history-browser-extension: Add a button to the github file interface to see its history.
- github-file-icon: Gives different filetypes different icons in GitHub.
- GitLens: Supercharges the Git capabilities built into Visual Studio Code.
- Git Blame: See git blame information in the status bar.
- Git Graph: View a Git Graph of your repository, and easily perform Git actions from the graph.
- Code Spell Checker: A basic spell checker that works well with camelCase code. No more "Fix Typo" commits.
- Markdown Preview Github Styling: Changes VS Code's built-in markdown preview to match Github's style.
- Markdown TOC: Markdown TOC (Table Of Contents) Plugin for Visual Studio Code.
- markdownlint: Markdown linting and style checking for Visual Studio Code.
No matter how many wands you use, keeping your primary wand up-to-date is still your duty.
-
First, check your git version
git --version
-
Then use only one of the following commands according to your git version
git update # version between 2.14.2 and 2.16.1 git update-git-for-windows # version is equal to greater Git 2.16.1(2)
Avada Kedavra is your magic spell to get rid of all the dead branches and files.
Casting spells for the first time isn't that safe, so you have to see which files will be deleted before you run the actual command.
git clean -nThen when you are comfortable use the -f or -fd option.
git clean -f # Cleans files only without cleaning directories
git clean -fd # Cleans files & directoriesYour repo is getting messy, a lot of branches that you no longer need. No need to worry, a simple magic spell can get most of the work done for you.
git branch | grep -v 'master' | xargs git branch -DYou can replace master with any other branch name that you want to keep, but be careful this will delete master.
Or even use a pattern of more than one branch to keep them and delete the rest.
git branch | grep -v 'master\|gh-pages' | xargs git branch -DDeleting local branches doesn't clean the repo 100%, since they were tracking remote branches, so you will need to burn all those references to the ground. (This will only work if you've already deleted the remote branch from your GitHub repo)
git fetch --pruneDeleting a commit is somehow dangerous, since the SHA of all following commits will change. Please be careful using this!
git rebase --onto <commit-SHA>^ <commit-SHA>Sometimes you need to rollback to a clean working directory without losing your changes, so you stash them away using the stash command. But it always can get messy; as this command stashes away the dirty changes in the stash list (more of a stack actually), So after a few stashes you're gonna end up with an outstretched list of stashes.
git stash listYou can always clean the whole stash list using a single a simple magic spell
git stash clearOr you can remove one stash entry at a time using another magic spell
git stash dropCAUTION!: Those stash entries will then be subject to pruning, and may be impossible to recover
Reapro is a spell that help you fixing your repository history.
CAUTION!: Remember that those spells rewrite history, every commit included in the range will be rewritten. Don’t include any commit you’ve already pushed to a central server — doing so will confuse other developers by providing an alternate version of the same change
Whenever you use git rebase, the CommitDate and SHA are updated to current date.
[Before rebase] | [After rebase]
|
commit e7ee3464aa3c133df6f5ee622be863bc855dc8fd | commit eda7945c8d944e78d226b13a5c7280977f65a8c6
Author: Youssef Raafat <...> | Author: Youssef Raafat <...>
AuthorDate: Sun Jun 30 02:05:07 2019 +0200 | AuthorDate: Sun Jun 30 02:05:07 2019 +0200
Commit: Youssef Raafat <...> | Commit: Youssef Raafat <...>
CommitDate: Sun Jun 30 02:05:07 2019 +0200 | CommitDate: Mon Jul 1 02:06:20 2019 +0200
|
Added New Feature | Added New Feature
|To avoid this from happening, use the --committer-date-is-author-date. But be careful that this option doesn't work with both -i and --root.
git rebase --committer-date-is-author-dateLet's say we have about 10 commits that the CommitDate is not the same as the AuthorDate and we want them to be the same.
git rebase <first-bad-commit-SHA>^ --committer-date-is-author-dateTip: Use
git log --format=fullerto see bothCommitDate&AuthorDate.
You made a commit 2 days ago, and God knows for whatever reason you want to change that date to be today's or another date. Don't freak out, this is possible!
-
Rebase to before said commit and stop for amendment.
git rebase -i <commit-SHA>^
-
Replace
pickwithediton the line with that required commit (the first line usually). -
Use one of the following commands depending on your needs.
# [1] Use today's date: GIT_COMMITTER_DATE="$(date)" git commit --amend --no-edit --date "$(date)" # [2] Use custom date: GIT_COMMITTER_DATE="Mon Jul 1 02:06:20 2019 +0200" git commit --amend --no-edit --date "Mon Jul 1 02:06:20 2019 +0200"
Expecto Patronum is a spell for summoning stuff to help you and ease your life.
Too lazy to copy and paste or download your .gitignore file each time you create a new repository? Try out this simple spell.
curl -s https://www.gitignore.io/api/{your_list} >> .gitignoreReplace {your_list} with a comma-separated-list (one or more) of Operating System or IDE or Programming Language, here are some examples:
https://www.gitignore.io/api/windowshttps://www.gitignore.io/api/visualstudiohttps://www.gitignore.io/api/c++https://www.gitignore.io/api/linux,intellij,java
GitHub has Download as .zip option in all hosted repositories, but is it possible to achieve the same result using only your git bash? Surely it's, maybe that's why we wrote this spell and your are reading it now.
git archive master --output=master.zipFinding bugs in long git histories isn't that easy, but by summoning a Patronus to help you hunting them and discover when you introduced a bug in your code, it will be much easier.
-
To start the binary search process, you will need to checkout to your latest commit first, then provide git with 2 commits to search for the bug within, the last good commit and the commit that first introduced the bug
git checkout <your-branch-name> git bisect start git bisect good <SHA-for-good-commit> git bisect bad <SHA-for-bad-commit>
-
Git will ask for your feedback on some commits, so you will need to tell it if the commit is good or bad, use one of the following commands to do so:
git bisect good git bisect bad
-
When done, Git will guide you to bugged commit. You will need to exit the binary search process afterwards by using the following command:
git bisect reset
Obliviate is a spell used to wipe memories, to forget about things, like old git histories, and start fresh.
Orphan branches aren't based on any other branches.The first commit made on this new orphan branch will have no parents and it will be the root of a new history totally disconnected from all the other branches and commits.
If you are using GitHub Pages this might be helpful as you can create a new branch named gh-pages. This branch is “orphaned” and therefore completely separate from your repository’s prior history.
|
i---j---k <== branch 'feature-1' |
/ | a---b---c---d <== branch 'master'
a---b---c---d---h---l <== branch 'master' |
\ / | 1---2---3---4 <== branch 'gh-pages' (orphan)
e---f---g <== branch 'feature-2' |
|
[Normal Branches] | [Orphan Branch]
To create a new empty orphan branch, use the following commands
git checkout --orphan <new-branch-name>
rm .git/index
git clean -fdxFor whatever reason, one day, you committed a file containing some Passwords and Credentials and some large video files. Seriously dude? What was going on your mind when you did this? But don't worry, there's a great tool called BFG that will help you remove Crazy Big Files, Passwords, Credentials & other Private data out of your Git repository history.
- Download Java Runtime Environment (Java 8 or above).
- Download BFG from official site.
- Determine the files you want to remove: Use specific names (
Passwords.txt) or wildcards (*.mp4). - Clone a fresh copy of
{your_big_repo}, using the --mirror flag:
git clone --mirror https://github.com/{your_big_repo}.git - Run BFG to clean your repository up:
java -jar bfg-1.13.0.jar --delete-files "{Passwords.txt,*.mp4}" {your_big_repo}.git - Strip out the unwanted dirty data then push:
cd {your_big_repo}.git git reflog expire --expire=now --all && git gc --prune=now --aggressive git push
* For better explanation read Usage from the official site.
Riddikulus is used to transforms nasty git repositories from something scary as complicated long histories into something silly as numbers, lists, insights and statistics.
Let's say you want to count how many lambda expressions (->) you've used in all .java files, a quick spell can count it for you in the blink of an eye.
git grep '\->' '*.java' | wc -lYou've been committing for so long now, maybe it's time to know how many commits are out there now.
git rev-list --count <branch-name> # One branch
git rev-list --count --all # All branchesCuriosity is an enough reason to know loc.
git ls-files | xargs wc -l # Detailed
git ls-files | xargs cat | wc -l # TotalYou have been working on multiple features, and now you wanna know how many lines you have touched. It's fine spells got your back.
Note: Add --staged if your changes were staged.
git diff --stat # Detailed
git diff --shortstat # TotalExporting your repository log to a file might be helpful sometimes, just learn this spell until the time comes and you need it.
-
Text File
git log > log.txt -
JSON File (refer to pretty-formats for more placeholders)
git log --pretty=format:'{ "commit": "%H", "subject": "%s", "body": "%b", "author": { "name": "%aN", "email": "%aE", "date": "%aD" } },' > log.json
You wanna make sure that your .gitignore is working fine and that all files that you want to ignore are really ignored. Here's a quick spell for you.
git ls-files --others --ignored --exclude-standardKeeping track of your repository size is something that you need to learn, this spell might be helpful if you managed to do so.
git rev-list --objects --all \
| git cat-file --batch-check='%(objecttype) %(objectname) %(objectsize) %(rest)' \
| sed -n 's/^blob //p' \
| sort --numeric-sort --key=2 \
| cut -c 1-12,41- \
| $(command -v gnumfmt || echo numfmt) --field=2 --to=iec-i --suffix=B --padding=7 --round=nearestSome spells that you can use on GitHub to add a bit of "beautifulness" to your markdown files.
Writing key strokes as plain text is the unforgivable sin that we are trying to void here using this spell.
Press the following to save: <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>s</kbd>Press the following to save: ctrl + shift + s
Mathematicians are somehow wizards too, they need to write their equations and formulas.
CodeCogs provides a good solution for embedding mathematics equations as images in markdown files, like the following equation.
- Write your equation in the Equation Editor.
- Edit Image type, font, and size.
- Choose URL (encoded) from the combobox at the end of the page.
- Use the copied URL in a markdown image as follows:
Adding icons to markdown files isn't that hard, you can use any of those two providers to help you:
-
- Supports Font Awesome, Ionicons & Glyphicons.
- Customizable size, foreground color & background color.
- Can be written in markdown or HTML syntax.
- Lower quality.
-
- Supports SVG icons for popular brands only.
- Black color only.
- HTML syntax only.
- Higher quality.
<img alt="simple-icons" width="80" src="https://cdn.jsdelivr.net/npm/simple-icons@latest/icons/github.svg" />
contributors-img provides a good way for adding a good looking image of your contributors in your markdown file.
[![Contributors][contributors-img]][contributors]
[contributors]: https://github.com/USERNAME/REPONAME/graphs/contributors
[contributors-img]: https://contributors-img.firebaseapp.com/image?repo=USERNAME/REPONAMEKeep the less useful content collapsed, no one needs to see it!
<details>
<summary><b>Example</b></summary>
<br/>
1. Remove the `<b>` & `<br/>` tags if you want, it's fine.
1. Don't forget to surround the body with blank lines.
1. Supports **Markdown** _Syntax_. Including Images.
</details>Example
- Remove the
<b>&<br/>tags if you want, it's fine. - Don't forget to surround the body with blank lines.
- Supports Markdown Syntax. Including Images.
A wise wizard once said "Just add more badges!".
Maybe that's why they created shields.io.
Some photos are meaningless without captions, but wizards know how to handle that!
<div align="center">
<img src="https://imgplaceholder.com/480x200/992c2c/ffffff?text=Git+for+Wizards&font-family=OpenSans_Bold" />
<br/>
<sub><sup>© 2019, licensed under the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</sup></sub>
</div>This will be enough as a start to add a cool header for your README file, but try to be more creative.
<div align="center">
<img src="https://imgplaceholder.com/100x100/transparent/323232/ion-ios-color-wand?font-size=100" />
<h3>Git for Wizards</h3>
<strong>Some magic spells and wands for Git & GitHub</strong>
</div>- BFG Repo-cleaner
- Change the date of a git commit
- How to discover a bug using git bisect?
- How to find/identify large commits in git history?
- Orphaned Branches in Git
You've done it all. You are FREE now!
* Please don't forget to turn off the lights on your way out.
© 2019 git-for-wizards, licensed under the MIT License.