11ty#1028 11ty#1029 Possible first implementation for additional defa…

…ult eleventy config files

Currently only .eleventy.js is supported as the default config file.

This PR implements a possible solution for multiple config file. It intentionally just implements support for multiple default config files.

The implementation might be a little flaky around unittests, but it passes all of them consistently.

A future PR should probably look into allowing usage of multiple config files at once. This only uses the first existing one.

Signed-off-by: Raphael Höser <raphael@hoeser.info>

src/Eleventy.js

@@ -652,21 +652,23 @@ Arguments:
   }
 
   _shouldResetConfig() {
-    let configFilePath = this.eleventyConfig.getLocalProjectConfigFile();
-    let configFileChanged = this.watchManager.hasQueuedFile(configFilePath);
-    if (configFileChanged) {
+    let configFilePaths = this.eleventyConfig.getLocalProjectConfigFiles();
+    let configFilesChanged = this.watchManager.hasQueuedFiles(configFilePaths);
+    if (configFilesChanged) {
       return true;
     }
 
-    // Any dependencies of the config file changed
-    let configFileDependencies =
-      this.watchTargets.getDependenciesOf(configFilePath);
-    for (let dep of configFileDependencies) {
-      if (this.watchManager.hasQueuedFile(dep)) {
-        // Delete from require cache so that updates to the module are re-required
-        deleteRequireCache(TemplatePath.absolutePath(dep));
+    for (const configFilePath of configFilePaths) {
+      // Any dependencies of the config file changed
+      let configFileDependencies =
+        this.watchTargets.getDependenciesOf(configFilePath);
+      for (let dep of configFileDependencies) {
+        if (this.watchManager.hasQueuedFile(dep)) {
+          // Delete from require cache so that updates to the module are re-required
+          deleteRequireCache(TemplatePath.absolutePath(dep));
 
-        return true;
+          return true;
+        }
       }
     }
 
@@ -796,7 +798,7 @@ Arguments:
     this.watchTargets.add(this.eleventyFiles.getGlobWatcherFiles());
 
     // Watch the local project config file
-    this.watchTargets.add(this.eleventyConfig.getLocalProjectConfigFile());
+    this.watchTargets.add(this.eleventyConfig.getLocalProjectConfigFiles());
 
     // Template and Directory Data Files
     this.watchTargets.add(
@@ -834,7 +836,7 @@ Arguments:
 
     // Config file dependencies
     this.watchTargets.addDependencies(
-      this.eleventyConfig.getLocalProjectConfigFile(),
+      this.eleventyConfig.getLocalProjectConfigFiles(),
       filterOutGlobalDataFiles
     );
 

src/EleventyWatch.js

@@ -74,6 +74,15 @@ class EleventyWatch {
     return false;
   }
 
+  hasQueuedFiles(files) {
+    for (const file of files) {
+      if (this.hasQueuedFile(file)) {
+        return true;
+      }
+    }
+    return false;
+  }
+
   get pendingQueue() {
     if (!this._queue) {
       this._queue = [];

src/TemplateConfig.js

@@ -53,9 +53,14 @@ class TemplateConfig {
      * @member {String} - Path to local project config.
      * @default .eleventy.js
      */
-    this.projectConfigPath = ".eleventy.js";
+    this.projectConfigPaths = [
+      ".eleventy.js",
+      ".eleventy.cjs",
+      "eleventy.config.js",
+      "eleventy.config.cjs",
+    ];
     if (projectConfigPath !== undefined) {
-      this.projectConfigPath = projectConfigPath;
+      this.projectConfigPaths = [projectConfigPath];
     }
 
     if (customRootConfig) {
@@ -84,11 +89,24 @@ class TemplateConfig {
    * @returns {String} - The normalised local project config file path.
    */
   getLocalProjectConfigFile() {
-    if (this.projectConfigPath) {
-      return TemplatePath.addLeadingDotSlash(this.projectConfigPath);
+    let configFiles = this.getLocalProjectConfigFiles();
+    // Add the configFiles[0] in case of a test, where no file exists on the file system
+    let configFile =
+      configFiles.find((path) => path && fs.existsSync(path)) || configFiles[0];
+    if (configFile) {
+      return configFile;
     }
   }
 
+  getLocalProjectConfigFiles() {
+    if (this.projectConfigPaths && this.projectConfigPaths.length > 0) {
+      return TemplatePath.addLeadingDotSlashArray(
+        this.projectConfigPaths.filter((path) => path)
+      );
+    }
+    return [];
+  }
+
   get inputDir() {
     return this._inputDir;
   }
@@ -147,7 +165,11 @@ class TemplateConfig {
    * @param {String} path - The new config path.
    */
   setProjectConfigPath(path) {
-    this.projectConfigPath = path;
+    if (path !== undefined) {
+      this.projectConfigPaths = [path];
+    } else {
+      this.projectConfigPaths = [];
+    }
 
     if (this.hasConfigMerged) {
       // merge it again
@@ -249,13 +271,14 @@ class TemplateConfig {
    */
   mergeConfig() {
     let localConfig = {};
-    let path = this.projectConfigPath
-      ? TemplatePath.absolutePath(this.projectConfigPath)
-      : false;
+    let path = this.projectConfigPaths
+      .filter((path) => path)
+      .map((path) => TemplatePath.absolutePath(path))
+      .find((path) => fs.existsSync(path));
 
     debug(`Merging config with ${path}`);
 
-    if (path && fs.existsSync(path)) {
+    if (path) {
       try {
         // remove from require cache so it will grab a fresh copy
         deleteRequireCache(path);

test/EleventyTest.js

@@ -71,6 +71,9 @@ test("Eleventy file watching", async (t) => {
     "./test/stubs/_includes/**",
     "./test/stubs/_data/**",
     "./.eleventy.js",
+    "./.eleventy.cjs",
+    "./eleventy.config.js",
+    "./eleventy.config.cjs",
     "./test/stubs/**/*.json",
     "./test/stubs/**/*.11tydata.cjs",
     "./test/stubs/**/*.11tydata.js",
@@ -107,6 +110,9 @@ test("Eleventy file watching (no JS dependencies)", async (t) => {
     "./test/stubs/_includes/**",
     "./test/stubs/_data/**",
     "./.eleventy.js",
+    "./.eleventy.cjs",
+    "./eleventy.config.js",
+    "./eleventy.config.cjs",
     "./test/stubs/**/*.json",
     "./test/stubs/**/*.11tydata.cjs",
     "./test/stubs/**/*.11tydata.js",