repolint

repolint

Tool to check github user/organization repositories for some simple and common issues.

Using the collected results

./issues/ directory contains a list of issues found in multiple Github organizations. Every file contains a whole organization analysis.

Here is a list of analyzed organizations (in alphabetical order):

• adobe
• apache
• apple
• autodesk
• CanonicalLtd
• Debian
• dell
• docker
• eclipse
• esri
• freedesktop
• gentoo
• github
• google
• hewlettpackard
• IBM
• intel
• JetBrains
• microsoft
• Netflix
• nvidia
• openshift
• oracle
• sap
• siemens
• spotify
• tdf
• twitter
• vmware
• yandex

Some stats:

Number of checked repositories: 5891.

Overview

repolint makes contributions during events like hacktoberfest simpler for first time contributors and people that are not familiar with open source very well.

One can prepare a list of detected issues and propose them as a tasks to be solved by attendees or ask them to run repolint on their own.

Almost everything that repolint finds can be converted into a pull request that fixes reported issues.

Installation / Usage / Quick start

To get repolint binary, run:

go get -v github.com/Quasilyte/repolint

This assumes that $(go env GOPATH)/bin is under your system $PATH.

You need github auth token to continue.

There are 2 ways to pass token to the repolint:

1. Use environment variable TOKEN.
2. Place token file that contains the token in the current working directory.

Code below runs repolint over all Microsoft organization repositories. Note that it can take a lot of time to complete:

# Suppose your token is `xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx`.
export TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
repolint -v -user=Microsoft

-v flag is used to get more debug output from the repolint. It's optional.

By default, it skips all fork repositories. -skipForks=false will enable forked repositories checks.

What repolint can find

Most issues are very simple and are agnostic to the repository programming language.

• Typos in some common files like readme and contributing guidelines.
• Broken links.
• Committed files that should be removed (like Emacs autosave and backup files).
• Issues in special files like .travis.ci.

Dependencies

CLI / commands

• raviqqe/liche - link checker.
• client9/misspell - spelling checker.

Libs

• src-d/enry - programming language detection.
• gomarkdown/markdown - markdown parser.

Example

For bad-repo it can output something like:

repolint -user=quasilyte -repo=bad-repo
	checking quasilyte/bad-repo (1/1, made 1 requests so far) ...
github.com/quasilyte/bad-repo: readme badge: could add travis-ci build status badge
github.com/quasilyte/bad-repo: sloppy copyright: LICENSE: license contains sloppy copyright
github.com/quasilyte/bad-repo: acronym: README.rst:13: replace sql with SQL
github.com/quasilyte/bad-repo: acronym: README.rst:15: replace gnu with GNU
github.com/quasilyte/bad-repo: misspell: CONTRIBUTING:1:0: "existance" is a misspelling of "existence"
github.com/quasilyte/bad-repo: misspell: CONTRIBUTING.md:1:0: "existance" is a misspelling of "existence"
github.com/quasilyte/bad-repo: misspell: dir/README.md:1:0: "oversimplificiation" is a misspelling of "oversimplification"
github.com/quasilyte/bad-repo: misspell: README.rst:11:0: "excelent" is a misspelling of "excellent"
github.com/quasilyte/bad-repo: var name typo: README.rst:19: $CLASSPAHT could be a misspelling of CLASSPATH
github.com/quasilyte/bad-repo: var name typo: README.rst:20: ${GOPAHT} could be a misspelling of GOPATH
github.com/quasilyte/bad-repo: unwanted file: remove Emacs autosave file: #autosave.txt#
github.com/quasilyte/bad-repo: unwanted file: remove Emacs lock file file: .#lockfile.txt
github.com/quasilyte/bad-repo: unwanted file: remove Mac OS sys file file: .DS_STORE
github.com/quasilyte/bad-repo: unwanted file: remove Vim swap file: .foo.swp
github.com/quasilyte/bad-repo: unwanted file: remove Windows sys file file: Thumbs.db
github.com/quasilyte/bad-repo: unwanted file: remove Emacs backup file: backup.txt~

Note that this example output may be outdated and the bad-repo itself can change over time. It's only a demonstration.

Also note that we're using -repo argument here to restrict repolint to a single user repository.