Skip to content

feat: copy id or document to clipboard #419

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: copy id or document to clipboard #419

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 26 additions & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,14 @@
"dark": "images/dark/search-regular.svg"
}
},
{
"command": "mdb.copyDocumentIdFromTree",
"title": "Copy Document ID"
},
{
"command": "mdb.copyDocumentFromTree",
"title": "Copy Document"
},
{
"command": "mdb.openPlaygroundFromTreeItem",
"title": "Open Playground"
Expand Down Expand Up @@ -559,6 +567,16 @@
"when": "view == mongoDBConnectionExplorer && viewItem == documentListTreeItem",
"group": "2@1"
},
{
"command": "mdb.copyDocumentIdFromTree",
"when": "view == mongoDBConnectionExplorer && viewItem == documentTreeItem",
"group": "1@1"
},
{
"command": "mdb.copyDocumentFromTree",
"when": "view == mongoDBConnectionExplorer && viewItem == documentTreeItem",
"group": "1@2"
},
{
"command": "mdb.refreshSchema",
"when": "view == mongoDBConnectionExplorer && viewItem == schemaTreeItem"
Expand Down Expand Up @@ -625,6 +643,14 @@
"command": "mdb.searchForDocuments",
"when": "false"
},
{
"command": "mdb.copyDocumentIdFromTree",
"when": "false"
},
{
"command": "mdb.copyDocumentFromTree",
"when": "false"
},
{
"command": "mdb.addConnection",
"when": "false"
Expand Down
2 changes: 2 additions & 0 deletions src/commands/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ enum EXTENSION_COMMANDS {
MDB_RENAME_CONNECTION = 'mdb.renameConnection',
MDB_ADD_DATABASE = 'mdb.addDatabase',
MDB_SEARCH_FOR_DOCUMENTS = 'mdb.searchForDocuments',
MDB_COPY_DOCUMENT_ID_FROM_TREE = 'mdb.copyDocumentIdFromTree',
MDB_COPY_DOCUMENT_FROM_TREE = 'mdb.copyDocumentFromTree',
MDB_COPY_DATABASE_NAME = 'mdb.copyDatabaseName',
MDB_DROP_DATABASE = 'mdb.dropDatabase',
MDB_REFRESH_DATABASE = 'mdb.refreshDatabase',
Expand Down
32 changes: 32 additions & 0 deletions src/mdbExtensionController.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -487,6 +487,38 @@ export default class MDBExtensionController implements vscode.Disposable {
return Promise.resolve(true);
}
);
this.registerCommand(
EXTENSION_COMMANDS.MDB_COPY_DOCUMENT_ID_FROM_TREE,
async (element: DocumentTreeItem): Promise<boolean> => {
const { documentId } = element;

if (!documentId) {
void vscode.window.showWarningMessage('Can\'t copy ID from document that has no ID.');
return false;
}

let body = JSON.stringify(documentId);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens here if documentId contains non-JS bson datatypes, e.g. Binary() or similar? Should this be EJSON instead of JSON?


if (body.startsWith('"')) {
body = body.slice(1, body.length - 1);
}
Comment on lines +502 to +504
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the idea here is to leave string document ids as-is, it might be better to check e.g. if (typeof body !== 'string') { body = JSON.stringify(documentId); } instead, since this currently still leaves JSON escapes in body


await vscode.env.clipboard.writeText(body);
return true;
}
);
this.registerCommand(
EXTENSION_COMMANDS.MDB_COPY_DOCUMENT_FROM_TREE,
async (element: DocumentTreeItem): Promise<boolean> => {
const { document } = element;
const tabSize = vscode.workspace
.getConfiguration('editor')
.get('tabSize', 2);
const body = JSON.stringify(document, undefined, tabSize);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similar question here :)

await vscode.env.clipboard.writeText(body);
return true;
}
);
this.registerCommand(
EXTENSION_COMMANDS.MDB_REFRESH_SCHEMA,
(schemaTreeItem: SchemaTreeItem): Promise<boolean> => {
Expand Down