A light-weight javascript auto-formatting library for code snippets.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src
test
.babelrc
.gitignore
.npmignore
.travis.yml
LICENSE
README.md
esdoc.json
package-lock.json
package.json
webpack.config.js

README.md

auto-format

Build Status Coverage Status npm Document

An easy to use, light-weight library to auto-format code in javascript. Works well with code highlighting libraries to display beautiful, uniformly formatted code.

As of right now only Java can be formatted properly, although you will probably get decent results with any language that uses brackets as scope delimiters. Further more the library is very extensible, in fact you only have to implement 5 methods to add support for another language. Please see contribute if you would like to contribute. Help is always welcome!

Examples

format method:

You can also check out https://exemplator.xyz where all code samples are formatted with this library.

Live example of format method.

Install

Run npm install auto-format --save

Usage

As of right now, only Java is fully supported.

ES6:

import Formatter from "auto-format"

Vanilla JS:

var Formatter = require('auto-format');

Simple example: format

var indentToken = "   ";
var unformattedCode = "code to format";

var javaFormatter = Formatter.createJavaFormatter(indentToken);
var formattedCode = javaFormatter.format(unformattedCode);

Format a string of code. The string will be cut into lines and lines will be indented accordingly to their scope.

-- Parameters:

indentToken : The token used to indent lines (e.g. 2 or 4 spaces).

unformattedCode : A string of unformatted code (including line breaks).

-- Return:

formattedCode : An array lines of code. All lines will have been correctly indented according to their scope.


Complex example: formatSnippet

var indentToken = "   ";
var javaFormatter = Formatter.createJavaFormatter(indentToken);

var unformattedCode = "code to format";
var selectionStartRow = 11;
var selectionEndRow = 11;
var snippetOffset = 6;

var formattedCode = javaFormatter.formatSnippet(unformattedCode, selectionStartRow, 
    selectionEndRow, snippetOffset);

A slight variation of format(codeString). Useful if you want to display a code snippet around a selection of lines like here.

In addition to indenting lines, formatSnippet takes a selection and an offset.

The selection consists of one or several lines which should be "highlighted" in the code. For example the line that you would like to show off. The offset defines the number of lines above and below the selection.

The start and end of the snippet is calculated from the selection start, end and the offset. formatSnippet intelligently cuts the snippet out of the original codebase. 'Intelligently' means the method always tries to cut out only the method out of the selection. If the method is too big, only a part of the method will be cut out, but lines outside this method (i.e. other methods etc.) are cut away unless they comment that method.

-- Parameters:

indentToken : The token used to indent lines (e.g. 2 or 4 spaces).

unformattedCode : A string of unformatted code (including line breaks).

selectionStartRow : The start row of the selection in the code base.

selectionEndRow : The end row of the selection in the code base.

snippetOffset : The number of lines above and below the selection.

-- Example:
Selection start row: 11
Selection end row: 11
Offset: 6 
------------------------------
Snippet start row: 11 - 6 = 5
Snippet end row: 11 + 6 = 17
-- Return:

formattedCode : An array in the form of

[code string above selection, code string of selection, code string below selection,
[new start line of snippet in original file, new end line of snippet in original file]]

For more details and examples see the documentation.

Contribute

Pull requests are always welcome. To add support for a new language, look at the JavaFormatter.

The documentation is here.