list of files inside folder

[imed-ghomari]

Is it possible to get a bulleted list of all the files included in a specific folder in this format ?

- [[name of file 1]]
- [[name of file 2]]

From what I found, I can only get the name of the folder with this <% tp.file.folder() %>
The folder doesn't include subfolders, only text files.

[MaksimZinovev]

Here is my snippet that does the following:

1. ask user to select folder to generate MOC with bulleted list (create new file) of all files in this folder
2. all files in subfolders will be included
3. if file exist, do not create file

It is ugly but it works for me

<%*  
// ask user to select folder to generate MOC for all files in this folder
// all files in subfolders will be included
const folders = this.app.vault.getAllLoadedFiles().filter(i => i.children).map(folder => folder.path);
const folderChoicePath = await tp.system.suggester(folders, folders);
if (folderChoicePath != null) {
	new Notice(`Folder selected: ${folderChoicePath}`, 5000);

	const files = app.vault.getMarkdownFiles();
	const filesInFolder = new Array();
	console.log("folderChoicePath: " + `${folderChoicePath}`)
	files.forEach((file) => {
		//console.log("file.path: " + `${file.path}`)
		if (file.path.includes(folderChoicePath)) {
			filesInFolder.push(file.basename)
		};
	})
	const filesList = new Array();
	filesInFolder.forEach((file) => {
		//console.log(file)
		filesList.push('\n - [[' + file + ']]')
	});
	const folderChoice = folderChoicePath.split("/").slice(-1)
	const fileName = folderChoice + " MOC"
	//files sorted case insensitive
	const content = "## " + folderChoice + " MOC " + "\n" + filesList.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase())).join('')

	// create new file with a list of files in folder
	const tFolder = app.vault.getAbstractFileByPath(folderChoicePath)
	// if file exist, do not create file
	if (await app.vault.exists(`${folderChoicePath}/${fileName}.md`)){
	new Notice(`Unable to create. File already exists: ${folderChoicePath}/${fileName}.md`, 5000)
	} else {
	await tp.file.create_new(content, fileName, true, tFolder)
	new Notice(`Created new MOC: ${folderChoicePath}/${fileName}.md`, 5000);
	}
} else {
	new Notice(`No folder selected`, 5000);
}
_%>

[imed-ghomari]

Thank you so much, you're amazing.

[willasm]

Thank you, this helped me immensely. I modified this slightly to generate a table rather than a list. The table has 3 columns.

1. the file link
2. a description column (to be filled in)
3. links to generated headers for more detailed descriptions of the files.
   The level 2 headers using the file name are automatically generated after the table.

Here is my modifications for anyone needing this...

<%*
// Check the folder specified below and build a list of all markdown files
// all files in subfolders will be included

// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =
// MacOS example
folderChoicePath = "Templates/"
// If you are on Windows, try: "resources\health\"
// Note: "/" works fine under Windows 10
// = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = =

if (folderChoicePath != null) {
	new Notice(`Folder: ${folderChoicePath}`, 5000);
	let filesInFolder = new Array();
	let headings = new Array();
	console.log("folderChoicePath: " + `${folderChoicePath}`)
	filesInFolder =  app.vault.getMarkdownFiles().filter(file => file.path.includes(folderChoicePath)).map(tFile=>tFile.basename)
	const filesList = new Array();
	filesList.push('\n| Template | Description | Detailed Notes |\n| -------- | ----------- | -------------- |')
	filesInFolder.forEach((file) => {
		filesList.push('\n|[[' + file + ']] | - | [[#' + file + ']] |')
		headings.push('\n## ' + file + '\n')
	});
	const folderChoice = folderChoicePath.split("/").slice(-2).join("")
	const fileName = folderChoice + " MOC"
	//files sorted case insensitive
	const heading = "## " + folderChoice.charAt(0).toUpperCase() + folderChoice.slice(1)+ " MOC"
	let content = heading + "\n" + filesList.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase())).join('')
	content = content + "\n" + headings.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase())).join('')

	// insert the list of files in the active file
	tR+=content
	new Notice(`Created new MOC`, 5000);	
} else {
	new Notice(`No folder selected`, 5000);
}
_%>

