https://github.com/rafaelrinaldi/gh-linguist
GitHub's linguist data base exposed as a Node.js module
https://github.com/rafaelrinaldi/gh-linguist
github linguist module node programming-languages
Last synced: 4 months ago
JSON representation
GitHub's linguist data base exposed as a Node.js module
- Host: GitHub
- URL: https://github.com/rafaelrinaldi/gh-linguist
- Owner: rafaelrinaldi
- Created: 2018-08-10T04:14:52.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-25T18:43:33.000Z (about 7 years ago)
- Last Synced: 2025-05-11T09:37:41.054Z (5 months ago)
- Topics: github, linguist, module, node, programming-languages
- Language: Shell
- Homepage:
- Size: 207 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[linguist]: https://github.com/github/linguist
[vendor-licenses]: https://github.com/github/linguist/blob/master/vendor/README.md
# gh-linguist [](https://semaphoreci.com/rafaelrinaldi/gh-linguist)
> [GitHub's linguist][linguist] data base exposed as a Node.js module
## Install
```sh
npm i gh-linguist
```
## Usage
```js
import linguist from 'gh-linguist'
const languages = await linguist()
```
## API
### `linguist()`
Returns a `Promise` that resolves with the contents of Linguist's YAML data base parsed as a plain JavaScript object.
## Updates
To make this module up to date with Linguist I've setup a scheduler that runs once a day to check for updates.
## License
- Language grammars borrowed from Linguist are covered by [their repositories' respective licenses][vendor-licenses].
- [Linguist itself][linguist] and all the files in this repository are covered by the MIT license.
---