8ff885a3a8
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> |
||
|---|---|---|
| .. | ||
| project | ||
| src | ||
| .gitignore | ||
| build.sbt | ||
| key.asc.enc | ||
| Makefile | ||
| README.md | ||
| sbt | ||
enry-java
Usage
enry-java package is available thorugh maven central,
so it be used easily added as a dependency in various package management systems.
Examples of how to handle it for most commons systems are included below,
for other systems just look at maven central's dependency information.
Apache Maven
<dependency>
<groupId>tech.sourced</groupId>
<artifactId>enry-java</artifactId>
<version>${enry_version}</version>
</dependency>
Scala SBT
libraryDependencies += "tech.sourced" % "enry-java" % enryVersion
Build
Requirements
sbtJava(tested with Java 1.8)wgetGo(only for building the shared objects for your operating system)
Generate jar with Java bindings and shared libraries
You need to do this before exporting the jar and/or testing.
make
This will download JNAerator jar to generate the code from the libenry.h header file, it will be placed under lib.
The shared libraries for your operating system will be built if needed and copied inside the shared directory.
For IntelliJ and other IDEs remember to mark shared folder as sources and add lib/enry.jar as library. If you use sbt from the command line directly that's already taken care of.
Run tests
make test
Export jar
make package
Will build fatJar under ./target/enry-java-assembly-X.X.X.jar.
One can use ./sbt publish-local to install enry-java dependency on local machine.