A Crystal reimplementation of the Pygments/Chroma syntax highlighters
Go to file
2017-07-07 10:15:27 +02:00
cli/enry Added end of line when outputs json 2017-07-05 12:12:23 +02:00
data regenerated to the last commit of linguist 2017-06-28 11:24:20 +02:00
internal Moved commit.go to data directory 2017-06-28 11:22:42 +02:00
.gitignore tests 2016-07-13 22:21:18 +02:00
.travis.yml Added test-coverage 2017-06-28 08:31:31 +02:00
classifier.go remove reflection-based slice sort 2017-06-26 17:26:22 +02:00
common_test.go binary files are returned as OtherLanguage by GetLanguage 2017-07-04 11:38:43 +02:00
common.go binary files are returned as OtherLanguage by GetLanguage 2017-07-04 11:38:43 +02:00
generate.go renamed package and cli to enry 2017-06-13 14:18:23 +02:00
LICENSE LICENSE 2017-04-05 19:03:20 +02:00
Makefile Added test-coverage 2017-06-28 08:31:31 +02:00
README.md added cli documentation to README 2017-07-07 10:15:27 +02:00
utils_test.go commit against tests run is fixed 2017-06-26 15:35:53 +02:00
utils.go moved generated data to data subpackage 2017-06-28 08:31:11 +02:00

enry GoDoc Build Status codecov

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