Options
All
  • Public
  • Public/Protected
  • All
Menu

Comment Type Html

BUILD_INCLUDE

<!-- BUILD_INCLUDE("./includes/replace01.txt") -->

File replace01.txt is to be included in output file.

Config

const bp = new BuildProcess();
const opt = {
  "match": {
    "kind": "buildIncludeHtml"
  },
  "comment": {
    "type": "html"
  },
  "breakstring": {
    "width": 70,
    "flags": "word"
  }
};
const results = bp.buildInclude('','./includes/test.txt', opt);

Output

<!--
The quick, brown fox jumps over a lazy dog. DJs flock by when MTV ax quiz
prog. Junk MTV quiz graced by fox whelps.Bawds jog, flick quartz, vex
nymphs. Waltz, bad nymph, for quick jigs vex! Fox nymphs grab quick-jived
waltz. Brick quiz whangs jumpy veldt fox.Bright vixens jump; dozy fowl
quack. Quick wafting zephyrs vex bold Jim. Quick zephyrs blow, vexing
daft Jim. Sex-charged fop blew my junk TV quiz.How quickly daft jumping
zebras vex. Two driven jocks help fax my big quiz. Quick, Baz, get my
woven flax jodhpurs! "Now fax quiz Jack!" my brave ghost pled. Five quacking
zephyrs jolt my wax bed. Flummoxed by job, kvetching W. zaps Iraq. Cozy
sphinx waves quart jug of bad milk.A very bad quack might jinx zippy fowls.
Few quips galvanized the mock jury box. Quick brown dogs jump over the
lazy fox. The jay, pig, fox, zebra, and my wolves quack!Blowzy red vixens
fight for a quick jump. Joaquin Phoenix was gazed by MTV for luck. A wizard’s
job is to vex chumps quickly in fog. Watch "Jeopardy! ", Alex Trebek's
fun TV quiz game. Woven silk pyjamas exchanged for blue quartz.
-->

Options

buildIncludeHtml

match: {kind: "buildIncludeHtml"}

<!--BUILD_INCLUDE(filePath)-->
<!--BUILD_INCLUDE(filePath)[options]-->
<!--BUILD_INCLUDE(filePath)
[options]-->

See Also: enum regexkind

Comment

The option comments allow for input file content to be treated as comments in the output.

Comment Type HTML

{comment" {type: "html")} or inline comment?type=html
Wraps input in <!-- and --> comment marks.
Single-line input will result in a single line output. Multi-line input will result in multi-line output.

Example:
Single-line

<!-- my single line comments -->

Multi-line

<!--
my multi line comments
comments continue on this line
-->

See: Enum values for commentkind for possible types.

See Example

Comment Type Html

Breakstring

The various options of breakstring allow for the breaking of lines in different ways.
If the width option of breakstring is not set then width defaults to 80.

See: Interface for IOpt.breakstring

Breakstring Width

{breakstring: { width: 80 }} or inline breakstring?Width=80 where as 80 is the number of characters to break on, determines that each line will be broken as close to number characers as possible depending other breakstring options.

Breakstring Flags Word

{breakstring: {flag: "word"}} or inline breakstring?flags=word
Determines that lines are not to be broken on a word.

{match:{kind: "buildIncludeHtml" }}

Matches the following

<!--BUILD_INCLUDE(filePath)-->
<!--BUILD_INCLUDE(filePath)[options]-->
<--BUILD_INCLUDE(filePath)
[options]-->

See Also: Class MatchBuildIncludeHtml

See Also: IOpt
See Also: regexKind for match kind options.

Generated using TypeDoc