spectacular-dashboard / fileOperations

Module: fileOperations

Table of contents

Interfaces

• FileNode

Functions

• buildFileTree
• getFileStat
• getRelativePath
• normalizePath
• readFileContent

Functions

buildFileTree

▸ buildFileTree(rootPath): Promise<FileNode[]>

Builds a hierarchical file tree from a root directory Filters to only include markdown files and directories

Parameters

Name	Type
rootPath	string

Returns

Promise<FileNode[]>

Defined in

src/fileOperations.ts:17

---

getFileStat

▸ getFileStat(filePath): Promise<vscode.FileStat>

Gets file stats

Parameters

Name	Type
filePath	string

Returns

Promise<vscode.FileStat>

Defined in

src/fileOperations.ts:122

---

getRelativePath

▸ getRelativePath(filePath, rootPath): string

Gets the relative path from root to a file

Parameters

Name	Type
filePath	string
rootPath	string

Returns

string

Defined in

src/fileOperations.ts:137

---

normalizePath

▸ normalizePath(filePath): string

Normalizes a file path (converts backslashes to forward slashes)

Parameters

Name	Type
filePath	string

Returns

string

Defined in

src/fileOperations.ts:130

---

readFileContent

▸ readFileContent(filePath): Promise<string>

Reads the content of a file

Parameters

Name	Type
filePath	string

Returns

Promise<string>

Defined in

src/fileOperations.ts:113