[joeraad]

I also did some changes to select the folder of the current file you are in and to output all files in that directory not just .md files

<%*
folderChoicePath = tp.file.folder()+"/"

if (folderChoicePath != null) {
	new Notice(`Folder: ${folderChoicePath}`, 5000);
	let filesInFolder = new Array();
	console.log("folderChoicePath: " + `${folderChoicePath}`)

	filesInFolder =  app.vault.getFiles().filter(file => file.path.includes(folderChoicePath)).map(tFile=>tFile.basename + ((tFile.extension=="md") ? "" : ( "."+tFile.extension ) ) )
	const filesList = new Array();
	filesInFolder.forEach((file) => {
		filesList.push('\n - [[' + file + ']]')
	});
	const folderChoice = folderChoicePath.split("/").slice(-2).join("")
	const fileName = folderChoice + " MOC"
	//files sorted case insensitive
	const heading = "## " + folderChoice.charAt(0).toUpperCase() + folderChoice.slice(1)+ " MOC"
	const content = heading + "\n" + filesList.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase())).join('')
	// insert the list of files in the active file
	tR+=content
	new Notice(`Created new MOC`, 5000);	
} else {
	new Notice(`No folder selected`, 5000);
}
_%>

One problem with this script is if there are files with the same name in different sub folders, It doesn't properly link them

Example:
/folder/folder1/test.md
/folder/folder2/test.md

they will be both linked as:

• [[test.md]]
• [[test.md]]

instead of:

• [[/folder/folder1/test.md]]
• [[/folder/folder2/test.md]]

This also happens if multiple files have the same name even if they are not in the same sub folder

This issue can be fixed by substituting
.map(tFile=>tFile.basename + ((tFile.extension=="md") ? "" : ( "."+tFile.extension ) ) ) with .map(tFile=>tFile.path) which will print out the full file path as a link like so [[/folder/folder1/test.md]] if you want just the name to show up in the file preview you can use this .map(tFile=>tFile.path+ "|"+tFile.basename) which will print out [[/folder/folder1/test,md|test]] If you still want the extensions at the end you can use this .map(tFile=>tFile.path+ "|"+tFile.basename + ((tFile.extension=="md") ? "" : ( "."+tFile.extension ) ) ) which will output the extension if a file isn't a markdown like so [[/folder/folder1/test.png|test.png]]

Full code with above changes in mind

<%*
folderChoicePath = tp.file.folder()+"/"

if (folderChoicePath != null) {
	new Notice(`Folder: ${folderChoicePath}`, 5000);
	let filesInFolder = new Array();
	console.log("folderChoicePath: " + `${folderChoicePath}`)

	filesInFolder =  app.vault.getFiles().filter(file => file.path.includes(folderChoicePath)).map(tFile=>tFile.path+ "|"+tFile.basename + ((tFile.extension=="md") ? "" : ( "."+tFile.extension ) ) )
	
	const filesList = new Array();
	filesInFolder.forEach((file) => {
		filesList.push('\n - [[' + file + ']]')
	});
	const folderChoice = folderChoicePath.split("/").slice(-2).join("")
	const fileName = folderChoice + " Content"
	//files sorted case insensitive
	const heading = "## " + folderChoice.charAt(0).toUpperCase() + folderChoice.slice(1)+ " Content"
	const content = heading + "\n" + filesList.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase())).join('')
	// insert the list of files in the active file
	tR+=content
	new Notice(`Created new MOC`, 5000);	
} else {
	new Notice(`No folder selected`, 5000);
}
_%>

[tusharshuklaa]

Hey, I'm new to Obsidian and when I paste this code, it gets printed as-is in the preview mode. What am I missing here?

[imed-ghomari]

@tusharshuklaa You have to put the template in the template folder (check templater settings) and use the command Templater : open insert template insert modal with the command palette, then select the file with this script