sloc

README

SLOC - Source Lines Of Code

SLOC is a utility for counting source lines of code. Currently it supports 94 languages.

Table of Contents

• Download
• Build
• Testing
• Usage
• Supported Languages
• Author
• License

Download

$ git clone https://github.com/YuriyLisovskiy/sloc.git

Build

Minimum version of Go language required: go1.10, see golang installation

Build binaries for all supported operating systems:

$ make build

Run tests and build binaries for all supported operating systems:

$ make

Available operating systems build:

• Linux: $ make linux - to build all supported linux architectures, other:
  • $ make linux-386
  • $ make linux-amd64
  • $ make linux-arm
  • $ make linux-arm64
• Windows: $ make windows - to build all supported windows architectures, other:
  • $ make windows-386
  • $ make windows-amd64
• Darwin: $ make darwin - to build all supported darwin architectures, other:
  • $ make darwin-386
  • $ make darwin-amd64
• FreeBSD: $ make freebsd - to build all supported freebsd architectures, other:
  • $ make freebsd-386
  • $ make freebsd-amd64
  • $ make freebsd-arm
• Solaris (amd64 only):
  • $ make solaris

Testing

Run tests:

$ make test

Usage

By default, sloc will count lines of code in current directory:

$ sloc count
--------------------------------------------------------------------------
 Language           Files       Lines       Blank    Comments        Code
--------------------------------------------------------------------------
 Yaml                   1          10           1           0           9
 Xml                    3         781           0           0         781
 Go                    18        1229         117           0        1112
--------------------------------------------------------------------------
 Total                 22        2020         118           0        1902

Pass a directory to inspect files:

$ sloc count --directory src/
--------------------------------------------------------------------------
 Language           Files       Lines       Blank    Comments        Code
--------------------------------------------------------------------------
 Go                    11         690          68           0         622
--------------------------------------------------------------------------
 Total                 11         690          68           0         622

Or file:

$ sloc count --file src/main.go
--------------------------------------------------------------------------
 Language           Files       Lines       Blank    Comments        Code
--------------------------------------------------------------------------
 Go                     1          46           3           0          43
--------------------------------------------------------------------------
 Total                  1          46           3           0          43

Or multiple file(s) and(or) folder(s) with log:

$ sloc count --multiple ".travis.yml Makefile src/cli/" --log
.travis.yml
Makefile
./src/cli/cli.go
./src/cli/flags.go
./src/cli/utils.go
./src/cli/utils_test.go
./src/cli/validator.go
./src/cli/vars.go
--------------------------------------------------------------------------
 Language           Files       Lines       Blank    Comments        Code
--------------------------------------------------------------------------
 Yaml                   1          10           1           0           9
 Makefile               1          68          28           0          40
 Go                     6         253          27           0         226
--------------------------------------------------------------------------
 Total                  8         331          56           0         275

Exclude some file(s) and(or) folder(s):

$ sloc count --directory src/ --exclude "src/main.go src/cli/"
--------------------------------------------------------------------------
 Language           Files       Lines       Blank    Comments        Code
--------------------------------------------------------------------------
 Go                    10        1110         100           0        1010
--------------------------------------------------------------------------
 Total                 10        1110         100           0        1010

Read usage info:

$ sloc help
USAGE:
    sloc [COMMANDS] [FLAGS] [OPTIONS]

COMMANDS:
    count	Counts lines using FLAGS
    help	Prints help information
    version	Prints version information

FLAGS:
    -f, --file		Sets file to count lines
    -d, --directory	Sets folder to count lines
    -m, --multiple	Sets files and(or) folders to count lines using ""

OPTIONS:
    -e, --exclude	Sets file(s) and(or) folder(s) to exclude from counting lines using ""
    -j, --json		Writes result to json file
    -x, --xml		Writes result to xml file
    -y, --yaml		Writes result to yaml file
    -l, --log		Prints log

Get version of installed build:

$ sloc version
sloc 0.0.1

Save output to one of an available file format:

$ sloc count --json --xml --yaml

Supported languages

• ActionScript
• Ada
• Agda
• ASP
• ASP.NET
• Assembly
• Autoconf
• Awk
• Batch
• Bourne Shell
• C
• C++
• C#
• C/C++ Header
• C Shell
• CoffeeScript
• ColdFusionScript
• Coq
• CSS
• CUDA
• CUDA Header
• D
• Dart
• DeviceTree
• Erlang
• Forth
• FORTRAN Legacy
• FORTRAN Modern
• F#
• GLSL
• Go
• Groovy
• Handlebars
• Haskell
• Hex
• Html
• Idris
• INI
• Intel Hex
• Jai
• Java
• JavaScript
• Json
• Jsx
• Julia
• Kotlin
• Lean
• Less
• LinkerScript
• Lisp
• Lua
• Makefile
• Markdown
• Mustache
• Nim
• Nix
• Objective-C
• Objective-C++
• OCaml
• Oz
• Pascal
• Perl
• PHP
• Plain text
• Polly
• Prolog
• Protobuf
• Pyret
• Python
• Qcl
• QML
• R
• Razor
• Ruby
• RubyHtml
• Rust
• SaltStack
• Sass
• Scala
• SML
• SQL
• Stylus
• Swift
• Tcl
• TeX
• Toml
• TypeScript
• Typescript JSX
• UnrealScript
• Wolfram
• XML
• Yacc
• YAML
• Zig

Author

• Yuriy Lisovskiy

License

This project is licensed under BSD 3-Clause License - see the LICENSE file for details.