Get File List
This module is responsible for getting a first list of files from the Input folder.
It uses two globs to control which files are collected:
include_glob
exclude_glob
First, a list of files is collected that satisfies the include_glob
, then a list of files is collected that satisfies the exclude_glob
. Finally, a third list is created that contains all the files present in the first list, but not the second.
This list is written to the Module data folder as index/files.json
.
This module also creates the index/markdown_files.json
modfile, which is the subset of index/files.json
where the file paths end with .md
.
Finally, it writes index/excluded_files.json
, which is a useful overview of files present in the input folder, but excluded by this module.
Configuration
Default configuration
Note: this configuration might be outdated. See Inspect default config or follow the
view code
link at the top of this page, for the most up to date default config.
module_config:
get_file_list:
include_glob:
value: '*'
exclude_glob:
value:
- ".obsidian/**/*"
- ".trash/**/*",
- ".DS_Store/**/*",
- ".git/**/*",
Glob syntax
Match folder and everything under it
".obsidian/**/*"
Note that this will match on any folder called .obsidian
anywhere in the input folder!
Match specific file
This will be calculated with the input folder as root.
Note that this works only for files, and files directly under a configured folder, as this method uses glob.glob
instead of Path.rglob
, and is thus not recursive!
# specific file
"/Home.md"
# specific folder and files directly under it
"/Log/**"
Further filtering
These modules are executed by default (at some point) after this module, and allow for further filtering of the notes: