And clarify documentation wording, based on discussion
at https://github.com/go-enry/go-enry/issues/145
test plan:
* go test -run '^Test_EnryTestSuite$' -testify.m '^(TestGetLanguageByContent)$' ./...
Closes#17
Implements the IsGenerated helper function to filter out generated
files using the rules and matchers in:
- https://github.com/github/linguist/blob/master/lib/linguist/generated.rb
Since the vast majority of matchers have very different logic, it cannot
be autogenerated directly from linguist like other logics in enry, so it's
translated by hand.
There are three different types of matchers in this implementation:
- By extension, which mark as generated based only in the extension. These
are the fastest matchers, so they're done first.
- By file name, which matches patterns against the filename. These
are performed in second place. Unlike linguist, we try to use string
functions instead of regexps as much as possible.
- Finally, the rest of the matchers, which go into the content and try
to identify if they're generated or not based on the content. Unlike
linguist, we try to only read the content we need and not split it
all unless it's necessary and use byte functions instead of regexps
as much as possible.
Signed-off-by: Miguel Molina <miguel@erizocosmi.co>
Fixes#243. The default behaviour for `go get` has changed slightly and we now
need to either provide a module context or disable modules for installation to
work correctly.
Also remove a now-obsolete reference to the source{d} engine CLI.
Signed-off-by: M. J. Fromberger <michael.j.fromberger@gmail.com>
Addresses #239. The `go get` command fetches the command-line tool, and does
not match the import path for the library. To make things more clear:
1. Mention explicitly that `go get` fetches the CLI. Also, to avoid potential
issues with pre-modules Go versions, do the fetch in /tmp.
2. Include an import path explicitly in the source examples.
3. Mention explicitly how to import enry into a modules build.
Signed-off-by: M. J. Fromberger <michael.j.fromberger@gmail.com>
