clog

KO | EN

gitlite — search

#hacktoberfest #react #go #machine-learning #rust #deep-learning #linux #docker #nodejs #macos #cli #kubernetes #awesome-list #open-source

(★ 12)

Static analysis for CoffeeScript files. Similar to flog.

clog Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Clog

CoffeeScript static analysis for code quality metrics. Inspired by flog for Ruby. Runs as a CLI, generating a report describing churn and complexity of each file or directory passed to it.

## Installation

`npm install -g clog-analysis`

## Usage

`clog path/to/file1.coffee path/to/file2.coffee my/dir`

Generates a report of churn and complexity for `file1.coffee`, `file2.coffee`, and all `.coffee`, `.coffee.md`, and `.litcoffee` files inside `my/dir` or any of its subdirectories.

## Contributing

1. Fork it
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Create new Pull Request

## TODO

Stub out fs read file to speed up CLI specs

## Known issues

Method length metric can be incorrect if you have comments at the same level as another function.

```coffee
fnOne = ->
  doSomething()

# This is what function two does
fnTwo = ->
  doSomethingElse()
```

In the above example the comment above `fnTwo` will be added to the method length calculation for `fnOne`.

clog

clog Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

clog

clog Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README