Merge pull request #49 from unixorn/configure-code-climate-tests

Add .codeclimate.yml

Author: unixorn

.codeclimate.yml

@@ -0,0 +1,55 @@
+---
+engines:
+  pep8:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - "python"
+  fixme:
+    enabled: true
+    exclude_paths:
+      - config/engines.yml
+  pep8:
+    enabled: true
+    checks:
+      E111:
+        enabled: false
+      E501:
+        enabled: false
+  markdownlint:
+    enabled: true
+    checks:
+      MD004:
+        enabled: false
+      MD007:
+        enabled: false
+      MD013:
+        enabled: false
+      MD026:
+        enabled: false
+      MD029:
+        enabled: false
+      MD033:
+        enabled: false
+      MD034:
+        enabled: false
+      MD038:
+        enabled: false
+  shellcheck:
+    enabled: true
+ratings:
+  paths:
+  - "bin/**/*"
+  - "**.py"
+  - "**.md"
+exclude_paths:
+  - .bundle/
+  - benchmarks/**/*
+  - build/
+  - dist/
+  - include/**/*
+  - lib/**/*
+  - License.md
+  - spec/**/*

Contributing.md

@@ -1,8 +1,8 @@
-## Contributing
+# Contributing
 
 **git-extra-commands** is a collection of helper scripts for git and links to git-related articles.
 
