KevinMidboe/linguist
1
0
Fork 0
mirror of https://github.com/KevinMidboe/linguist.git synced 2025-12-08 20:38:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Editing

Browse Source
This commit is contained in:
Joshua Peek
2011-06-25 16:51:49 -05:00
parent 8778979836
commit 15eee763cb
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -8,9 +8,9 @@ We use this library at GitHub to detect file language types for syntax highlight
Linguist defines the list of all languages known to GitHub in a [yaml file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). In order for a file to be hightlighted, a language and lexer must be defined there.
Most languages are detected by their file extension. This is the fastest and most common situation. For script files, which are usually extensionless, we do "deep content inspection"™ and check the shebang of the file. Checking the files contents may also be used for disambiguating between langauges. C/C++/Obj-C all use `.h` files. Looking for common keywords, we are usually able to guess the correct language.
Most languages are detected by their file extension. This is the fastest and most common situation. For script files, which are usually extensionless, we do "deep content inspection"™ and check the shebang of the file. Checking the file's contents may also be used for disambiguating langauges. C, C++ and Obj-C all use `.h` files. Looking for common keywords, we are usually able to guess the correct language.
In the actual GitHub app we deal with `Grit::Blob` objects, there is a simple `FileBlob` api you can use for testing.
In the actual GitHub app we deal with `Grit::Blob` objects. For testing, there is a simple `FileBlob` API.
file = Linguist::FileBlob.new("lib/linguist.rb")
file.language.name #=> "Ruby"
@@ -18,13 +18,13 @@ In the actual GitHub app we deal with `Grit::Blob` objects, there is a simple `F
file = Linguist::FileBlob.new("bin/linguist")
file.language.name #=> "Ruby"
See [lib/linguist/language.rb](https://github.com/github/linguist/blob/master/lib/linguist/language.rb) and [lib/linguist/languages.yml](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml)
See [lib/linguist/language.rb](https://github.com/github/linguist/blob/master/lib/linguist/language.rb) and [lib/linguist/languages.yml](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
#### Syntax Highlighting
The actual syntax highlighting is handled by our Pygments wrapper, [Albino](https://github.com/github/albino). Linguist provides a [Lexer abstraction](https://github.com/github/linguist/blob/master/lib/linguist/lexer.rb) that determines which highlighter should be used on a file.
We typical run on a prelease version of Pygments to get early access to new lexers. The [lexers.yml](https://github.com/github/linguist/blob/master/lib/linguist/lexers.yml) file is a dump of the lexers we have available on our server.
We typical run on a prelease version of Pygments to get early access to new lexers. The [lexers.yml](https://github.com/github/linguist/blob/master/lib/linguist/lexers.yml) file is a dump of the lexers we have available on our server. If there is a new lexer in pygments-main not on the list, [open an issue](https://github.com/github/linguist/issues) and we'll try to upgrade it soon.
### MIME type detection
@@ -32,18 +32,16 @@ Most of the MIME types handling is done by the Ruby [mime-types gem](https://git
MIME types are used to set the Content-Type of raw binary blobs which are served from a special `raw.github.com` domain. However, all text blobs are served as `text/plain` regardless of their type to ensure they open in the browser rather than downloading.
The MIME type also determines whether a blob is binary or plain text. So if you're seeing a blob that says "View Raw" and it is actually plain text, you probably just need to expliclity state the mime type and encoding.
The MIME type also determines whether a blob is binary or plain text. So if you're seeing a blob that says "View Raw" and it is actually plain text, the mime type and encoding probably needs to be expliclity stated.
file = Linguist::FileBlob.new("linguist.zip")
file.binary? #=> true
See [lib/linguist/mimes.yml](https://github.com/github/linguist/blob/master/lib/linguist/mimes.yml)
See [lib/linguist/mimes.yml](https://github.com/github/linguist/blob/master/lib/linguist/mimes.yml).
### Stats
The [Language Graph](https://github.com/github/linguist/graphs/languages) is built by aggregating the programming languages we are able to detect. Collectively, these stats make up the [Top Languages](https://github.com/languages) page.
The top language in your project's graph determines its primay language. If this doesn't seem right, [open an issue](https://github.com/github/linguist/issues) and we'll have a look.
The [Language Graph](https://github.com/github/linguist/graphs/languages) is built by aggregating the languages of all repo's blobs. The top language in the graph determines the project's primay language. Collectively, these stats make up the [Top Languages](https://github.com/languages) page.
The repository stats API can be used on a directory:
@@ -59,13 +57,13 @@ These stats are also printed out by the binary. Try running `linguist` on itself
### Ignore vendored files
Checking other code into your git repo is a common practice. But this often inflates your project's language stats and may even cause your project to be indentified as another language. We are able to identify some of these files and directories and exclude them.
Checking other code into your git repo is a common practice. But this often inflates your project's language stats and may even cause your project to be labeled as another language. We are able to identify some of these files and directories and exclude them.
file = Linguist::FileBlob.new("vendor/plugins/foo.rb")
file.vendored? # => true
See [Linguist::BlobHelper#vendored?](https://github.com/github/linguist/blob/master/lib/linguist/blob_helper.rb) and
[lib/linguist/vendor.yml](https://github.com/github/linguist/blob/master/lib/linguist/vendor.yml)
[lib/linguist/vendor.yml](https://github.com/github/linguist/blob/master/lib/linguist/vendor.yml).
### Generated file detection
@@ -74,7 +72,7 @@ Not all plain text files are true source files. Generated files like minified js
file = Linguist::FileBlob.new("underscore.min.js")
file.generated? # => true
See [Linguist::BlobHelper#generated?](https://github.com/github/linguist/blob/master/lib/linguist/blob_helper.rb)
See [Linguist::BlobHelper#generated?](https://github.com/github/linguist/blob/master/lib/linguist/blob_helper.rb).
## Contributing
@@ -85,4 +83,4 @@ See [Linguist::BlobHelper#generated?](https://github.com/github/linguist/blob/ma
5. Commit your changes (`git commit -am "Added detection for the new Foo language"`)
6. Push to the branch (`git push origin detect-foo-language`)
7. Create a [Pull Request](http://help.github.com/pull-requests/) from your branch.
8. Promote it. Get others to drop in and :+1: it.
8. Promote it. Get others to drop in and +1 it.