JavaScript-Indent/README at master · vim-scripts/JavaScript-Indent · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
This is a mirror of http://www.vim.org/scripts/script.php?script_id=3081

Hosted at: http://code.google.com/p/web-indent/

*Update: (3/30/11) - Release Candidate 1.0 - Progress Started.
*Update: (5/14/10) - Beta 3.0 Released (See Below) (First Release Candidate)
*Update: (5/6/10) - Beta 2.2 Released (See Below)
*Update: (5/6/10) - Beta 2.1 Released (See Below)
*Update: (5/5/10) - Beta 2.0 Released (See Below)
*Update: (5/3/10) - Beta 1.0 Released (See Below)

Summary:
================================================================================
I wrote this basically due to the lack of any good javascript indent plugin out there. And due to javascripts lax syntactical structure cindent() just wont cut it.

Web-Indent handles all basic forms of add notes, bugs and multi-line and singe line objects:
var x = {
 y : {
 z;
 }
}

var y = [
 x,
 y,
 z
]

var z = {x : x, y : y, w: w};

t; // no indent

Handles all basic control structures (with or without leading '{'):
if(x)
 // comment
 y;
z;

Handles inline and nextline control structure block initializers ('{' in the vernacular):
if(x) {
 x;
}
else
{
 z;
}

Handles multi-line function declarations:
var x = function(
 y, // notice one tab over
 z,
 w) {
 t;
}

Handles multi-line control structure statements:
if( x == y ||
 y == z ||
 z == w)
{
 t;
}

This indenter is also fully compatible with Mootools and esp. its Class package. I haven't tested it with any of the other frameworks, but due to their similar syntactical nature, I'm assuming they will work as will.

Included Files:
================================================================================
 ~test.js - A sample js file with various coding patterns. Set tabstop=6 and shiftwidth=6 and comments should line up correctly.
 ~indent/javascript.vim - The core indenting file
 ~indent/html.vim - An updated version of the pre-packaged html indenter that utilizes javascript.vim (MUST BE LOCATED IN SAME DIRECTORY!!)

Release Notes:
================================================================================
~1.0 Released: (5/15/10)
 - Fixed: Continuation Lines
 - Removed: Logging

~Beta 3.0 Released: (5/14/10)
 - Fixed: Runaway Indentation.
 - Fixed: indentkeys now correctly invoke indent.
 - Fixed: Comment lines with keywords are correctly indented. Thanks to trojhlav for pointing it out.
 - Notes:
 \ First Release Candidate (v 1.0)
 \ Correctly indented entire jQuery source.
 \ Correctly indented entire MooTools source.
 - Concerns:
 \ Still no support for continuation lines.
~

PS: I'm also not sure if I'm allowed to repost the html.vim, since I couldn't find a license for it. I'm pretty sure it was the one packaged with vim by default. If anyone has any objections, I'll take it down immediately.