Deprecate noteId var from getNoteTags in Js-API#18624
Merged
mikehardy merged 1 commit intoankidroid:mainfrom Jun 25, 2025
Merged
Deprecate noteId var from getNoteTags in Js-API#18624mikehardy merged 1 commit intoankidroid:mainfrom
mikehardy merged 1 commit intoankidroid:mainfrom
Conversation
Member
|
It would be useful to know where the method went And leave an extra line between the title and the first line of the message |
Member
Author
would this work? Index: AnkiDroid/src/main/assets/scripts/js-api.js
IDEA additional info:
Subsystem: com.intellij.openapi.diff.impl.patch.CharsetEP
<+>UTF-8
===================================================================
diff --git a/AnkiDroid/src/main/assets/scripts/js-api.js b/AnkiDroid/src/main/assets/scripts/js-api.js
--- a/AnkiDroid/src/main/assets/scripts/js-api.js (revision 18d14c2dec2f3bb15d03ffd6ebe06c291fcd4c22)
+++ b/AnkiDroid/src/main/assets/scripts/js-api.js (date 1750793826077)
@@ -130,6 +130,7 @@
}
if (method === "ankiSetNoteTags") {
AnkiDroidJS.prototype[method] = async function (noteId, tags) {
+ console.warn("ankiSetNoteTags: The noteId parameter is deprecated and will be ignored. The method now uses the current card's note ID automatically.");
let hasSpaces = false;
for (let i = 0; i < tags.length; i++) {
tags[i] = tags[i].trim();
@@ -147,8 +148,28 @@
};
return;
}
+ if (method === "ankiSetNoteTags") {
+ AnkiDroidJS.prototype[method] = async function (tags) {
+ let hasSpaces = false;
+ for (let i = 0; i < tags.length; i++) {
+ tags[i] = tags[i].trim();
+ if (tags[i].includes(" ") || tags[i].includes("\u3000")) {
+ tags[i] = tags[i].replace(" ", "_").replace("\u3000", "_");
+ hasSpaces = true;
+ }
+ }
+ if (hasSpaces) {
+ console.warn("Spaces in tags have been converted to underscores");
+ }
+ const endpoint = jsApiList[method];
+ const data = JSON.stringify({ tags });
+ return await this.handleRequest(endpoint, data);
+ };
+ return;
+ }
if (method === "ankiGetNoteTags") {
AnkiDroidJS.prototype[method] = async function (noteId) {
+ console.warn("ankiGetNoteTags: The noteId parameter is deprecated and will be ignored. The method now uses the current card's note ID automatically.");
const endpoint = jsApiList[method];
const data = JSON.stringify({ noteId });
return await this.handleRequest(endpoint, data);I think it might be better to do it this way, so as to not directly break anyone's decks, it follows the same |
Member
|
It's alpha functionality which we're removing. No need for complexity. The only change should be in the commit message, making it immediately clear to a reader whether the method was removed, or just refactored to less code |
Now consistent with other methods: the currently selected note is used * Stop special-casing `ankiGetNoteTags` as no params are needed * Adjust Object.keys usage accordingly * Move jsonObjectOf to JsonUtils.kt Issue 17716 Co-authored-by: David Allison <62114487+david-allison@users.noreply.github.com>
david-allison
approved these changes
Jun 25, 2025
Member
david-allison
left a comment
There was a problem hiding this comment.
I fixed up the commit message to reduce the back/forth required.
As I force pushed, PR changes are on me to resolve
Member
Author
Didn't know commit messages can be that long. |
Member
|
No length limit, have some 'long' ones: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose / Description
Fixes
How Has This Been Tested?
Fixed UnitTests
Checklist