-# Contribution Guidelines
+## Contribution Guidelines
 
 - **To add a helper script:** Submit a pull request. Please use `#!/usr/bin/env interpreter` instead of a direct path to the interpreter, this makes it easier for people to use more recent versions when the ones packaged with their OS (macOS and CentOS, I'm looking at you) are stale.
 - **To remove a script:** All of the scripts here were either taken from blog posts or had an Open Source license. That said, if you wrote something included here and want it removed, either open an issue to discuss the removal or submit a pull request.

PULL_REQUEST_TEMPLATE.md

@@ -1,19 +1,23 @@
 <!--- Provide a general summary of your changes in the Title above -->
 
-## Description
+# Description
+
 <!--- Describe your changes in detail -->
 
-## Screenshots (if appropriate):
+# Type of changes
 
-## Type of changes
 <!--- What types of changes does your submission introduce? Put an `x` in all the boxes that apply: -->
+
 - [ ] A helper script
 - [ ] A link to an external resource like a blog post
 
-## Checklist:
+# Checklist:
+
 <!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!--- If you're unsure about any of these, don't hesitate to ask. I'm happy to help! -->
+
 - [ ] All new and existing tests pass.
-- [ ] Any scripts added use `#!/usr/bin/env interpreter` instead of potentially platform-specific direct paths (`#!/bin/sh` is an ok exception)
+- [ ] Any scripts added use `#!/usr/bin/env interpreter` instead of potentially platform-specific direct paths (`#!/bin/sh` is an ok exception)\
+- [ ] Scripts are marked executable
 - [ ] I have confirmed that the link(s) in my PR are valid.
 - [ ] I have read the **CONTRIBUTING** document.

bin/git-change-author

@@ -1,9 +1,9 @@
-#!/bin/sh
+#!/bin/bash
 # Author: Michael Demmer https://github.com/demmer
 # License: MIT
 # Original source: https://github.com/jut-io/git-scripts/blob/master/bin/git-change-author
 
-prog=`basename $0`
+prog=$(basename "$0")
 
 force=
 if [ "$1" == "-f" ] ; then
@@ -28,6 +28,7 @@ export old_email
 export new_author
 export new_email
 
+# shellcheck disable=SC2016,SC2048,SC2086
 git filter-branch $force --env-filter '
 an="$GIT_AUTHOR_NAME"
 am="$GIT_AUTHOR_EMAIL"

bin/git-copy-branch-name

@@ -1,10 +1,10 @@
-#!/bin/sh
+#!/bin/bash
 #
 # Copy the current branch name to the clipboard.
 
 branch=$(git rev-parse --abbrev-ref HEAD)
-echo $branch
+echo "$branch"
 
 if [[ "$(uname -s)" = "Darwin" ]]; then
-  echo $branch | tr -d '\n' | tr -d ' ' | pbcopy
+  echo "$branch" | tr -d '\n' | tr -d ' ' | pbcopy
 fi

bin/git-cut-branch

@@ -10,6 +10,7 @@ set -e
 
 # bail out with message to stderr and exit status 1
 die() {
+    # shellcheck disable=SC2086
     echo "$(basename $0):" "$@" 1>&2
     exit 1
 }
@@ -20,6 +21,7 @@ shortsha() {
 }
 
 # show usage
+# shellcheck disable=SC2166
 [ -z "$1" -o "$1" = "--help" ] && {
     grep '^#/' "$0" |cut -c4-
     exit 2
@@ -44,6 +46,7 @@ remote=$(git config --get "branch.$current.remote" || true)
 merge=$(git config --get "branch.$current.merge" | sed 's@refs/heads/@@')
 
 # build up a sane <remote>/<branch> name
+# shellcheck disable=SC2166
 if [ -n "$remote" -a -n "$merge" ]
 then tracking="$remote/$merge"
 elif [ -n "$merge" ]
@@ -63,5 +66,7 @@ git reset -q --hard "$tracking"
 git checkout -q "$branch"
 git branch --set-upstream "$branch" "$tracking"
 git reset -q --hard "$sha"
+# shellcheck disable=SC2086,SC2046
 echo "[$(shortsha "$sha")...$(shortsha $(git rev-parse $tracking))] $current"
+# shellcheck disable=SC2046
 echo "[0000000...$(shortsha $(git rev-parse HEAD))] $branch"

bin/git-divergence

@@ -6,14 +6,15 @@ set -e
 
 (
     function branch() {
+        # shellcheck disable=SC2063
         git branch 2>/dev/null | grep -e '^*' | tr -d '\* '
     }
 
     function ensure_valid_ref() {
         ref=$1
         (
             set +e
-            git show-ref $ref > /dev/null
+            git show-ref "$ref" > /dev/null
             if [[ $? == 1 ]]; then
                 echo "$0: bad ref: $ref"
                 exit 1
@@ -22,9 +23,10 @@ set -e
     }
 
     function show_rev() {
-        rev=$1
-        git log -1 $rev --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative
+        rev="$1"
+        git log -1 "$rev" --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr) %C(bold blue)<%an>%Creset' --abbrev-commit --date=relative
         echo
+        # shellcheck disable=SC2086
         git diff $rev^..$rev | diffstat
         echo
     }
@@ -33,29 +35,31 @@ set -e
         LOCAL=$1
         REMOTE=$2
     elif [[ $# == 1 ]]; then
-        LOCAL=`branch`
+        LOCAL=$(branch)
         REMOTE=$1
     else
-        LOCAL=`branch`
+        LOCAL=$(branch)
         REMOTE=origin/$LOCAL
     fi
 
-    ensure_valid_ref $LOCAL
-    ensure_valid_ref $REMOTE
+    ensure_valid_ref "$LOCAL"
+    ensure_valid_ref "$REMOTE"
 
     echo "changes from local ${LOCAL} to remote ${REMOTE}:"
     echo
 
     echo incoming:
     echo
-    for rev in `git rev-list $LOCAL..$REMOTE`; do
-        show_rev $rev
+    # shellcheck disable=SC2086
+    for rev in $(git rev-list $LOCAL..$REMOTE); do
+        show_rev "$rev"
     done
 
     echo
     echo outgoing:
     echo
-    for rev in `git rev-list $REMOTE..$LOCAL`; do
-        show_rev $rev
+    # shellcheck disable=SC2086
+    for rev in $(git rev-list $REMOTE..$LOCAL); do
+        show_rev "$rev"
     done
 ) | less -r

bin/git-github-open

@@ -14,6 +14,7 @@
 ## Open current file in vim on line 20:
 ##   :!github-open % 20
 
+# shellcheck disable=SC2002,SC2086
 set -e
 
 FILE="$1"
@@ -34,13 +35,14 @@ die() {
 # figure out relative path to the file from the root
 # of the work tree
 path="$(basename $FILE)"
-cd $(dirname $FILE)
+cd "$(dirname $FILE)"
 while test ! -d .git ;
 do
   test "$(pwd)" = / && {
     echo "error: git repository not found" 1>&2
     exit 1
   }
+  # shellcheck disable=SC2046
   path="$(basename $(pwd))/$path"
   cd ..
 done
@@ -81,4 +83,4 @@ url="http://github.com/$repo/blob/$branch/$path"
 # throw the line number on there if specified
 test -n "$LINE" && url="$url#L$LINE"
 
-open "$url"
+open "$url"

bin/git-incoming-commits

@@ -12,13 +12,14 @@ username="$1"
 if [ -n "$2" ] ; then
   repo="$2"
 else
+  # shellcheck disable=SC2046
   repo=$(basename $(pwd))
 fi
 
 command="git remote add $username git://github.com/$username/$repo.git"
-echo $command
+echo "$command"
 $command
 
 command="git fetch $username"
-echo $command
+echo "$command"
 $command

bin/git-move-commits

@@ -6,9 +6,11 @@
 # moves the last n commits to correct-branch
 # if correct-branch doesn't exist, it creates it
 # if correct-branch does exist, it merges the commits
+# shellcheck disable=SC2046,SC2143,SC2006,SC2086,SC2063
+
 set -e
 
-if [ $1 ]
+if [ "$1" ]
 then
     if [ ! $(echo "$1" | grep -E "^[0-9]+$") ]
     then
@@ -17,7 +19,7 @@ then
         exit 1;
     else
         # The count is 0 based, so to move the last 1 commit, we need HEAD~0
-        NUM_COMMITS=$1
+        NUM_COMMITS="$1"
         ((NUM_COMMITS--))
         echo "num commits $NUM_COMMITS"
     fi