feat: add tables to file metadata

Author: LeangseuGQ

docs/docs/annotation/metadata-pages.md

@@ -25,6 +25,7 @@ Dataview automatically adds a large amount of metadata to each page. These impli
 | `file.aliases` | List | A list of all aliases for the note as defined via the [YAML frontmatter](https://help.obsidian.md/How+to/Add+aliases+to+note). |
 | `file.tasks` | List | A list of all tasks (I.e., `| [ ] some task`) in this file. |
 | `file.lists` | List | A list of all list elements in the file (including tasks); these elements are effectively tasks and can be rendered in task views. |
+| `file.tables` | List | A list of all table in this file. |
 | `file.frontmatter` | List | Contains the raw values of all frontmatter in form of `key | value` text values; mainly useful for checking raw frontmatter values or for dynamically listing frontmatter keys. |
 | `file.day` | Date | Only available if the file has a date inside its file name (of form `yyyy-mm-dd` or `yyyymmdd`), or has a `Date` field/inline field. |
 | `file.starred` | Boolean | If this file has been bookmarked via the Obsidian Core Plugin "Bookmarks". |

src/data-import/markdown-file.ts

@@ -78,6 +78,7 @@ export function parsePage(path: string, contents: string, stat: FileStats, metad
         links,
         lists: markdownData.lists,
         fields: finalizeInlineFields(fields),
+        tables: markdownData.tables,
         frontmatter: frontmatter,
         ctime: DateTime.fromMillis(stat.ctime),
         mtime: DateTime.fromMillis(stat.mtime),
@@ -136,11 +137,13 @@ export function parseMarkdown(
     contents: string[],
     metadata: CachedMetadata,
     linksByLine: Record<number, Link[]>
-): { fields: Map<string, Literal[]>; lists: ListItem[] } {
+): { fields: Map<string, Literal[]>; lists: ListItem[], tables: any } {
     let fields: Map<string, Literal[]> = new Map();
 
     // Extract task data and append the global data extracted from them to our fields.
     let [lists, extraData] = parseLists(path, contents, metadata, linksByLine);
+    let tables = parseTables(contents, metadata);
+
     for (let [key, values] of extraData.entries()) {
         if (!fields.has(key)) fields.set(key, values);
         else fields.set(key, fields.get(key)!!.concat(values));
@@ -176,7 +179,7 @@ export function parseMarkdown(
         }
     }
 
-    return { fields, lists };
+    return { fields, lists, tables };
 }
 
 // TODO: Consider using an actual parser in leiu of a more expensive regex.
@@ -304,6 +307,42 @@ export function parseLists(
     return [Object.values(cache), literals];
 }
 
+/**
+ * Parse table from content and meta data. The implementation will not include column spans. It only work for
+ * one column/one cell value.
+ */
+export function parseTables(
+    content: string[],
+    metadata: CachedMetadata,
+): Map<string, any>[] {
+    const result: Map<string, any>[] = [];
+    metadata.sections?.forEach(section => {
+        if (section.type === 'table') {
+            const headers = content[section.position.start.line]
+                .split('|')
+                .map(header => header.trim())
+                .filter(header => header);
+            let rows = content
+                .slice(section.position.start.line + 2, section.position.end.line + 1)
+                .map(row => row
+                    .split('|')
+                    .map(val => val.trim())
+                    .filter(row => row));
+            // don't support expand column at the moment.
+            if (rows.length === headers.length) {
+                rows.forEach(row => {
+                    const record = headers.reduce((prev, key, index) => {
+                        prev[key] = row[index];
+                        return prev;
+                    }, {} as any);
+                    result.push(record);
+                });
+            }
+        }
+    });
+    return result;
+}
+
 /** Attempt to find a date associated with the given page from metadata or filenames. */
 function findDate(file: string, fields: Map<string, Literal>): DateTime | undefined {
     for (let key of fields.keys()) {

src/data-model/markdown.ts

@@ -33,13 +33,16 @@ export class PageMetadata {
     /** The raw frontmatter for this document. */
     public frontmatter: Record<string, Literal>;
 
+    public tables: Map<string, any>[];
+
     public constructor(path: string, init?: Partial<PageMetadata>) {
         this.path = path;
         this.fields = new Map<string, Literal>();
         this.frontmatter = {};
         this.tags = new Set<string>();
         this.aliases = new Set<string>();
         this.links = [];
+        this.tables = [];
 
         Object.assign(this, init);
 
@@ -136,6 +139,7 @@ export class PageMetadata {
                 aliases: Array.from(this.aliases),
                 lists: this.lists.map(l => realCache.get(l.line)),
                 tasks: this.lists.filter(l => !!l.task).map(l => realCache.get(l.line)),
+                tables: this.tables,
                 ctime: this.ctime,
                 cday: stripTime(this.ctime),
                 mtime: this.mtime,

src/data-model/serialized/markdown.ts

@@ -17,6 +17,7 @@ export interface SMarkdownPage {
         aliases: string[];
         lists: SListItem[];
         tasks: STask[];
+        tables: Map<string, any>[];
         ctime: DateTime;
         cday: DateTime;
         mtime: DateTime;

test-vault/example read tables.md

@@ -0,0 +1,4 @@
+
+```dataview
+TABLE file.tables WHERE length(file.tables) > 0
+```

test-vault/tables/git commands.md

@@ -0,0 +1,5 @@
+
+| Command | Description |
+| --- | --- |
+| `git status` | List all *new or modified* files |
+| `git diff` | Show file differences that **haven't been** staged |