ckaczor/azuredatastudio
1
0
Fork 0
mirror of https://github.com/ckaczor/azuredatastudio.git synced 2026-01-27 17:23:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

Book Editing: Support adding new sections to a book (#17074)

Browse Source 
* add a new section command
This commit is contained in:
Barbara Valdez
2021-09-14 11:31:43 -07:00
committed by GitHub
parent f92e6d24d4
commit ce13d01efb
10 changed files with 65 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
extensions/notebook/package.json
View File

@@ -251,6 +251,10 @@
"command": "notebook.command.addMarkdown",
"title": "%title.addMarkdown%"
},
{
"command": "notebook.command.addSection",
"title": "%title.addSection%"
},
{
"command": "notebook.command.closeNotebook",
"title": "%title.closeNotebook%"
@@ -490,6 +494,11 @@
"when": "view == bookTreeView && viewItem == section && listMultiSelection == false || view == bookTreeView && viewItem == savedBook && listMultiSelection == false",
"group": "newFile@1"
},
{
"command": "notebook.command.addSection",
"when": "view == bookTreeView && viewItem == section && listMultiSelection == false || view == bookTreeView && viewItem == savedBook && listMultiSelection == false",
"group": "newFile@1"
},
{
"command": "notebook.command.moveTo",
"when": "view == bookTreeView && viewItem == savedNotebook || view == bookTreeView && viewItem == savedBookNotebook || view == bookTreeView && viewItem == section || view == bookTreeView && viewItem == Markdown"

1
extensions/notebook/package.nls.json
View File

@@ -49,6 +49,7 @@
"title.removeNotebook": "Remove Notebook",
"title.addNotebook": "Add Notebook",
"title.addMarkdown": "Add Markdown File",
"title.addSection": "Add Section",
"title.revealInBooksViewlet": "Reveal in Books",
"title.createJupyterBook": "Create Jupyter Book",
"title.openNotebookFolder": "Open Notebooks in Folder",

9
extensions/notebook/src/book/bookTocManager.ts
View File

@@ -18,7 +18,7 @@ export interface IBookTocManager {
updateBook(sources: BookTreeItem[], target: BookTreeItem, targetSection?: JupyterBookSection): Promise<void>;
removeNotebook(element: BookTreeItem): Promise<void>;
createBook(bookContentPath: string, contentFolder: string): Promise<void>;
addNewFile(pathDetails: TocEntryPathHandler, bookItem: BookTreeItem): Promise<void>;
addNewTocEntry(pathDetails: TocEntryPathHandler, bookItem: BookTreeItem, isSection?: boolean): Promise<void>;
recovery(): Promise<void>;
}
@@ -443,7 +443,7 @@ export class BookTocManager implements IBookTocManager {
}
}
public async addNewFile(pathDetails: TocEntryPathHandler, bookItem: BookTreeItem): Promise<void> {
public async addNewTocEntry(pathDetails: TocEntryPathHandler, bookItem: BookTreeItem, isSection?: boolean): Promise<void> {
let findSection: JupyterBookSection | undefined = undefined;
await fs.writeFile(pathDetails.filePath, '');
if (bookItem.contextValue === 'section') {
@@ -453,6 +453,11 @@ export class BookTocManager implements IBookTocManager {
title: pathDetails.titleInTocEntry,
file: pathDetails.fileInTocEntry
};
if (isSection) {
fileEntryInToc.sections = [];
}
if (bookItem.book.version === BookVersion.v1) {
fileEntryInToc = convertTo(BookVersion.v1, fileEntryInToc);
}

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

@@ -59,7 +59,7 @@ export class BookTreeItem extends vscode.TreeItem {
this.contextValue = BookTreeItemType.savedBook;
}
} else {
if (book.page && book.page.sections && book.page.sections.length > 0) {
if (book.page && book.page.sections) {
this.contextValue = BookTreeItemType.section;
} else if (book.type === BookTreeItemType.Notebook && !book.tableOfContents.sections) {
if (book.isUntitled) {

13
extensions/notebook/src/book/bookTreeView.ts
View File

@@ -20,7 +20,7 @@ import { getPinnedNotebooks, confirmMessageDialog, getNotebookType, FileExtensio
import { IBookPinManager, BookPinManager } from './bookPinManager';
import { BookTocManager, IBookTocManager, quickPickResults } from './bookTocManager';
import { CreateBookDialog } from '../dialog/createBookDialog';
import { AddFileDialog } from '../dialog/addFileDialog';
import { AddTocEntryDialog } from '../dialog/addTocEntryDialog';
import { getContentPath } from './bookVersionHandler';
import { TelemetryReporter, BookTelemetryView, NbTelemetryActions } from '../telemetry';
@@ -276,14 +276,21 @@ export class BookTreeViewProvider implements vscode.TreeDataProvider<BookTreeIte
async createMarkdownFile(bookItem: BookTreeItem): Promise<void> {
const book = this.books.find(b => b.bookPath === bookItem.root);
this.bookTocManager = new BookTocManager(book);
const dialog = new AddFileDialog(this.bookTocManager, bookItem, FileExtension.Markdown);
const dialog = new AddTocEntryDialog(this.bookTocManager, bookItem, FileExtension.Markdown);
await dialog.createDialog();
}
async createNotebook(bookItem: BookTreeItem): Promise<void> {
const book = this.books.find(b => b.bookPath === bookItem.root);
this.bookTocManager = new BookTocManager(book);
const dialog = new AddFileDialog(this.bookTocManager, bookItem, FileExtension.Notebook);
const dialog = new AddTocEntryDialog(this.bookTocManager, bookItem, FileExtension.Notebook);
await dialog.createDialog();
}
async createSection(bookItem: BookTreeItem): Promise<void> {
const book = this.books.find(b => b.bookPath === bookItem.root);
this.bookTocManager = new BookTocManager(book);
const dialog = new AddTocEntryDialog(this.bookTocManager, bookItem, FileExtension.Markdown, true);
await dialog.createDialog();
}

3
extensions/notebook/src/common/localizedConstants.ts
View File

@@ -97,9 +97,10 @@ export const msgContentFolderError = localize('msgContentFolderError', "Content
export const msgSaveFolderError = localize('msgSaveFolderError', "Save location path does not exist.");
export function msgCreateBookWarningMsg(file: string): string { return localize('msgCreateBookWarningMsg', "Error while trying to access: {0}", file); }
// Add a notebook dialog constants
// Add a new entry in toc dialog constants
export const newNotebook = localize('newNotebook', "New Notebook (Preview)");
export const newMarkdown = localize('newMarkdown', "New Markdown (Preview)");
export const newSection = localize('newSection', "New Section (Preview)");
export const fileExtension = localize('fileExtension', "File Extension");
export const confirmOverwrite = localize('confirmOverwrite', "File already exists. Are you sure you want to overwrite this file?");
export const title = localize('title', "Title");

8
extensions/notebook/src/dialog/addFileDialog.ts → extensions/notebook/src/dialog/addTocEntryDialog.ts
View File

@@ -13,7 +13,7 @@ import CodeAdapter from '../prompts/adapter';
import { BookTreeItem, BookTreeItemType } from '../book/bookTreeItem';
import { TocEntryPathHandler } from '../book/tocEntryPathHandler';
export class AddFileDialog {
export class AddTocEntryDialog {
private _dialog: azdata.window.Dialog;
private readonly _dialogName = 'addNewFileBookTreeViewDialog';
public view: azdata.ModelView;
@@ -23,7 +23,7 @@ export class AddFileDialog {
private _saveLocationInputBox: azdata.TextComponent;
private _prompter: IPrompter;
constructor(private _tocManager: IBookTocManager, private _bookItem: BookTreeItem, private _extension: FileExtension) {
constructor(private _tocManager: IBookTocManager, private _bookItem: BookTreeItem, private _extension: FileExtension, private _isSection?: boolean) {
this._prompter = new CodeAdapter();
}
@@ -45,7 +45,7 @@ export class AddFileDialog {
}
public async createDialog(): Promise<void> {
const dialogTitle = this._extension === FileExtension.Notebook ? loc.newNotebook : loc.newMarkdown;
const dialogTitle = this._isSection ? loc.newSection : this._extension === FileExtension.Notebook ? loc.newNotebook : loc.newMarkdown;
this._dialog = azdata.window.createModelViewDialog(dialogTitle, this._dialogName);
this._dialog.registerContent(async view => {
this.view = view;
@@ -102,7 +102,7 @@ export class AddFileDialog {
const filePath = path.posix.join(dirPath, fileName).concat(this._extension);
await this.validatePath(dirPath, fileName.concat(this._extension));
const pathDetails = new TocEntryPathHandler(filePath, this._bookItem.rootContentPath, titleName);
await this._tocManager.addNewFile(pathDetails, this._bookItem);
await this._tocManager.addNewTocEntry(pathDetails, this._bookItem, this._isSection);
return true;
} catch (error) {
this._dialog.message = {

1
extensions/notebook/src/extension.ts
View File

@@ -57,6 +57,7 @@ export async function activate(extensionContext: vscode.ExtensionContext): Promi
extensionContext.subscriptions.push(vscode.commands.registerCommand('notebook.command.removeNotebook', (book: BookTreeItem) => bookTreeViewProvider.removeNotebook(book)));
extensionContext.subscriptions.push(vscode.commands.registerCommand('notebook.command.addNotebook', (book: BookTreeItem) => bookTreeViewProvider.createNotebook(book)));
extensionContext.subscriptions.push(vscode.commands.registerCommand('notebook.command.addMarkdown', (book: BookTreeItem) => bookTreeViewProvider.createMarkdownFile(book)));
extensionContext.subscriptions.push(vscode.commands.registerCommand('notebook.command.addSection', (book: BookTreeItem) => bookTreeViewProvider.createSection(book)));
extensionContext.subscriptions.push(vscode.commands.registerCommand('notebook.command.createBook', () => bookTreeViewProvider.createBook()));
extensionContext.subscriptions.push(vscode.commands.registerCommand('notebook.command.openNotebookFolder', (folderPath?: string, urlToOpen?: string, showPreview?: boolean) => bookTreeViewProvider.openNotebookFolder(folderPath, urlToOpen, showPreview)));
extensionContext.subscriptions.push(vscode.commands.registerCommand('notebook.command.pinNotebook', async (book: BookTreeItem) => {

16
extensions/notebook/src/test/book/addFile.test.ts → extensions/notebook/src/test/book/addTocEntry.test.ts
View File

@@ -8,7 +8,7 @@ import * as should from 'should';
import * as os from 'os';
import * as path from 'path';
import * as fs from 'fs-extra';
import { AddFileDialog } from '../../dialog/addFileDialog';
import { AddTocEntryDialog } from '../../dialog/addTocEntryDialog';
import { IBookTocManager } from '../../book/bookTocManager';
import { BookTreeItem, BookTreeItemFormat, BookTreeItemType } from '../../book/bookTreeItem';
import * as utils from '../../common/utils';
@@ -23,7 +23,7 @@ describe('Add File Dialog', function () {
beforeEach(() => {
let mockBookManager = TypeMoq.Mock.ofType<IBookTocManager>();
mockBookManager.setup(m => m.addNewFile(TypeMoq.It.isAny(), TypeMoq.It.isAny())).returns(() => Promise.resolve());
mockBookManager.setup(m => m.addNewTocEntry(TypeMoq.It.isAny(), TypeMoq.It.isAny())).returns(() => Promise.resolve());
bookTocManager = mockBookManager.object;
let mockTreeItem = TypeMoq.Mock.ofType<BookTreeItem>();
@@ -39,14 +39,14 @@ describe('Add File Dialog', function () {
});
it('Create dialog', async () => {
let fileDialog = new AddFileDialog(bookTocManager, bookTreeItem, fileExtension);
let fileDialog = new AddTocEntryDialog(bookTocManager, bookTreeItem, fileExtension);
await fileDialog.createDialog();
should(fileDialog.dialog).not.be.undefined();
should(fileDialog.dialog.message).be.undefined();
});
it('Validate path', async () => {
let fileDialog = new AddFileDialog(bookTocManager, bookTreeItem, fileExtension);
let fileDialog = new AddTocEntryDialog(bookTocManager, bookTreeItem, fileExtension);
await fileDialog.createDialog();
let tempDir = os.tmpdir();
@@ -84,9 +84,9 @@ describe('Add File Dialog', function () {
// Error case
let mockBookManager = TypeMoq.Mock.ofType<IBookTocManager>();
mockBookManager.setup(m => m.addNewFile(TypeMoq.It.isAny(), TypeMoq.It.isAny())).throws(new Error('Expected test error.'));
mockBookManager.setup(m => m.addNewTocEntry(TypeMoq.It.isAny(), TypeMoq.It.isAny(), TypeMoq.It.isAny())).throws(new Error('Expected test error.'));
let fileDialog = new AddFileDialog(mockBookManager.object, bookTreeItem, fileExtension);
let fileDialog = new AddTocEntryDialog(mockBookManager.object, bookTreeItem, fileExtension);
await fileDialog.createDialog();
await should(fileDialog.createFile(testFileName, testTitle)).be.resolvedWith(false);
@@ -97,13 +97,13 @@ describe('Add File Dialog', function () {
// Success case
let testPathDetails: TocEntryPathHandler[] = [];
mockBookManager = TypeMoq.Mock.ofType<IBookTocManager>();
mockBookManager.setup(m => m.addNewFile(TypeMoq.It.isAny(), TypeMoq.It.isAny())).returns((path, item) => { testPathDetails.push(path); return Promise.resolve(); });
mockBookManager.setup(m => m.addNewTocEntry(TypeMoq.It.isAny(), TypeMoq.It.isAny(),TypeMoq.It.isAny())).returns((path, item) => { testPathDetails.push(path); return Promise.resolve(); });
let mockTreeItem = TypeMoq.Mock.ofType<BookTreeItem>();
mockTreeItem.setup(i => i.contextValue).returns(() => BookTreeItemType.savedBook);
mockTreeItem.setup(i => i.rootContentPath).returns(() => testDir);
fileDialog = new AddFileDialog(mockBookManager.object, mockTreeItem.object, fileExtension);
fileDialog = new AddTocEntryDialog(mockBookManager.object, mockTreeItem.object, fileExtension);
await fileDialog.createDialog();
let createFileResult = await fileDialog.createFile(testFileName, testTitle);

22
extensions/notebook/src/test/book/bookTocManager.test.ts
View File

@@ -20,6 +20,8 @@ import { BookTreeViewProvider } from '../../book/bookTreeView';
import { NavigationProviders } from '../../common/constants';
import { BookVersion } from '../../book/bookVersionHandler';
import * as yaml from 'js-yaml';
import { TocEntryPathHandler } from '../../book/tocEntryPathHandler';
import * as utils from '../../common/utils';
export function equalTOC(actualToc: IJupyterBookSectionV2[], expectedToc: IJupyterBookSectionV2[]): boolean {
for (let [i, section] of actualToc.entries()) {
@@ -552,6 +554,26 @@ describe('BookTocManagerTests', function () {
should(JSON.stringify(listFiles).includes('test')).be.true('Empty directories within the moving element directory are not deleted');
});
it('Add new section', async () => {
bookTocManager = new BookTocManager(sourceBookModel);
const fileBasename = `addSectionTest-${utils.generateGuid()}`;
const sectionTitle = 'Section Test';
const testFilePath = path.join(run.sectionA.sectionRoot, fileBasename).concat(utils.FileExtension.Markdown);
await fs.writeFile(testFilePath, '');
const pathDetails = new TocEntryPathHandler(testFilePath, run.sourceBook.rootBookFolderPath, sectionTitle);
await bookTocManager.addNewTocEntry(pathDetails, sectionA, true);
let toc: JupyterBookSection[] = yaml.safeLoad((await fs.promises.readFile(run.sourceBook.tocPath)).toString());
const sectionAIndex = toc.findIndex(entry => entry.title === sectionA.title);
let newSectionIndex = -1;
let newSection = undefined;
if (sectionAIndex) {
newSectionIndex = toc[sectionAIndex].sections?.findIndex(entry => entry.title === sectionTitle);
newSection = toc[sectionAIndex].sections[newSectionIndex];
}
should(newSectionIndex).not.be.equal(-1, 'The new section should exist in the toc file');
should(newSection.sections).not.undefined();
});
afterEach(async function (): Promise<void> {
sinon.restore();
if (await exists(sourceBookFolderPath)) {