f5baed87e6
added cli documentation to README |
||
---|---|---|
cli/enry | ||
data | ||
internal | ||
.gitignore | ||
.travis.yml | ||
classifier.go | ||
common_test.go | ||
common.go | ||
generate.go | ||
LICENSE | ||
Makefile | ||
README.md | ||
utils_test.go | ||
utils.go |
enry
File programming language detector and toolbox to ignore binary or vendored files. enry, started as a port to Go of the original linguist Ruby library, that has an improved performance of 100x.
Installation
The recommended way to install simple-linguist
go get gopkg.in/src-d/enry.v1/...
Examples
lang, _ := GetLanguageByExtension("foo.go")
fmt.Println(lang)
// result: Go
lang, _ = GetLanguageByContent("foo.m", "<matlab-code>")
fmt.Println(lang)
// result: Matlab
lang, _ = GetLanguageByContent("bar.m", "<objective-c-code>")
fmt.Println(lang)
// result: Objective-C
// all strategies together
lang := enry.GetLanguage("foo.cpp", "<cpp-code>")
CLI
You can use enry as a command,
$ enry --help
enry, A simple (and faster) implementation of github/linguist
usage: enry <path>
enry <path> [--json] [--breakdown]
enry [--json] [--breakdown]
and it will return an output similar to linguist's output,
$ enry
11.11% Gnuplot
22.22% Ruby
55.56% Shell
11.11% Go
but not only the output, also its flags are the same as linguist's ones,
$ enry --breakdown
11.11% Gnuplot
22.22% Ruby
55.56% Shell
11.11% Go
Gnuplot
plot-histogram.gp
Ruby
linguist-samples.rb
linguist-total.rb
Shell
parse.sh
plot-histogram.sh
run-benchmark.sh
run-slow-benchmark.sh
run.sh
Go
parser/main.go
even the JSON flag,
$ enry --json
{"Gnuplot":["plot-histogram.gp"],"Go":["parser/main.go"],"Ruby":["linguist-samples.rb","linguist-total.rb"],"Shell":["parse.sh","plot-histogram.sh","run-benchmark.sh","run-slow-benchmark.sh","run.sh"]}
Note that even if enry's CLI is compatible with linguist's, its main point is that, contrary to linguist, enry doesn't need a git repository to work!
Development
enry re-uses parts of original linguist especially data in languages.yml
to generate internal data structures. In oreder to update to latest upstream run
make clean code-generate
To run the tests
make test
Why Enry?
In the movie My Fair Lady, Professor Henry Higgins is one of the main characters. Henry is a linguist and at the very beginning of the movie enjoys guessing the nationality of people based on their accent.
Enry Iggins
is how Eliza Doolittle, pronounces the name of the Professor during the first half of the movie.
License
MIT, see LICENSE