Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Supports index rendering in Notebook 7 #19

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22,990 changes: 11,240 additions & 11,750 deletions package-lock.json

Large diffs are not rendered by default.

7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,17 @@
"watch:src": "tsc -w"
},
"dependencies": {
"@fortawesome/free-solid-svg-icons": "^6.5.1",
"@jupyterlab/application": "^4.0.3",
"@jupyterlab/coreutils": "^6.0.3",
"@jupyterlab/coreutils": "^4.0.3",
"@jupyterlab/docmanager": "^4.0.3",
"@jupyterlab/filebrowser": "^4.0.3"
"@jupyterlab/filebrowser": "^4.0.3",
"@jupyterlab/rendermime": "^4.0.3"
},
"devDependencies": {
"@jupyterlab/builder": "^4.0.0",
"@types/json-schema": "^7.0.11",
"@types/node": "^20.12.5",
"@types/react": "^18.0.26",
"@typescript-eslint/eslint-plugin": "^6.1.0",
"@typescript-eslint/parser": "^6.1.0",
Expand Down
73 changes: 48 additions & 25 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,51 +5,74 @@ import {
} from '@jupyterlab/application';
import { IDocumentManager } from '@jupyterlab/docmanager';
import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
import { Platform, getPlatform } from './widgets/platform';
import { observeFileBrowser } from './widgets/files';
import { createOpener } from './widgets/open';
import { IRenderMimeRegistry } from '@jupyterlab/rendermime';

const MarkdownFileName = 'README.md';
const SvgFileName = 'README.svg';

async function checkPlatform(app: JupyterFrontEnd): Promise<Platform> {
await app.restored;
return await getPlatform(app);
}

/**
* Initialization data for the lc_index extension.
*/
const plugin: JupyterFrontEndPlugin<void> = {
id: 'lc_index:plugin',
autoStart: true,
requires: [IDocumentManager, IFileBrowserFactory],
requires: [IDocumentManager, IFileBrowserFactory, IRenderMimeRegistry],
activate: (
app: JupyterFrontEnd,
documents: IDocumentManager,
fileBrowserFactory: IFileBrowserFactory
fileBrowserFactory: IFileBrowserFactory,
renderMimeRegistry: IRenderMimeRegistry
) => {
console.log('JupyterLab extension lc_index is activated!');

app.restored.then(() => {
const fileBrowser = fileBrowserFactory.tracker.currentWidget;
if (!fileBrowser) {
throw new Error('file browser is not set');
}

// README.md
let item = find(fileBrowser.model.items(), item =>
new RegExp(`^${MarkdownFileName}$`, 'i').test(item.name)
);
let widgetName = 'Markdown Preview';
if (!item) {
checkPlatform(app).then((platform: Platform) => {
let detectedPath: string | null = null;
let removeOldWidget: (() => void) | null = () => {};
const opener = createOpener(app, platform, documents, renderMimeRegistry);
observeFileBrowser(fileBrowserFactory, fileBrowser => {
console.log('fileBrowser:', fileBrowser.model.path);
if (detectedPath === fileBrowser.model.path) {
return;
}
if (!find(fileBrowser.model.items(), item => item.name.length > 0)) {
return;
}
// README.svg
item = find(fileBrowser.model.items(), item =>
const svgItem = find(fileBrowser.model.items(), item =>
new RegExp(`^${SvgFileName}$`, 'i').test(item.name)
);
widgetName = 'Image';
}
if (item) {
console.log('open: ' + item.path);
const ret = documents.openOrReveal(item.path, widgetName);
console.log(ret);
} else {
console.log(
MarkdownFileName + ' nor ' + SvgFileName + ' are not found'
// README.md
const markdownItem = find(fileBrowser.model.items(), item =>
new RegExp(`^${MarkdownFileName}$`, 'i').test(item.name)
);
}
detectedPath = fileBrowser.model.path;
if (removeOldWidget) {
removeOldWidget();
}
if (svgItem || markdownItem) {
console.log('open:', svgItem?.path, markdownItem?.path);
opener
.open(svgItem?.path, markdownItem?.path)
.then((remove: () => void) => {
removeOldWidget = remove;
})
.catch((reason: any) => {
console.error(reason);
});
} else {
console.log(
MarkdownFileName + ' nor ' + SvgFileName + ' are not found'
);
}
});
});
}
};
Expand Down
33 changes: 33 additions & 0 deletions src/widgets/files.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { IFileBrowserFactory } from '@jupyterlab/filebrowser';
import { FileBrowser } from '@jupyterlab/filebrowser';

function observeFileBrowserInstance(
fileBrowser: FileBrowser,
callback: (fileBrowser: FileBrowser) => void
): void {
fileBrowser.model.refreshed.connect(() => {
callback(fileBrowser);
});
fileBrowser.model.pathChanged.connect(() => {
callback(fileBrowser);
});
callback(fileBrowser);
}

export function observeFileBrowser(
fileBrowserFactory: IFileBrowserFactory,
callback: (fileBrowser: FileBrowser) => void
) {
const fileBrowser = fileBrowserFactory.tracker.currentWidget;
if (!fileBrowser) {
console.warn('file browser is not set, waiting...');
fileBrowserFactory.tracker.currentChanged.connect(() => {
const fileBrowser = fileBrowserFactory.tracker.currentWidget;
if (fileBrowser) {
observeFileBrowserInstance(fileBrowser, callback);
}
});
return;
}
observeFileBrowserInstance(fileBrowser, callback);
}
Loading