Watcher ignore configuration is confusing

[sagikazarmark]

Version

2.5.0

Platform

darwin

What steps will reproduce the bug?

1. Create a directory you want to ignore (eg. .devenv)
2. Follow the documentation to ignore it from the file watcher
3. The directory doesn't get ignored (in my case it leads to some issues, see below)

For reference, this is the initial configuration I tried:

import lume from "lume/mod.ts";

const site = lume({
    watcher: {
        ignore: [
            ".devenv",
            ".direnv",

            "./.devenv",
            "./.direnv",
        ],
    },
});

site.ignore(".devenv", ".direnv");

export default site;

To make things even more confusing, the watcher ignore config and the site ignore config does not seem to be in sync (which was my initial assumption).

How often does it reproduce? Is there a required condition?

No response

What is the expected behavior?

The file watcher should ignore said directories.

What do you see instead?

The file watcher entering the directories I want to exclude have two consequences in my case:

These directories contain a lot of files which means starting Lume takes a lot of time.

It also failed to start due to a broken link in those directories:

error: Uncaught (in worker "") (in promise) NotFound: No such file or directory (os error 2): stat '/Users/mark/Projects/sagikazarmark/sagikazarmark.com/.direnv/flake-inputs/8p8giar71b6aqddqkjckzhirwvjnf02x-source/tests/functional/lang/symlink-resolution/broken'
    const info = Deno.statSync(src);
                      ^
    at Object.statSync (ext:deno_fs/30_fs.js:415:3)
    at FS.#walkLink (https://deno.land/x/lume@v2.5.0/core/fs.ts:167:23)
    at FS.#walkFs (https://deno.land/x/lume@v2.5.0/core/fs.ts:141:23)
    at FS.#walkFs (https://deno.land/x/lume@v2.5.0/core/fs.ts:160:21)
    at FS.#walkFs (https://deno.land/x/lume@v2.5.0/core/fs.ts:160:21)
    at FS.#walkFs (https://deno.land/x/lume@v2.5.0/core/fs.ts:160:21)
    at FS.#walkFs (https://deno.land/x/lume@v2.5.0/core/fs.ts:160:21)
    at FS.#walkLink (https://deno.land/x/lume@v2.5.0/core/fs.ts:181:19)
    at FS.#walkFs (https://deno.land/x/lume@v2.5.0/core/fs.ts:141:23)
    at FS.#walkFs (https://deno.land/x/lume@v2.5.0/core/fs.ts:160:21)
error: Uncaught (in promise) Error: Unhandled error in child worker.
    at Worker.#pollControl (ext:runtime/11_workers.js:204:19)
    at eventLoopTick (ext:core/01_core.js:175:7)

Additional information

After some debugging I managed to get the configuration work:

import lume from "lume/mod.ts";

const site = lume({
    // src: "src",
    watcher: {
        ignore: [
            "/.devenv",
            "/.direnv",
        ],
    },
});

site.ignore(".devenv", ".direnv");

export default site;

Adding a leading slash to the path seems to have done the trick. There is no mention of that in the configuration though.

---

I use Nix with direnv and devenv to manage Deno, hence those two directories.

I also figured out I could just move the source directory somewhere else.

[oscarotero]

The site.ignore() ignores the src files to create pages, but these files are scanned because they can be used by any page. For example the _includes page is ignored (because it starts with _ but it's the same if it were ignored with site.ignore()), but pages can include templates or use layouts from this folder.

The watcher ignore only instruct to don't trigger a new rebuild if some files have been changed. For default, the _site folder is ignored by the watcher (to avoid infinite loop) but the _includes folder isn't (even ignored by site, it's not ignored by the watcher).

What you want is a way to ignore completely the folder for both watcher and site. This isn't implemented for now (it's a good idea, I will do).

And regarding the leading slash, that's fair. It must be added automatically by Lume if it's missing. I'll fix it.