# hack-linguist

> Wrapper around atom-linguist

Latest version **2.0.0** (published 2015-05-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install hack-linguist
pnpm add hack-linguist
yarn add hack-linguist
bun add hack-linguist
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2015-05-15 |
| First published | 2015-05-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jeffrey van Hoven |
| Maintainers | jeffreyhoven |
| Keywords | linguist |

## Links

- npm: https://www.npmjs.com/package/hack-linguist
- Repository: https://github.com/jvhoven/hack-linguist
- Issues: https://github.com/jvhoven/hack-linguist/issues
- npm.io page: https://npm.io/package/hack-linguist

## Dependencies (3)

- [file](https://npm.io/package/file.md) ^0.2.2
- [atom-linguist](https://npm.io/package/atom-linguist.md) ^0.1.0
- [coffee-script](https://npm.io/package/coffee-script.md) ^1.9.2

## Recent versions

- 2.0.0 (latest) — 2015-05-15
- 1.0.0 (beta) — 2015-05-09
- 1.3.0 — 2015-05-11
- 1.2.0 — 2015-05-09
- 1.1.0 — 2015-05-09
- 1.0.1 — 2015-05-09

## README

# Hack-linguist

Simple wrapper on top of [atom-linguist](https://github.com/lee-dohm/atom-linguist)

## Installation  

```
npm i hack-linguist
```
```
var linguist = require("hack-linguist");
```

# API  

**walkIdentify**: walks through a directory and identifies each file  
**identify**: Identifies the programming language for a single file  
**identifySync**: Identifies the programming language for a file synchronously


**Report**

Report is the returned object when using walkIdentifySync
It holds some useful data

[Read more](https://github.com/jvhoven/hack-linguist/blob/master/lib/report.js)

## Examples

```
...
linguist.identify('YOUR_FILE', function(err, language) {
	// error -> the possible error that occurred
	// language -> the identified language
});

var language = linguist.identify('YOUR_FILE');
```

```
...
var report = walkIdentifySync('YOUR_DIRECTORY');
```

# Todo

Create an asynchronous version of walkIdentifySync

---
_Source: https://npm.io/package/hack-linguist · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._