ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-02-16 18:46:40 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add abillity to open to specific item within a Jupyter book (#7155)

Browse Source 
* Add abillity to open to specific item within a Jupyter book

* Move helper method into BookTreeItem class

* Fix default URL path

* Add typing to Jupyter book code

* Update comment and typings

* Fix compile error and cleanup
This commit is contained in:
Charles Gagnon
2019-09-13 11:51:15 -07:00
committed by GitHub
parent 3ac096b3b1
commit 888755e842
6 changed files with 133 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
extensions/notebook/src/book/bookTreeItem.ts
View File

@@ -7,6 +7,7 @@ import * as vscode from 'vscode';
import * as path from 'path';
import * as fs from 'fs';
import * as nls from 'vscode-nls';
import { IJupyterBookSection, IJupyterBookToc } from '../contracts/content';
const localize = nls.loadMessageBundle();
export enum BookTreeItemType {
@@ -19,14 +20,14 @@ export enum BookTreeItemType {
export interface BookTreeItemFormat {
title: string;
root: string;
tableOfContents: any[];
tableOfContents: IJupyterBookToc;
page: any;
type: BookTreeItemType;
treeItemCollapsibleState: number;
}
export class BookTreeItem extends vscode.TreeItem {
private _sections: any[];
private _sections: IJupyterBookSection[];
private _uri: string;
private _previousUri: string;
private _nextUri: string;
@@ -54,7 +55,7 @@ export class BookTreeItem extends vscode.TreeItem {
this._sections = this.book.page.sections || this.book.page.subsections;
this._uri = this.book.page.url;
let index = (this.book.tableOfContents.indexOf(this.book.page));
let index = (this.book.tableOfContents.sections.indexOf(this.book.page));
this.setPreviousUri(index);
this.setNextUri(index);
}
@@ -74,9 +75,9 @@ export class BookTreeItem extends vscode.TreeItem {
private setPreviousUri(index: number): void {
let i = --index;
while (i > -1) {
if (this.book.tableOfContents[i].url) {
if (this.book.tableOfContents.sections[i].url) {
// TODO: Currently only navigating to notebooks. Need to add logic for markdown.
let pathToNotebook = path.join(this.book.root, 'content', this.book.tableOfContents[i].url.concat('.ipynb'));
let pathToNotebook = path.join(this.book.root, 'content', this.book.tableOfContents.sections[i].url.concat('.ipynb'));
if (fs.existsSync(pathToNotebook)) {
this._previousUri = pathToNotebook;
return;
@@ -88,10 +89,10 @@ export class BookTreeItem extends vscode.TreeItem {
private setNextUri(index: number): void {
let i = ++index;
while (i < this.book.tableOfContents.length) {
if (this.book.tableOfContents[i].url) {
while (i < this.book.tableOfContents.sections.length) {
if (this.book.tableOfContents.sections[i].url) {
// TODO: Currently only navigating to notebooks. Need to add logic for markdown.
let pathToNotebook = path.join(this.book.root, 'content', this.book.tableOfContents[i].url.concat('.ipynb'));
let pathToNotebook = path.join(this.book.root, 'content', this.book.tableOfContents.sections[i].url.concat('.ipynb'));
if (fs.existsSync(pathToNotebook)) {
this._nextUri = pathToNotebook;
return;
@@ -113,7 +114,7 @@ export class BookTreeItem extends vscode.TreeItem {
return this.book.root;
}
public get tableOfContents(): any[] {
public get tableOfContents(): IJupyterBookToc {
return this.book.tableOfContents;
}
@@ -137,4 +138,29 @@ export class BookTreeItem extends vscode.TreeItem {
return undefined;
}
}
/**
* Helper method to find a child section with a specified URL
* @param url The url of the section we're searching for
*/
public findChildSection(url?: string): IJupyterBookSection | undefined {
if (!url) {
return undefined;
}
return this.findChildSectionRecur(this, url);
}
private findChildSectionRecur(section: IJupyterBookSection, url: string): IJupyterBookSection | undefined {
if (section.url && section.url === url) {
return section;
} else if (section.sections) {
for (const childSection of section.sections) {
const foundSection = this.findChildSectionRecur(childSection, url);
if (foundSection) {
return foundSection;
}
}
}
return undefined;
}
}