-
-
Notifications
You must be signed in to change notification settings - Fork 493
/
Eleventy.js
1472 lines (1219 loc) · 39.1 KB
/
Eleventy.js
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
import chalk from "kleur";
import { performance } from "node:perf_hooks";
import debugUtil from "debug";
import { filesize } from "filesize";
import { TemplatePath } from "@11ty/eleventy-utils";
import BundlePlugin from "@11ty/eleventy-plugin-bundle";
import TemplateData from "./Data/TemplateData.js";
import TemplateWriter from "./TemplateWriter.js";
import EleventyExtensionMap from "./EleventyExtensionMap.js";
import { EleventyErrorHandler } from "./Errors/EleventyErrorHandler.js";
import EleventyBaseError from "./Errors/EleventyBaseError.js";
import EleventyServe from "./EleventyServe.js";
import EleventyWatch from "./EleventyWatch.js";
import EleventyWatchTargets from "./EleventyWatchTargets.js";
import EleventyFiles from "./EleventyFiles.js";
import ConsoleLogger from "./Util/ConsoleLogger.js";
import PathPrefixer from "./Util/PathPrefixer.js";
import TemplateConfig from "./TemplateConfig.js";
import FileSystemSearch from "./FileSystemSearch.js";
import ProjectDirectories from "./Util/ProjectDirectories.js";
import PathNormalizer from "./Util/PathNormalizer.js";
import { isGlobMatch } from "./Util/GlobMatcher.js";
import simplePlural from "./Util/Pluralize.js";
import checkPassthroughCopyBehavior from "./Util/PassthroughCopyBehaviorCheck.js";
import eventBus from "./EventBus.js";
import { getEleventyPackageJson, getWorkingProjectPackageJson } from "./Util/ImportJsonSync.js";
import { EleventyImport } from "./Util/Require.js";
import RenderPlugin, * as RenderPluginExtras from "./Plugins/RenderPlugin.js";
import I18nPlugin, * as I18nPluginExtras from "./Plugins/I18nPlugin.js";
import HtmlBasePlugin, * as HtmlBasePluginExtras from "./Plugins/HtmlBasePlugin.js";
import { TransformPlugin as InputPathToUrlTransformPlugin } from "./Plugins/InputPathToUrl.js";
import { IdAttributePlugin } from "./Plugins/IdAttributePlugin.js";
import ProjectTemplateFormats from "./Util/ProjectTemplateFormats.js";
import EventBusUtil from "./Util/EventBusUtil.js";
const pkg = getEleventyPackageJson();
const debug = debugUtil("Eleventy");
/**
* Eleventy’s programmatic API
* @module 11ty/eleventy/Eleventy
*
* This line is required for IDE autocomplete in config files
* @typedef {import('./UserConfig.js').default} UserConfig
*/
class Eleventy {
/**
* Userspace package.json file contents
* @type {object|undefined}
*/
#projectPackageJson;
/** @type {ProjectTemplateFormats|undefined} */
#templateFormats;
/** @type {ConsoleLogger|undefined} */
#logger;
/** @type {ProjectDirectories|undefined} */
#directories;
/** @type {boolean|undefined} */
#verboseOverride;
/** @type {boolean} */
#isVerboseMode = true;
/** @type {boolean|undefined} */
#preInitVerbose;
/** @type {boolean} */
#hasConfigInitialized = false;
/** @type {boolean} */
#needsInit = true;
/** @type {Promise|undefined} */
#initPromise;
/** @type {EleventyErrorHandler|undefined} */
#errorHandler;
/** @type {Map} */
#privateCaches = new Map();
/** @type {boolean} */
#isStopping = false;
/** @type {boolean|undefined} */
#isEsm;
/**
* @typedef {object} EleventyOptions
* @property {'cli'|'script'=} source
* @property {'build'|'serve'|'watch'=} runMode
* @property {boolean=} dryRun
* @property {string=} configPath
* @property {string=} pathPrefix
* @property {boolean=} quietMode
* @property {Function=} config
* @property {string=} inputDir
* @param {string} [input] - Directory or filename for input/sources files.
* @param {string} [output] - Directory serving as the target for writing the output files.
* @param {EleventyOptions} [options={}]
* @param {TemplateConfig} [eleventyConfig]
*/
constructor(input, output, options = {}, eleventyConfig = null) {
/**
* @type {string|undefined}
* @description Holds the path to the input (might be a file or folder)
*/
this.rawInput = input || undefined;
/**
* @type {string|undefined}
* @description holds the path to the output directory
*/
this.rawOutput = output || undefined;
/**
* @type {module:11ty/eleventy/TemplateConfig}
* @description Override the config instance (for centralized config re-use)
*/
this.eleventyConfig = eleventyConfig;
/**
* @type {EleventyOptions}
* @description Options object passed to the Eleventy constructor
* @default {}
*/
this.options = options;
/**
* @type {'cli'|'script'}
* @description Called via CLI (`cli`) or Programmatically (`script`)
* @default "script"
*/
this.source = options.source || "script";
/**
* @type {string}
* @description One of build, serve, or watch
* @default "build"
*/
this.runMode = options.runMode || "build";
/**
* @type {boolean}
* @description Is Eleventy running in dry mode?
* @default false
*/
this.isDryRun = options.dryRun ?? false;
/**
* @type {boolean}
* @description Is this an incremental build? (only operates on a subset of input files)
* @default false
*/
this.isIncremental = false;
/**
* @type {string|undefined}
* @description If an incremental build, this is the file we’re operating on.
* @default null
*/
this.programmaticApiIncrementalFile = undefined;
/**
* @type {boolean}
* @description Should we process files on first run? (The --ignore-initial feature)
* @default true
*/
this.isRunInitialBuild = true;
/**
* @type {Number}
* @description Number of builds run on this instance.
* @default 0
*/
this.buildCount = 0;
/**
* @member {String} - Force ESM or CJS mode instead of detecting from package.json. Either cjs, esm, or auto.
* @default "auto"
*/
this.loader = this.options.loader ?? "auto";
/**
* @type {Number}
* @description The timestamp of Eleventy start.
*/
this.start = this.getNewTimestamp();
}
/**
* @type {string|undefined}
* @description An override of Eleventy's default config file paths
* @default undefined
*/
get configPath() {
return this.options.configPath;
}
/**
* @type {string}
* @description The top level directory the site pretends to reside in
* @default "/"
*/
get pathPrefix() {
return this.options.pathPrefix || "/";
}
async initializeConfig(initOverrides) {
if (!this.eleventyConfig) {
this.eleventyConfig = new TemplateConfig(null, this.configPath);
} else if (this.configPath) {
await this.eleventyConfig.setProjectConfigPath(this.configPath);
}
this.eleventyConfig.setRunMode(this.runMode);
this.eleventyConfig.setProjectUsingEsm(this.isEsm);
this.eleventyConfig.setLogger(this.logger);
this.eleventyConfig.setDirectories(this.directories);
this.eleventyConfig.setTemplateFormats(this.templateFormats);
if (this.pathPrefix || this.pathPrefix === "") {
this.eleventyConfig.setPathPrefix(this.pathPrefix);
}
// Debug mode should always run quiet (all output goes to debug logger)
if (process.env.DEBUG) {
this.#verboseOverride = false;
} else if (this.options.quietMode === true || this.options.quietMode === false) {
this.#verboseOverride = !this.options.quietMode;
}
// Moved before config merges: https://github.com/11ty/eleventy/issues/3316
if (this.#verboseOverride === true || this.#verboseOverride === false) {
this.eleventyConfig.userConfig._setQuietModeOverride(!this.#verboseOverride);
}
this.eleventyConfig.userConfig.directories = this.directories;
/* Programmatic API config */
if (this.options.config && typeof this.options.config === "function") {
debug("Running options.config configuration callback (passed to Eleventy constructor)");
// TODO use return object here?
await this.options.config(this.eleventyConfig.userConfig);
}
/**
* @type {object}
* @description Initialize Eleventy environment variables
* @default null
*/
// this.runMode need to be set before this
this.env = this.getEnvironmentVariableValues();
this.initializeEnvironmentVariables(this.env);
// Async initialization of configuration
await this.eleventyConfig.init(initOverrides);
/**
* @type {object}
* @description Initialize Eleventy’s configuration, including the user config file
*/
this.config = this.eleventyConfig.getConfig();
/**
* @type {object}
* @description Singleton BenchmarkManager instance
*/
this.bench = this.config.benchmarkManager;
if (performance) {
debug("Eleventy warm up time: %o (ms)", performance.now());
}
/** @type {object} */
this.eleventyServe = new EleventyServe();
this.eleventyServe.eleventyConfig = this.eleventyConfig;
/** @type {object} */
this.watchManager = new EleventyWatch();
/** @type {object} */
this.watchTargets = new EleventyWatchTargets(this.eleventyConfig);
this.watchTargets.addAndMakeGlob(this.config.additionalWatchTargets);
/** @type {object} */
this.fileSystemSearch = new FileSystemSearch();
this.#hasConfigInitialized = true;
this.setIsVerbose(this.#preInitVerbose ?? !this.config.quietMode);
}
getNewTimestamp() {
if (performance) {
return performance.now();
}
return new Date().getTime();
}
/** @type {ProjectDirectories} */
get directories() {
if (!this.#directories) {
this.#directories = new ProjectDirectories();
this.#directories.setInput(this.rawInput, this.options.inputDir);
this.#directories.setOutput(this.rawOutput);
if (this.source == "cli" && (this.rawInput !== undefined || this.rawOutput !== undefined)) {
this.#directories.freeze();
}
}
return this.#directories;
}
/** @type {string} */
get input() {
return this.directories.inputFile || this.directories.input || this.config.dir.input;
}
/** @type {string} */
get inputFile() {
return this.directories.inputFile;
}
/** @type {string} */
get inputDir() {
return this.directories.input;
}
// Not used internally, removed in 3.0.
setInputDir() {
throw new Error(
"Eleventy->setInputDir was removed in 3.0. Use the inputDir option to the constructor",
);
}
/** @type {string} */
get outputDir() {
return this.directories.output || this.config.dir.output;
}
/**
* Updates the dry-run mode of Eleventy.
*
* @param {boolean} isDryRun - Shall Eleventy run in dry mode?
*/
setDryRun(isDryRun) {
this.isDryRun = !!isDryRun;
}
/**
* Sets the incremental build mode.
*
* @param {boolean} isIncremental - Shall Eleventy run in incremental build mode and only write the files that trigger watch updates
*/
setIncrementalBuild(isIncremental) {
this.isIncremental = !!isIncremental;
if (this.watchManager) {
this.watchManager.incremental = !!isIncremental;
}
if (this.writer) {
this.writer.setIncrementalBuild(this.isIncremental);
}
}
/**
* Set whether or not to do an initial build
*
* @param {boolean} ignoreInitialBuild - Shall Eleventy ignore the default initial build before watching in watch/serve mode?
* @default true
*/
setIgnoreInitial(ignoreInitialBuild) {
this.isRunInitialBuild = !ignoreInitialBuild;
if (this.writer) {
this.writer.setRunInitialBuild(this.isRunInitialBuild);
}
}
/**
* Updates the path prefix used in the config.
*
* @param {string} pathPrefix - The new path prefix.
*/
setPathPrefix(pathPrefix) {
if (pathPrefix || pathPrefix === "") {
this.eleventyConfig.setPathPrefix(pathPrefix);
// TODO reset config
// this.config = this.eleventyConfig.getConfig();
}
}
/**
* Restarts Eleventy.
*/
async restart() {
debug("Restarting");
this.start = this.getNewTimestamp();
this.bench.reset();
this.eleventyFiles.restart();
this.extensionMap.reset();
}
/**
* Logs some statistics after a complete run of Eleventy.
*
* @returns {string} ret - The log message.
*/
logFinished() {
if (!this.writer) {
throw new Error(
"Did you call Eleventy.init to create the TemplateWriter instance? Hint: you probably didn’t.",
);
}
let ret = [];
// files that render (costly) but do not write to disk
// let renderCount = this.writer.getRenderCount();
let writeCount = this.writer.getWriteCount();
let skippedCount = this.writer.getSkippedCount();
let copyCount = this.writer.getCopyCount();
let slashRet = [];
if (copyCount) {
debug("Total passthrough copy aggregate size: %o", filesize(this.writer.getCopySize()));
slashRet.push(`Copied ${chalk.bold(copyCount)}`);
}
slashRet.push(
`Wrote ${chalk.bold(writeCount)} ${simplePlural(writeCount, "file", "files")}${
skippedCount ? ` (skipped ${skippedCount})` : ""
}`,
);
if (slashRet.length) {
ret.push(slashRet.join(" "));
}
let time = (this.getNewTimestamp() - this.start) / 1000;
ret.push(
`in ${chalk.bold(time.toFixed(2))} ${simplePlural(time.toFixed(2), "second", "seconds")}`,
);
// More than 1 second total, show estimate of per-template time
if (time >= 1 && writeCount > 0) {
ret.push(`(${((time * 1000) / writeCount).toFixed(1)}ms each, v${pkg.version})`);
} else {
ret.push(`(v${pkg.version})`);
}
return ret.join(" ");
}
#cache(key, inst) {
if (!("caches" in inst)) {
throw new Error("To use #cache you need a `caches` getter object");
}
// Restore from cache
if (this.#privateCaches.has(key)) {
let c = this.#privateCaches.get(key);
for (let cacheKey in c) {
inst[cacheKey] = c[cacheKey];
}
} else {
// Set cache
let c = {};
for (let cacheKey of inst.caches || []) {
c[cacheKey] = inst[cacheKey];
}
this.#privateCaches.set(key, c);
}
}
/**
* Starts Eleventy.
*/
async init(options = {}) {
options = Object.assign({ viaConfigReset: false }, options);
if (!this.#hasConfigInitialized) {
await this.initializeConfig();
}
await this.config.events.emit("eleventy.config", this.eleventyConfig);
if (this.env) {
await this.config.events.emit("eleventy.env", this.env);
}
let formats = this.templateFormats.getTemplateFormats();
this.extensionMap = new EleventyExtensionMap(this.eleventyConfig);
this.extensionMap.setFormats(formats);
await this.config.events.emit("eleventy.extensionmap", this.extensionMap);
// eleventyServe is always available, even when not in --serve mode
// TODO directorynorm
this.eleventyServe.setOutputDir(this.outputDir);
// TODO
// this.eleventyServe.setWatcherOptions(this.getChokidarConfig());
this.templateData = new TemplateData(this.eleventyConfig);
this.templateData.setProjectUsingEsm(this.isEsm);
this.templateData.extensionMap = this.extensionMap;
if (this.env) {
this.templateData.environmentVariables = this.env;
}
this.templateData.setFileSystemSearch(this.fileSystemSearch);
this.eleventyFiles = new EleventyFiles(formats, this.eleventyConfig);
this.eleventyFiles.setFileSystemSearch(this.fileSystemSearch);
this.eleventyFiles.setRunMode(this.runMode);
this.eleventyFiles.extensionMap = this.extensionMap;
// This needs to be set before init or it’ll construct a new one
this.eleventyFiles.templateData = this.templateData;
this.eleventyFiles.init();
if (checkPassthroughCopyBehavior(this.config, this.runMode)) {
this.eleventyServe.watchPassthroughCopy(
this.eleventyFiles.getGlobWatcherFilesForPassthroughCopy(),
);
}
// Note these directories are all project root relative
this.config.events.emit("eleventy.directories", this.directories.getUserspaceInstance());
this.writer = new TemplateWriter(formats, this.templateData, this.eleventyConfig);
if (!options.viaConfigReset) {
// set or restore cache
this.#cache("TemplateWriter", this.writer);
}
this.writer.logger = this.logger;
this.writer.extensionMap = this.extensionMap;
this.writer.setEleventyFiles(this.eleventyFiles);
this.writer.setRunInitialBuild(this.isRunInitialBuild);
this.writer.setIncrementalBuild(this.isIncremental);
let debugStr = `Directories:
Input:
Directory: ${this.directories.input}
File: ${this.directories.inputFile || false}
Glob: ${this.directories.inputGlob || false}
Data: ${this.directories.data}
Includes: ${this.directories.includes}
Layouts: ${this.directories.layouts || false}
Output: ${this.directories.output}
Template Formats: ${formats.join(",")}
Verbose Output: ${this.verboseMode}`;
debug(debugStr);
this.writer.setVerboseOutput(this.verboseMode);
this.writer.setDryRun(this.isDryRun);
this.#needsInit = false;
}
// These are all set as initial global data under eleventy.env.* (see TemplateData->environmentVariables)
getEnvironmentVariableValues() {
let values = {
source: this.source,
runMode: this.runMode,
};
let configPath = this.eleventyConfig.getLocalProjectConfigFile();
if (configPath) {
let absolutePathToConfig = TemplatePath.absolutePath(configPath);
values.config = absolutePathToConfig;
// TODO(zachleat): if config is not in root (e.g. using --config=)
let root = TemplatePath.getDirFromFilePath(absolutePathToConfig);
values.root = root;
}
values.source = this.source;
// Backwards compatibility
Object.defineProperty(values, "isServerless", {
enumerable: false,
value: false,
});
return values;
}
/**
* Set process.ENV variables for use in Eleventy projects
*
* @method
*/
initializeEnvironmentVariables(env) {
// Recognize that global data `eleventy.version` is coerced to remove prerelease tags
// and this is the raw version (3.0.0 versus 3.0.0-alpha.6).
// `eleventy.env.version` does not yet exist (unnecessary)
process.env.ELEVENTY_VERSION = Eleventy.getVersion();
process.env.ELEVENTY_ROOT = env.root;
debug("Setting process.env.ELEVENTY_ROOT: %o", env.root);
process.env.ELEVENTY_SOURCE = env.source;
process.env.ELEVENTY_RUN_MODE = env.runMode;
}
/** @param {boolean} value */
set verboseMode(value) {
this.setIsVerbose(value);
}
/** @type {boolean} */
get verboseMode() {
return this.#isVerboseMode;
}
/** @type {ConsoleLogger} */
get logger() {
if (!this.#logger) {
this.#logger = new ConsoleLogger();
this.#logger.isVerbose = this.verboseMode;
}
return this.#logger;
}
/** @param {ConsoleLogger} logger */
set logger(logger) {
this.eleventyConfig.setLogger(logger);
this.#logger = logger;
}
disableLogger() {
this.logger.overrideLogger(false);
}
/** @type {EleventyErrorHandler} */
get errorHandler() {
if (!this.#errorHandler) {
this.#errorHandler = new EleventyErrorHandler();
this.#errorHandler.isVerbose = this.verboseMode;
this.#errorHandler.logger = this.logger;
}
return this.#errorHandler;
}
/**
* Updates the verbose mode of Eleventy.
*
* @method
* @param {boolean} isVerbose - Shall Eleventy run in verbose mode?
*/
setIsVerbose(isVerbose) {
if (!this.#hasConfigInitialized) {
this.#preInitVerbose = !!isVerbose;
return;
}
// always defer to --quiet if override happened
isVerbose = this.#verboseOverride ?? !!isVerbose;
this.#isVerboseMode = isVerbose;
if (this.logger) {
this.logger.isVerbose = isVerbose;
}
this.bench.setVerboseOutput(isVerbose);
if (this.writer) {
this.writer.setVerboseOutput(isVerbose);
}
if (this.errorHandler) {
this.errorHandler.isVerbose = isVerbose;
}
// Set verbose mode in config file
this.eleventyConfig.verbose = isVerbose;
}
get templateFormats() {
if (!this.#templateFormats) {
let tf = new ProjectTemplateFormats();
this.#templateFormats = tf;
}
return this.#templateFormats;
}
/**
* Updates the template formats of Eleventy.
*
* @method
* @param {string} formats - The new template formats.
*/
setFormats(formats) {
this.templateFormats.setViaCommandLine(formats);
}
/**
* Updates the run mode of Eleventy.
*
* @method
* @param {string} runMode - One of "build", "watch", or "serve"
*/
setRunMode(runMode) {
this.runMode = runMode;
}
/**
* Set the file that needs to be rendered/compiled/written for an incremental build.
* This method is also wired up to the CLI --incremental=incrementalFile
*
* @method
* @param {string} incrementalFile - File path (added or modified in a project)
*/
setIncrementalFile(incrementalFile) {
if (incrementalFile) {
// This used to also setIgnoreInitial(true) but was changed in 3.0.0-alpha.14
this.setIncrementalBuild(true);
this.programmaticApiIncrementalFile = TemplatePath.addLeadingDotSlash(incrementalFile);
}
}
unsetIncrementalFile() {
// only applies to initial build, no re-runs (--watch/--serve)
if (this.programmaticApiIncrementalFile) {
// this.setIgnoreInitial(false);
this.programmaticApiIncrementalFile = undefined;
}
// reset back to false
this.setIgnoreInitial(false);
}
/**
* Reads the version of Eleventy.
*
* @static
* @returns {string} - The version of Eleventy.
*/
static getVersion() {
return pkg.version;
}
/**
* @deprecated since 1.0.1, use static Eleventy.getVersion()
*/
getVersion() {
return Eleventy.getVersion();
}
/**
* Shows a help message including usage.
*
* @static
* @returns {string} - The help message.
*/
static getHelp() {
return `Usage: eleventy
eleventy --input=. --output=./_site
eleventy --serve
Arguments:
--version
--input=.
Input template files (default: \`.\`)
--output=_site
Write HTML output to this folder (default: \`_site\`)
--serve
Run web server on --port (default 8080) and watch them too
--port
Run the --serve web server on this port (default 8080)
--watch
Wait for files to change and automatically rewrite (no web server)
--incremental
Only build the files that have changed. Best with watch/serve.
--incremental=filename.md
Does not require watch/serve. Run an incremental build targeting a single file.
--ignore-initial
Start without a build; build when files change. Works best with watch/serve/incremental.
--formats=liquid,md
Allow only certain template types (default: \`*\`)
--quiet
Don’t print all written files (off by default)
--config=filename.js
Override the eleventy config file path (default: \`.eleventy.js\`)
--pathprefix='/'
Change all url template filters to use this subdirectory.
--dryrun
Don’t write any files. Useful in DEBUG mode, for example: \`DEBUG=Eleventy* npx @11ty/eleventy --dryrun\`
--loader
Set to "esm" to force ESM mode, "cjs" to force CommonJS mode, or "auto" (default) to infer it from package.json.
--to=json
--to=ndjson
Change the output to JSON or NDJSON (default: \`fs\`)
--help`;
}
/**
* @deprecated since 1.0.1, use static Eleventy.getHelp()
*/
getHelp() {
return Eleventy.getHelp();
}
/**
* Resets the config of Eleventy.
*
* @method
*/
async resetConfig() {
this.env = this.getEnvironmentVariableValues();
this.initializeEnvironmentVariables(this.env);
await this.eleventyConfig.reset();
this.config = this.eleventyConfig.getConfig();
this.eleventyServe.eleventyConfig = this.eleventyConfig;
this.setIsVerbose(!this.config.quietMode);
EventBusUtil.resetForConfig();
}
/**
* @param {string} changedFilePath - File that triggered a re-run (added or modified)
* @param {boolean} [isResetConfig] - are we doing a config reset
*/
async #addFileToWatchQueue(changedFilePath, isResetConfig) {
// Currently this is only for 11ty.js deps but should be extended with usesGraph
let usedByDependants = [];
if (this.watchTargets) {
usedByDependants = this.watchTargets.getDependantsOf(
TemplatePath.addLeadingDotSlash(changedFilePath),
);
}
let relevantLayouts = this.eleventyConfig.usesGraph.getLayoutsUsedBy(changedFilePath);
// Note: these are sync events!
// `templateModified` is an alias for resourceModified but all listeners for this are cleared out when the config is reset.
eventBus.emit("eleventy.templateModified", changedFilePath, {
usedByDependants,
relevantLayouts,
});
eventBus.emit("eleventy.resourceModified", changedFilePath, usedByDependants, {
viaConfigReset: isResetConfig,
relevantLayouts,
});
this.watchManager.addToPendingQueue(changedFilePath);
}
shouldTriggerConfigReset(changedFiles) {
let configFilePaths = new Set(this.eleventyConfig.getLocalProjectConfigFiles());
let resetConfigGlobs = EleventyWatchTargets.normalizeToGlobs(
Array.from(this.eleventyConfig.userConfig.watchTargetsConfigReset),
);
for (let filePath of changedFiles) {
if (configFilePaths.has(filePath)) {
return true;
}
if (isGlobMatch(filePath, resetConfigGlobs)) {
return true;
}
}
for (const configFilePath of configFilePaths) {
// Any dependencies of the config file changed
let configFileDependencies = new Set(this.watchTargets.getDependenciesOf(configFilePath));
for (let filePath of changedFiles) {
if (configFileDependencies.has(filePath)) {
return true;
}
}
}
return false;
}
// Checks the build queue to see if any configuration related files have changed
#shouldResetConfig(activeQueue = []) {
if (!activeQueue.length) {
return false;
}
return this.shouldTriggerConfigReset(
activeQueue.map((path) => {
return PathNormalizer.normalizeSeperator(TemplatePath.addLeadingDotSlash(path));
}),
);
}
async #watch(isResetConfig = false) {
if (this.watchManager.isBuildRunning()) {
return;
}
this.watchManager.setBuildRunning();
let queue = this.watchManager.getActiveQueue();
await this.config.events.emit("beforeWatch", queue);
await this.config.events.emit("eleventy.beforeWatch", queue);
// Clear `import` cache for all files that triggered the rebuild (sync event)
this.watchTargets.clearImportCacheFor(queue);
// reset and reload global configuration
if (isResetConfig) {
// important: run this before config resets otherwise the handlers will disappear.
await this.config.events.emit("eleventy.reset");
await this.resetConfig();
}
await this.restart();
await this.init({ viaConfigReset: isResetConfig });
try {
let [, /*passthroughCopyResults*/ templateResults] = await this.write();
this.watchTargets.reset();
await this.#initWatchDependencies();
// Add new deps to chokidar
this.watcher.add(this.watchTargets.getNewTargetsSinceLastReset());
// Is a CSS input file and is not in the includes folder
// TODO check output path file extension of this template (not input path)
// TODO add additional API for this, maybe a config callback?
let onlyCssChanges = this.watchManager.hasAllQueueFiles((path) => {
return (
path.endsWith(".css") &&
// TODO how to make this work with relative includes?
!TemplatePath.startsWithSubPath(path, this.eleventyFiles.getIncludesDir())
);
});
let normalizedPathPrefix = PathPrefixer.normalizePathPrefix(this.config.pathPrefix);
await this.eleventyServe.reload({
files: this.watchManager.getActiveQueue(),
subtype: onlyCssChanges ? "css" : undefined,
build: {
templates: templateResults
.flat()
.filter((entry) => !!entry)
.map((entry) => {
entry.url = PathPrefixer.joinUrlParts(normalizedPathPrefix, entry.url);
return entry;
}),
},
});
} catch (error) {
this.eleventyServe.sendError({
error,
});
}
this.watchManager.setBuildFinished();
let queueSize = this.watchManager.getPendingQueueSize();
if (queueSize > 0) {
this.logger.log(
`You saved while Eleventy was running, let’s run again. (${queueSize} change${
queueSize !== 1 ? "s" : ""
})`,
);
await this.#watch();
} else {
this.logger.log("Watching…");
}
}
/**
* @returns {module:11ty/eleventy/src/Benchmark/BenchmarkGroup~BenchmarkGroup}