Tool to count lines of source code.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
CATS
DATS
SATS
bash
compleat
include
man
src
test
.atsfmt.toml
.ctags
.gitattributes
.gitignore
.travis.yml
.yamllint
CHANGELOG.md
CONTRIBUTING.md
Justfile
LANGUAGES.md
LICENSE
README.md
TODO.md
atspkg.dhall
gc.dhall
mac.dhall
native.dhall
no-gc.dhall
screenshot.png

README.md

polyglot

Build Status

poly is a command-line tool that determines project contents. The goal is to able to point it to any directory and get an accurate, complete, and informative summary of its contents.

Screenshot of sample output

It also has the secondary goal of advancing the state-of-the art for ATS, by writing practical, distributable software and supporting tooling.

Pitch

Reasons to use polyglot:

  • Accurate: won't confuse Coq and Verilog
  • Fast: polyglot is faster than all other tools
  • Pretty: magenta output

Reasons not to use polyglot:

  • Written in ATS
  • Best on Linux
  • No regex-based exclusions
  • Doesn't count block comments

Benchmarks

On the Rust repo:

Tool Language Time
polyglot ATS 134.6 ms
loc Rust 139.6 ms
scc Go 225.4 ms
tokei Rust 262.6 ms
gocloc Go 923.9 ms
cloc Perl 5.610 s
enry Go 6.926 s
linguist Ruby 20.16 s

For more extensive benchmarks, see my blog post with some additional data.

Heuristics

Polyglot distinguishes itself from tokei, gocloc, scc, and loc by being able to disambiguate file names. Thus, poly will not confuse Happy for Yacc (for instance).

Installation

From a Script

The easiest way to install is to use the installation script, like so:

curl -sSl https://raw.githubusercontent.com/vmchale/polyglot/master/bash/install.sh | sh -s

You can optionally install compleat for shell completions as well.

Vim Plugin

There is a vim plugin available which can count lines of code in a project.

Documentation

You can view manpages for poly with

man poly

Building for Hacking

You can install ats-pkg with

curl -sSl https://raw.githubusercontent.com/vmchale/atspkg/master/bash/install.sh | sh -s

And then build poly with

git clone git@github.com:vmchale/polyglot.git
cd polyglot
atspkg build --pkg-args './gc.dhall'

This will put a binary at target/poly.

If you are on Mac, you may have to replace the last line with

atspkg build --pkg-args './mac.dhall'

Testing

To run the test suite

atspkg test --pkg-args './gc.dhall'

Languages

For languages already supported, see LANGUAGES.md

Contents

-------------------------------------------------------------------------------
 Language             Files       Lines         Code     Comments       Blanks
-------------------------------------------------------------------------------
 ATS                     16        3682         3524           39          119
 C                        1          24           22            0            2
 C Header                 1          43           35            0            8
 Dash                     5         133          106            1           26
 Dhall                    5          94           84            0           10
 Justfile                 1          24           21            1            2
 Markdown                 7         818          702            0          116
 TOML                     1           3            3            0            0
 YAML                     1          51           45            0            6
-------------------------------------------------------------------------------
 Total                   38        4872         4542           41          289
-------------------------------------------------------------------------------