forked from prettydiff/prettydiff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocumentation.xhtml
2565 lines (2565 loc) · 153 KB
/
documentation.xhtml
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Pretty Diff - Documentation</title>
<link
href="http://prettydiff.com/documentation.xhtml"
rel="canonical"
type="application/xhtml+xml"/>
<link
href="http://prettydiff.com/images/favicon.ico"
rel="icon"
type="image/x-icon"/>
<link
href="http://prettydiff.com/labels.rdf"
rel="meta"
title="ICRA labels"
type="application/rdf+xml"/>
<link href="css/index.css" media="all" rel="stylesheet" type="text/css"/>
<meta content="width=device-width, initial-scale=1" name="viewport"/>
<meta content="index, follow" name="robots"/>
<meta content="Pretty Diff - The difference tool" name="DC.title"/>
<meta
content="(pics-1.1 'http://www.icra.org/pics/vocabularyv03/' l gen true for 'http://prettydiff.com' r (n 0 s 0 v 0 l 0 oa 0 ob 0 oc 0 od 0 oe 0 of 0 og 0 oh 0 c 1) gen true for 'http://www.prettydiff.com' r (n 0 s 0 v 0 l 0 oa 0 ob 0 oc 0 od 0 oe 0 of 0 og 0 oh 0 c 1))"
http-equiv="pics-Label"/>
<meta content="Austin Cheney" name="author"/>
<meta
content="Pretty Diff tool can minify, beautify (pretty-print), or diff between minified and beautified code. This tool can even beautify and minify HTML."
name="description"/>
<meta content="Global" name="distribution"/>
<meta content="en" http-equiv="Content-Language"/>
<meta content="application/xhtml+xml;charset=UTF-8" http-equiv="Content-Type"/>
<meta content="blendTrans(Duration=0)" http-equiv="Page-Enter"/>
<meta content="blendTrans(Duration=0)" http-equiv="Page-Exit"/>
<meta content="text/css" http-equiv="content-style-type"/>
<meta content="application/javascript" http-equiv="content-script-type"/>
<meta
content="qL8AV9yjL2-ZFGV9ey6wU3t7pTZdpD4lIetUSiNen7E"
name="google-site-verification"/>
<meta content="#bbbbff" name="msapplication-TileColor"/>
<meta content="images/pdlogo.svg" name="msapplication-TileImage"/>
</head>
<body class="white" id="prettydiff">
<div class="contentarea" id="documentation">
<section role="heading">
<h1>
<svg
height="2000.000000pt"
id="pdlogo"
preserveAspectRatio="xMidYMid meet"
version="1.0"
viewBox="0 0 2000.000000 2000.000000"
width="2000.000000pt"
xmlns="http://www.w3.org/2000/svg">
<g
fill="#999"
stroke="none"
transform="translate(0.000000,2000.000000) scale(0.100000,-0.100000)">
<path
d="M14871 18523 c-16 -64 -611 -2317 -946 -3588 -175 -660 -319 -1202 -320 -1204 -2 -2 -50 39 -107 91 -961 876 -2202 1358 -3498 1358 -1255 0 -2456 -451 -3409 -1279 -161 -140 -424 -408 -560 -571 -507 -607 -870 -1320 -1062 -2090 -58 -232 -386 -1479 -2309 -8759 -148 -563 -270 -1028 -270 -1033 0 -4 614 -8 1365 -8 l1364 0 10 38 c16 63 611 2316 946 3587 175 660 319 1202 320 1204 2 2 50 -39 107 -91 543 -495 1169 -862 1863 -1093 1707 -568 3581 -211 4965 946 252 210 554 524 767 796 111 143 312 445 408 613 229 406 408 854 525 1320 57 225 380 1451 2310 8759 148 563 270 1028 270 1033 0 4 -614 8 -1365 8 l-1364 0 -10 -37z m-4498 -5957 c477 -77 889 -256 1245 -542 523 -419 850 -998 954 -1689 18 -121 18 -549 0 -670 -80 -529 -279 -972 -612 -1359 -412 -480 -967 -779 -1625 -878 -121 -18 -549 -18 -670 0 -494 74 -918 255 -1283 548 -523 419 -850 998 -954 1689 -18 121 -18 549 0 670 104 691 431 1270 954 1689 365 293 828 490 1283 545 50 6 104 13 120 15 72 10 495 -3 588 -18z"/></g>
</svg>
<a href="prettydiff.com.xhtml">Pretty Diff</a>
- Documentation</h1>
<p id="dcolorScheme">
<label class="label" for="colorScheme">Color Scheme</label>
<select id="colorScheme">
<option>Canvas</option>
<option>Shadow</option>
<option selected="selected">White</option>
</select>
</p>
<p>Explore some
<a href="samples.xhtml">samples</a>
or browse
<a href="https://github.com/prettydiff/prettydiff">Pretty Diff on GitHub</a>.</p>
</section>
<section id="doc-content" role="main">
<div>
<h2>
<button aria-disabled="true" class="heading" role="presentation">About Pretty Diff
<span aria-hidden="true">Show</span>
</button>
</h2>
<div class="content-hide">
<div class="segment">
<h3>Purpose</h3>
<p>Pretty Diff is a language aware code comparison tool, beautifier, minifier,
and parser for a variety of web oriented languages.</p>
<p>Pretty Diff was created to compare code samples for various web based
languages even if one (or both) code samples were minified. Currently, the
project operates by beautifying code and then comparing that the beautified
product of the code samples. The goal in a
<a href="https://github.com/prettydiff/prettydiff/issues/71">future version</a>
is to introduce the comparison step directly into the beautifiers between the
parse step and the beautification step to become a truely language aware code
comparison and analysis tool.</p>
</div>
<div class="segment" id="goals">
<h3>Goals</h3>
<dl>
<dt>portability</dt>
<dd>The project should be immediately available cross platform, across various
interfaces, and without a build process. All documentation and required
supporting artifacts are included with the project code.</dd>
<dt>productivity</dt>
<dd>The project should save a developer substantial time by make code easier to
read against a varient of settings and opinions and reduce the steps to complete
a given code analysis task.</dd>
<dt>reproducibility</dt>
<dd>Code pushed through the project in any one mode should be equally restorable
to its previous state using a different mode.</dd>
<dt>simplicity</dt>
<dd>The project should do more with less code. The intended audience of this
project are software developers, who may need to modify the project code to fit
custom needs. Less code means custom mode, but also means clearer separation of
concerns, clearer organization, and fewer algorithms.</dd>
</dl>
</div>
<div class="segment" id="modes">
<h3>Supported Operations (modes)</h3>
<p>Pretty Diff currently supports these four operations:</p>
<dl>
<dt>diff</dt>
<dd>The code comparison mode. This is the default mode and the only mode to
require two code samples.</dd>
<dt>beautify</dt>
<dd>Pretty Diff has progressively moved from community driven dependencies to
custom parsers to accomplish code beautification for a diversity of features and
requests.</dd>
<dt>minify</dt>
<dd>Each of Pretty Diff's beautification libraries has a minify feature. The
goal is to reduce code size but only to such an extent that the code can be
restored to its prior state through beautification, excluding code comments.</dd>
<dt>parse</dt>
<dd>Most code parsers generate a final product called an Abstract Syntax Tree
(AST). Pretty Diff, instead, produces parallel arrays for its internal
operations. The parse mode simply makes these data arrays available for
independent analysis.</dd>
<dt>analysis</dt>
<dd>HTML formatted reports evaluating the code. The reports differ in content
and structure by the parser(s) used.</dd>
</dl>
</div>
<div class="segment" id="languages">
<h3>Language Classifications</h3>
<p>The project maintains three primary language libraries and a minor parser for
CSV format. The three major libraries each include a parser, beautifier, and
minifier. All libraries are located at the
<a href="lib">lib</a>
directory.</p>
<dl>
<dt>csspretty</dt>
<dd>This library provides support for Cascading Style Sheets and similar
languages, such as the popular preprocessors: LESS and SCSS (SASS).</dd>
<dt>jspretty</dt>
<dd>This library provides support for JavaScript and several templating
languages that use a JavaScript-like syntax. React JSX format is supplied by
this library with assistance from the markuppretty library.</dd>
<dt>markuppretty</dt>
<dd>The markuppretty library supports XML, HTML, and a wide variety of HTML
templating schemes such as Handlebars and Mustache templates.</dd>
</dl>
</div>
</div>
</div>
<div>
<h2>
<button aria-disabled="true" class="heading" role="presentation">Output Formats and Types
<span aria-hidden="true">Show</span>
</button>
</h2>
<div class="content-hide">
<div class="segment">
<h3>General Output</h3>
<p>New in version 2 is that most opertions will output a single string. This
makes the application more predictable and easier to integrate into other
applications. Brief metadata about the operation is stored in a global object
named
<em>global.prettydiff.meta</em>.</p>
</div>
<div class="segment">
<h3>Exceptions</h3>
<p>For increased speed and convenience there are some features that could not be
delivered as a single string. The list is as follows:</p>
<ul>
<li>Parse mode with
<strong>parseFormat:parallel</strong>
will return an object with a key named definition and a key named data. The data
property will contain an object of arrays by name and the definition object will
contain and object of identify key names to the data object where each value
defines the data type.</li>
<li>Parse mode with
<strong>parseFormat:sequential</strong>
will a nearly identical object to that described by parseFormat:parallel. The
only difference is that the data property contains an array of array children
where each child array is a parsed token and corresponding data fields.</li>
<li>Parse mode with
<strong>parseFormat:htmltable</strong>
will return a string of the parse data arranged in an HTML table.</li>
<li>The option
<strong>nodeasync</strong>
returns an array where all prior described output is the first index and the
second index is an object containing brief metadata, otherwise stored in the
<em>global.prettydiff.meta</em>
object. The reason for this is to allow meta data collection during parallel
operations without collision. If this option is ignored then all prior described
output formats are generated and the meta data is dumped in the global.prettydiff.meta
object, but that meta data is not reliable. An unintended byproduct of this
feature is that Pretty Diff version 2 can accomplish nearly complete backwards
compatibility to Pretty Diff v1 by setting this option to true.</li>
</ul>
</div>
</div>
</div>
<div>
<h2>
<button aria-disabled="true" class="heading" role="presentation">API (Options)
<span aria-hidden="true">Show</span>
</button>
</h2>
<div class="content-hide">
<ol class="segment" id="options">
<li id="apacheVelocity">
<h4>apacheVelocity</h4>
<ul>
<li>
<h5>Description</h5>
Enables Apache Velocity syntax support in the <a href="lib/markuppretty.js">markuppretty.js</a> library. If accessing the markuppretty.js library directly without the Pretty Diff application set the option <em>apacheVelocity</em> to true. Otherwise, this option can be set directly or by providing the value <em>apacheVelocity</em> to option <a href="#lang">lang</a>. Velocity is not supported in minification mode.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
(only available in the language selection)</li>
</ul>
</li>
<li id="api">
<h4>api</h4>
<ul>
<li>
<h5>Description</h5>
Used internally to decide how to format documents and reports.</li>
</ul>
</li>
<li id="attributetoken">
<h4>attributetoken</h4>
<ul>
<li>
<h5>Description</h5>
Attributes in markup languages when in mode
<em>parse</em>
will output attributes as separate tokens in the parse table output instead of a
data property on the parent element.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Parse Attributes</li>
</ul>
</li>
<li id="brace_style">
<h4>brace_style</h4>
<ul>
<li>
<h5>Description</h5>
This option exists to emulate the brace_style option provided by JSBeautify using other existing Pretty Diff options.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
collapse, collapse-preserve-inline, expand, none</li>
<li>
<h5>Default</h5>
none</li>
<li>
<h5>As labeled in the HTML tool</h5>
Brace Style</li>
</ul>
</li>
<li id="braceline">
<h4>braceline</h4>
<ul>
<li>
<h5>Description</h5>
In JavaScript a new line is inserted after opening curly braces and before
closing curly braces.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Brace Lines</li>
</ul>
</li>
<li id="bracepadding">
<h4>bracepadding</h4>
<ul>
<li>
<h5>Description</h5>
Inserts a space after the start of a container and before the end of the
container in JavaScript if the contents of that container are not indented; such
as: conditions, function arguments, and escaped sequences of template strings.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Brace Padding</li>
</ul>
</li>
<li id="braces">
<h4>braces</h4>
<ul>
<li>
<h5>Description</h5>
Sets the style of indentation during CSS and JavaScript beautification. The
default value
<strong>"knr"</strong>
sets a JSLint compliant beautification scheme and the other value
<strong>"allman"</strong>
puts opening curly braces on their own line.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
knr, allman</li>
<li>
<h5>Default</h5>
knr</li>
<li>
<h5>As labeled in the HTML tool</h5>
Style of Indent</li>
</ul>
</li>
<li id="color">
<h4>color
<strong>(node-local.js only)</strong>
</h4>
<ul>
<li>
<h5>Description</h5>
Specifies which color scheme to apply to the output file.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
canvas, shadow, white</li>
<li>
<h5>Default</h5>
white</li>
</ul>
</li>
<li id="comments">
<h4>comments</h4>
<ul>
<li>
<h5>Description</h5>
Determines whether comments should be indented. This property is only used in
beautification mode.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
indent, noindent</li>
<li>
<h5>Default</h5>
indent</li>
<li>
<h5>As labeled in the HTML tool</h5>
Indent Comments</li>
</ul>
</li>
<li id="commline">
<h4>commline</h4>
<ul>
<li>
<h5>Description</h5>
Whether a blank line should be forced above markup comments.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Force an Empty Line Above Comments</li>
</ul>
</li>
<li id="compressedcss">
<h4>compressedcss</h4>
<ul>
<li>
<h5>Description</h5>
In CSS this allows for beautified blocks and selectors but minified properties
and values to allow faster reading of large CSS code from a structured
perspective.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Compressed CSS</li>
</ul>
</li>
<li id="conditional">
<h4>conditional</h4>
<ul>
<li>
<h5>Description</h5>Retain Internet Explorer conditional HTML comments during minification of HTML.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
IE Comments, HTML Only</li>
</ul>
</li>
<li id="content">
<h4>content</h4>
<ul>
<li>
<h5>Description</h5>Determines if string literals in JavaScript and content in
markup should be normalized to a literal value of
<em>text</em>
prior to a diff operation. This property is only used if mode is set to diff.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Ignore Content, Markup / JavaScript</li>
</ul>
</li>
<li id="context">
<h4>context</h4>
<ul>
<li>
<h5>Description</h5>In the diff mode a numeric value sets the number of matching
(equivalent) lines to precede and follow each line containing a difference to
provide code context. An empty or non-numeric value returns a diff report with
all lines of code.</li>
<li>
<h5>Type</h5>
string or number</li>
<li>
<h5>Default</h5>
no value (empty string)</li>
<li>
<h5>As labeled in the HTML tool</h5>
Context size</li>
</ul>
</li>
<li id="correct">
<h4>correct</h4>
<ul>
<li>
<h5>Description</h5>
A limited attempt to automatically correct certain stylistic code problems that
JSLint complains about and missing closing list item tags in HTML. This option
will insert missing semicolons, insert missing curly braces, convert some
instances of "--" and "++" operators to "-=" and "+=" respectively, and convert
"new Object()" and "new Array()" into "{}" and "[]" respectively.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>Informational Guide</h5>
<a href="guide/jscorrect.xhtml">jscorrect option</a>
</li>
<li>
<h5>As labeled in the HTML tool</h5>
Fix Sloppy Code</li>
</ul>
</li>
<li id="crlf">
<h4>crlf</h4>
<ul>
<li>
<h5>Description</h5>
If the line termination of processed output should be Windows CRLF format. Unix
format (LF) is the default. A true value will use the JavaScript "\r\n" which
should equate to CRLF. A false value will use the JavaScript "\n" which should
equate to LF.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Line Termination</li>
</ul>
</li>
<li id="cssinsertlines">
<h4>cssinsertlines</h4>
<ul>
<li>
<h5>Description</h5>
Forces new line characters between blocks of CSS code. This option will override
option
<em>preserve</em>.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Insert Extra Lines</li>
</ul>
</li>
<li id="csvchar">
<h4>csvchar</h4>
<ul>
<li>
<h5>Description</h5>
Stores the string value used as a data separator for the
<em>"csv"</em>
language. Any string is accepted, but if value of lang property is not set to
<em>"csv"</em>
this property is ignored.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Default</h5>
, (comma)</li>
<li>
<h5>As labeled in the HTML tool</h5>
Character separator</li>
</ul>
</li>
<li id="diff">
<h4>diff</h4>
<ul>
<li>
<h5>Description</h5>
Code sample to compare the source code sample against. This property is required
when mode is set to diff, but is otherwise ignored.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Default</h5>
none</li>
<li>
<h5>As labeled in the HTML tool</h5>
New Text</li>
</ul>
</li>
<li id="diffcli">
<h4>diffcli</h4>
<ul>
<li>
<h5>Description</h5>
This option will output a list of differences similar to the Unix <em>diff</em>
command line utility. If more than one file is compared it will indicate which
files are deleted or new. If the
<em>output</em>
If the value of diffcli is true and the context option is omitted the context
option will be provided a value of 2. For additional information please read the
<a href="guide/diffcli.xhtml">diffcli guide</a>.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>Informational Guide</h5>
<a href="guide/diffcli.xhtml">Using diffcli</a>
</li>
<li>
<h5>As labeled in the HTML tool</h5>
Diff format</li>
</ul>
</li>
<li id="diffcomments">
<h4>diffcomments</h4>
<ul>
<li>
<h5>Description</h5>
Retain code comments so that code and comments can be compared by the diff
process.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Code Comments</li>
</ul>
</li>
<li id="difflabel">
<h4>difflabel</h4>
<ul>
<li>
<h5>Description</h5>
Sets a label describing the value of diff code sample.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Default</h5>
new</li>
<li>
<h5>As labeled in the HTML tool</h5>
New label (optional)</li>
</ul>
</li>
<li id="diffspaceignore">
<h4>diffspaceignore</h4>
<ul>
<li>
<h5>Description</h5>
Ignores white space only differences from the diff tool.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Ignore White Space Differences</li>
</ul>
</li>
<li id="diffview">
<h4>diffview</h4>
<ul>
<li>
<h5>Description</h5>
Determines if the diff report should be expressed is a side-by-side comparison
or a single column inline view.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
sidebyside, inline</li>
<li>
<h5>Default</h5>
sidebyside</li>
<li>
<h5>As labeled in the HTML tool</h5>
Diff View Type</li>
</ul>
</li>
<li id="dustjs">
<h4>dustjs</h4>
<ul>
<li>
<h5>Description</h5>
Presume the provided markup code is a Dust.js template. This option is for
internal use only and is automatically enabled if language value is
<em>dustjs</em>
or if the Dust.js language is detected from auto-detection.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Dust.js Template</li>
</ul>
</li>
<li id="elseline">
<h4>elseline</h4>
<ul>
<li>
<h5>Description</h5>
If the "else" keyword should be pushed onto a new line in JavaScript
beautification.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Else on New Line</li>
</ul>
</li>
<li id="endcomma">
<h4>endcomma</h4>
<ul>
<li>
<h5>Description</h5>
If a terminating comma should be inserted into arrays, object literals, and
destructured objects. The <em>multiline</em> value forces terminating commas but only to objects and arrays that are beautified to more than one line. As a result the multiline value is only available to beautify and diff modes and it behaves identically to the <em>never</em> value during parse time.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
always, multiline, never</li>
<li>
<h5>Default</h5>
never</li>
<li>
<h5>As labeled in the HTML tool</h5>
Trailing Commas</li>
</ul>
</li>
<li id="endquietly">
<h4>endquietly
<strong>(node-local.js only)</strong>
</h4>
<ul>
<li>
<h5>Description</h5>
Determines whether terminal logging should be printed to the console.
<em>quite</em>
- Suppresses terminal logging.
<em>log</em>
- Forces terminal logging. The default setting surpresses terminal logging if
readmethod is file or filescreen.
</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
quiet, log, any other string</li>
<li>
<h5>Default</h5>
(empty string)</li>
</ul>
</li>
<li id="force_attribute">
<h4>force_attribute</h4>
<ul>
<li>
<h5>Description</h5>
Forces all markup attributes to be indented each on their own line of code.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Force Attribute Indentation</li>
</ul>
</li>
<li id="force_indent">
<h4>force_indent</h4>
<ul>
<li>
<h5>Description</h5>
Allows every piece of code and content in a markup language to be indented
without regard for the creation of white space tokens or code semantics.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Force Indentation</li>
</ul>
</li>
<li id="formatArray">
<h4>formatArray</h4>
<ul>
<li>
<h5>Description</h5>
Determines whether JavaScript array indexes should always indented, remain on a
single line, or left to the default formatting.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
default, indent, inline</li>
<li>
<h5>Default</h5>
default</li>
<li>
<h5>As labeled in the HTML tool</h5>
Formatting Arrays</li>
</ul>
</li>
<li id="formatObject">
<h4>formatObject</h4>
<ul>
<li>
<h5>Description</h5>
Determines whether JavaScript object properties should always indented, remain
on a single line, or left to the default formatting.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
default, indent, inline</li>
<li>
<h5>Default</h5>
default</li>
<li>
<h5>As labeled in the HTML tool</h5>
Formatting Object Literals</li>
</ul>
</li>
<li id="functionname">
<h4>functionname</h4>
<ul>
<li>
<h5>Description</h5>
Wether a space should occur between a function name and the arguments parenthesis.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Space After Function Name</li>
</ul>
</li>
<li id="help">
<h4>help
<strong>(node-local.js only)</strong>
</h4>
<ul>
<li>
<h5>Description</h5>
Displays documenation to the command line or console.</li>
</ul>
</li>
<li id="html">
<h4>html</h4>
<ul>
<li>
<h5>Description</h5>
Forces markup code to be interpreted as HTML. HTML mode identifies certain tags
as singletons by tag name even if they are no closed with "/>" syntax. It also
ignores beautification on "<pre>" elements and tolerates "<li>"
elements that do not a closing "</li>" tag. This option will be
automatically assigned a value of true if the lang option is provided a value of
"auto" and the code can be identified as HTML.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
Presume HTML</li>
</ul>
</li>
<li id="inchar">
<h4>inchar</h4>
<ul>
<li>
<h5>Description</h5>
Stores the character literal used for an indentation. A single indentation is
the result of this value repeated the number of times specified in the insize
option.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Default</h5>
(a single space)</li>
<li>
<h5>As labeled in the HTML tool</h5>
Indentation character</li>
</ul>
</li>
<li id="inlevel">
<h4>inlevel</h4>
<ul>
<li>
<h5>Description</h5>
Pads JavaScript and markup beautification with additional indentation. Useful in
the case of submitting code to a markdown format that identifies code by a
padding of 4 spaces for each code line.</li>
<li>
<h5>Type</h5>
number</li>
<li>
<h5>Default</h5>
0</li>
<li>
<h5>As labeled in the HTML tool</h5>
Code padding, Markup / JavaScript</li>
</ul>
</li>
<li id="insize">
<h4>insize</h4>
<ul>
<li>
<h5>Description</h5>
Stores the number of times the inchar value must repeat to comprise a single
indentation.</li>
<li>
<h5>Type</h5>
number</li>
<li>
<h5>Default</h5>
4</li>
<li>
<h5>As labeled in the HTML tool</h5>
Indentation size</li>
</ul>
</li>
<li id="jekyll">
<h4>jekyll</h4>
<ul>
<li>
<h5>Description</h5>
If YAML Jekyll HTML template comments should be supported.</li>
<li>
<h5>Type</h5>
boolean</li>
<li>
<h5>Default</h5>
false</li>
<li>
<h5>As labeled in the HTML tool</h5>
YAML Jekyll Support</li>
</ul>
</li>
<li id="jsscope">
<h4>jsscope</h4>
<ul>
<li>
<h5>Description</h5>
Produce HTML output for JavaScript beautification that colors variables based
upon their scope of declaration. Using colors this feature highlights
inheritance, scope depth, and closure. The value "none" turns this feature off.
The value "html" creates a formatted HTML code sample for displaying HTML code
samples on web pages. The value "report" creates the code for a complete HTML
file. For additional information please read the
<a href="guide/closure_with_jsscope.xhtml">jsscope guide</a>
and the
<a href="guide/jshtml.xhtml">jshtml guide</a>.</li>
<li>
<h5>Type</h5>
string</li>
<li>
<h5>Accepted values</h5>
none, html, report</li>
<li>
<h5>Default</h5>
none</li>
<li>
<h5>Informational Guide</h5>
<a href="guide/closure_with_jsscope.xhtml">jsscope features</a>
and
<a href="guide/jshtml.xhtml">saving colorful code as HTML</a>
</li>
<li>
<h5>As labeled in the HTML tool</h5>
Scope Analysis</li>
</ul>
</li>
<li id="lang">