New feature: Jupyter Books (#6095)

* Initial commit * Fixed broken branch * Show notebook titles in tree view * Added README * sections showing in tree view * Multiple books in treeview * removed book extension, added to notebook * removed book from extensions.ts * addressed Chris' comments * Addressed Charles' comments * fixed spelling in readme * added comment about same filenames * adding vsix * addressed Karl's comments
2026-02-12 02:58:31 -05:00 · 2019-06-27 10:10:30 -07:00
parent f39647f243
commit 98c6af628b
7 changed files with 164 additions and 2 deletions
--- a/extensions/notebook/src/book/bookTreeView.ts
+++ b/extensions/notebook/src/book/bookTreeView.ts
@@ -0,0 +1,111 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the Source EULA. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+import * as vscode from 'vscode';
+import * as path from 'path';
+import * as fs from 'fs';
+import * as yaml from 'js-yaml';
+import { BookTreeItem } from './bookTreeItem';
+import * as nls from 'vscode-nls';
+const localize = nls.loadMessageBundle();
+
+
+export class BookTreeViewProvider implements vscode.TreeDataProvider<BookTreeItem> {
+
+	private _onDidChangeTreeData: vscode.EventEmitter<BookTreeItem | undefined> = new vscode.EventEmitter<BookTreeItem | undefined>();
+	readonly onDidChangeTreeData: vscode.Event<BookTreeItem | undefined> = this._onDidChangeTreeData.event;
+	private _tableOfContentsPath: string[];
+
+	constructor(private workspaceRoot: string) {
+		if (workspaceRoot !== '') {
+			this._tableOfContentsPath = this.getTocFiles(this.workspaceRoot);
+			let bookOpened: boolean = this._tableOfContentsPath && this._tableOfContentsPath.length > 0;
+			vscode.commands.executeCommand('setContext', 'bookOpened', bookOpened);
+		}
+	}
+
+	private getTocFiles(dir: string): string[] {
+		let allFiles: string[] = [];
+		let files = fs.readdirSync(dir);
+		for (let i in files) {
+			let name = path.join(dir, files[i]);
+			if (fs.statSync(name).isDirectory()) {
+				allFiles = allFiles.concat(this.getTocFiles(name));
+			} else if (files[i] === 'toc.yml') {
+				allFiles.push(name);
+			}
+		}
+		return allFiles;
+	}
+
+	async openNotebook(resource: vscode.Uri): Promise<void> {
+		try {
+			let doc = await vscode.workspace.openTextDocument(resource);
+			vscode.window.showTextDocument(doc);
+		} catch (e) {
+			vscode.window.showErrorMessage(localize('openNotebookError', 'Open file {0} failed: {1}',
+				resource.fsPath,
+				e instanceof Error ? e.message : e));
+		}
+	}
+
+	getTreeItem(element: BookTreeItem): vscode.TreeItem {
+		return element;
+	}
+
+	getChildren(element?: BookTreeItem): Thenable<BookTreeItem[]> {
+		if (element) {
+			if (element.tableOfContents) {
+				return Promise.resolve(this.getSections(element.tableOfContents, element.root));
+			} else {
+				return Promise.resolve([]);
+			}
+		} else {
+			return Promise.resolve(this.getBooks());
+		}
+	}
+
+	private getBooks(): BookTreeItem[] {
+		let books: BookTreeItem[] = [];
+		for (let i in this._tableOfContentsPath) {
+			let root = path.dirname(path.dirname(this._tableOfContentsPath[i]));
+			try {
+				const config = yaml.safeLoad(fs.readFileSync(path.join(root, '_config.yml'), 'utf-8'));
+				const tableOfContents = yaml.safeLoad(fs.readFileSync(this._tableOfContentsPath[i], 'utf-8'));
+				let book = new BookTreeItem(config.title, root, tableOfContents, vscode.TreeItemCollapsibleState.Collapsed);
+				books.push(book);
+			} catch (e) {
+				vscode.window.showErrorMessage(localize('openConfigFileError', 'Open file {0} failed: {1}',
+					path.join(root, '_config.yml'),
+					e instanceof Error ? e.message : e));
+			}
+		}
+		return books;
+	}
+
+	private getSections(sec: any[], root: string): BookTreeItem[] {
+		let notebooks: BookTreeItem[] = [];
+		for (let i = 0; i < sec.length; i++) {
+			if (sec[i].url) {
+				let pathToNotebook = path.join(root, 'content', sec[i].url.concat('.ipynb'));
+				let pathToMarkdown = path.join(root, 'content', sec[i].url.concat('.md'));
+				// Note: Currently, if there is an ipynb and a md file with the same name, Jupyter Books only shows the notebook.
+				// Following Jupyter Books behavior for now
+				if (fs.existsSync(pathToNotebook)) {
+					let notebook = new BookTreeItem(sec[i].title, root, sec[i].sections, sec[i].sections ? vscode.TreeItemCollapsibleState.Expanded : vscode.TreeItemCollapsibleState.None, sec[i].url, vscode.FileType.File, { command: 'bookTreeView.openNotebook', title: 'Open Notebook', arguments: [pathToNotebook], });
+					notebooks.push(notebook);
+				} else if (fs.existsSync(pathToMarkdown)) {
+					let markdown = new BookTreeItem(sec[i].title, root, sec[i].sections, sec[i].sections ? vscode.TreeItemCollapsibleState.Expanded : vscode.TreeItemCollapsibleState.None, sec[i].url, vscode.FileType.File, { command: 'bookTreeView.openNotebook', title: 'Open Notebook', arguments: [pathToMarkdown], });
+					notebooks.push(markdown);
+				} else {
+					vscode.window.showErrorMessage(localize('missingFileError', 'Missing file : {0}', sec[i].title));
+				}
+			} else {
+				// TODO: search functionality (#6160)
+			}
+		}
+		return notebooks;
+	}
+}