Skip to content

jvhoven/hack-linguist

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hack-linguist

Simple wrapper on top of 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

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');

walkIdentifySync with ignore list

var ignoreList = [
	'*.js',
	'node_modules',
	'bower_components',
	'.gitignore',
];

var report = walkIdentifySync('YOUR_DIRECTORY', ignoreList);

Todo

Create an asynchronous version of walkIdentifySync

About

Linguist wrapper on top of atom-linguist

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published