Skip to content

Latest commit

 

History

History
98 lines (78 loc) · 2.24 KB

README.md

File metadata and controls

98 lines (78 loc) · 2.24 KB
Raw

Linecounter

A package / CLI for determining how much code you had written

Install

Install it with npm!

Global CLI: npm install -g linecounter

Node Package: npm install --save linecounter

const linecounter = require("linecounter")

Compiling on Windows machines requires the node-gyp prerequisites.

Usage

Node package

linecounter(callback, [options]) Callback gets a JSON string parameter.

Options

  • directory: specify directory [String]
  • ignore: ignore specific files [String1,String2,String3]
  • file: count only one file [String]
  • list: list out not ignored (counting files) [Boolean]
  • errors: list out errors to linecounter.error.log [Boolean]

CLI

linecounter [options]

Options

-V, --version                                     output version number
-d, --directory <directory>                       specify directory
-i, --ignore <filename1, filename2... filenameN>  ignore specific files
-f, --file <filename>                             count only one file
-l, --list                                        list out not ignored (counting files)
-e, --errors                                      list out errors to linecounter.error.log
-t, --table                                       display results in a table
-h, --help                                        output usage information

Examples

linecounter

This will analyze the current directory. Output is in json.

{
	"TOTAL":  {"lines":272,"files":7},
	".md":    {"files":1,"lines":90},
	".js":    {"files":4,"lines":139},
	".json":  {"files":1,"lines":1},
	"PLAIN":  {"files":1,"lines":42}
}

linecounter >> stats.txt

Echo results to a file.

linecounter --directory ~/Projects/ultimate-facebook

Analyze a specified directory.

linecounter --ignore secrets.js,copiedThings.json

Ignore specified files (you don't have to add path, only filename).

linecounter --file main.js

Get number of lines in one specified file.

linecounter --list --ignore secrets.js

List out files that would count with the current options

linecounter --table

Display the results in a table

screenshot