code-stats

Show code statistics for your project.

Example

For example, running code-stats on its own directory:

$ code-stats --exclude "json|test/fixtures"

Type     | Files | Lines
---------|-------|----------
js       | 2     | 419 (52%)
ts       | 1     | 309 (38%)
markdown | 1     | 77 (10%)
---------|-------|----------
All      | 4     | 805

The output is compatible with Markdown table syntax.

Features

• Reports file and line counts for various types of source files.

• Optionally specify paths to include, and exclude files by pattern (see usage).

• Excludes paths like node_modules by default.

• Supports the following filetypes:

    ## Top languages (Github)                     ## More languages
    ---------------------------------------       ----------------------------------
    js coffee           # Javascript              asm                 # Assembly
    rb erb              # Ruby                    clj                 # Clojure
    py                  # Python                  go                  # Go
    sh                  # Shell                   lisp                # Lisp
    java                # Java                    hs                  # Haskell
    php                 # Php                     pde                 # Processing
    c h                 # C                       scm                 # Scheme
    cpp cc cxx          # C++                     proto               # Protocol Buffers
    pl pm t ep          # Perl
    m mm                # Objective-C
    ts                  # TypeScript
    swift               # Swift
    scala               # Scala
  
    ## Web and docs                               ## Config
    ---------------------------------------       ----------------------------------
    html htm xhtml xml  # Markup                  cfg ini             # Settings
    css                 # Styles                  json yml            # Serialized
    mustache haml jade  # Templates
    less sass scss styl # Preprocessed CSS
    md markdown         # Docs

Installation

To get the code-stats command, install globally with npm:

$ npm install -g code-stats

Usage

Just run code-stats within your project directory:

$ code-stats

Options

Run code-stats -h to see the available options:

Usage: code-stats [options] [<paths>]

  <paths>                       Paths to search; defaults to '*'.

Options:

  -a, --all                     Include files of all types.
  -d, --debug                   Debug options, files, and counts.
  -h, --help                    Show this help info.
  -t, --types <extensions>      File extensions to search, along with defaults (space separated list).
  -T, --types-only <extensions> File extensions to search, instead of defaults (space separated list).
  -x, --exclude <pattern>       Exclude files, along with defaults (regex).
  -X, --exclude-only <pattern>  Exclude files, instead of defaults (regex).
  -v, --version                 Show the code-stats version.