https://github.com/kangax/kratko.js

Simple tool to help refactor Javascript
https://github.com/kangax/kratko.js

Last synced: 26 days ago
JSON representation

Simple tool to help refactor Javascript

• Host: GitHub
• URL: https://github.com/kangax/kratko.js
• Owner: kangax
• Created: 2011-06-05T15:56:15.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2019-06-25T13:01:13.000Z (almost 5 years ago)
• Last Synced: 2024-04-22T12:14:21.504Z (2 months ago)
• Language: JavaScript
• Homepage: http://perfectionkills.com/refactoring-javascript-with-kratko-js
• Size: 36.1 KB
• Stars: 265
• Watchers: 11
• Forks: 14
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Lists

• my-awesome-starred - kangax/kratko.js - Simple tool to help refactor Javascript (JavaScript)
• awesome-stars - kratko.js - Simple tool to help refactor Javascript (JavaScript)
• awesome-stars - kangax/kratko.js - Simple tool to help refactor Javascript (JavaScript)

README

        


## What is this?

kratko.js helps you refactor Javascript. It takes an object and collects information about it. It lets you see which objects have too many methods, which methods do too many things, and accept too many arguments.

## How do I use it?

kratko.js defines 2 global objects — `Kratko` and `TableViewer`. `Kratko` is used for getting stats of an object — lengths of methods, lengths of method arguments, as well their average, minimum and maximum values. `TableViewer` provides simple UI to view those stats via HTML table.

## Which stats do I get?

`Kratko.getStatsFor()` returns an object with stats that looks like this:

    {

      methods: {

        name: {

          methodString: ...,

          length: ...,

          argsLength: ...

        }

      },

  

      totalMethodLength: ...,

  

      minMethodLength: ...,

      maxMethodLength: ...,

  

      totalArgsLength: ...,

  

      minArgsLength: ...,

      maxArgsLength: ...,

  

      numMethods: ...

    }

For example, if we have an object with 2 methods `foo` and `bar`:

    var obj = {

      foo: function(x, y) {

        return x + y;

      },

      bar: function(a, b, c, d, e, f, g) {

        if (true) {

          // some comment

          alert(123);

        }

      }

    };

Here's an output returned by `Kratko.getStatsFor`:

    {

      methods: {

        foo: {

          methodString: 'function (x, y) {\n  return x + y;\n}',

          length: 1,

          argsLength: 2

        },

        bar: {

          methodString: 'function (a, b, c, d, e, f, g) {\n  if (true) {\n    //some comment\n    alert(123);\n  }}',

          length: 3,

          argsLength: 7

        }

      },

      

      totalMethodLength: 4,

      minMethodLength: 1,

      maxMethodLength: 3,

      

      totalArgsLength: 9,

      minArgsLength: 2,

      maxArgsLength: 7,

      

      numMethods: 2

    }

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/kangax/kratko.js/trend.png)](https://bitdeli.com/free "Bitdeli Badge")