From ec2033fe15492be6d7ab18746cf90cff377b3eee Mon Sep 17 00:00:00 2001 From: Jelte Fennema-Nio Date: Sat, 15 Feb 2025 12:32:34 +0100 Subject: [PATCH 1/3] Add biome formatting for js and css (#29) --- .github/workflows/ci.yaml | 8 ++++++++ Makefile | 3 +++ biome.json | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+) create mode 100644 biome.json diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index e5fa5464..6fa14369 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -19,3 +19,11 @@ jobs: uses: astral-sh/ruff-action@v2 with: args: "format --check" + + - name: Setup Biome + uses: biomejs/setup-biome@v2 + with: + version: latest + + - name: Run Biome + run: biome ci . diff --git a/Makefile b/Makefile index 116798bd..9b6ed017 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,11 @@ format: ruff format + npx @biomejs/biome format --write lint: ruff check + npx @biomejs/biome check lint-fix: ruff check --fix + npx @biomejs/biome check --fix diff --git a/biome.json b/biome.json new file mode 100644 index 00000000..1c3d6648 --- /dev/null +++ b/biome.json @@ -0,0 +1,36 @@ +{ + "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json", + "vcs": { + "enabled": false, + "clientKind": "git", + "useIgnoreFile": false + }, + "files": { + "ignoreUnknown": true, + "ignore": [], + "include": [ + "media/commitfest/js/commitfest.js", + "media/commitfest/css/commitfest.css", + "biome.json" + ] + }, + "formatter": { + "enabled": true, + "indentStyle": "space", + "indentWidth": 4 + }, + "organizeImports": { + "enabled": true + }, + "linter": { + "enabled": true, + "rules": { + "recommended": true + } + }, + "javascript": { + "formatter": { + "quoteStyle": "double" + } + } +} From 305d384d9d41f0e303bcc06c2fcaa1791ccbba06 Mon Sep 17 00:00:00 2001 From: Jelte Fennema-Nio Date: Sat, 15 Feb 2025 12:49:41 +0100 Subject: [PATCH 2/3] Format files using biome (#29) --- media/commitfest/css/commitfest.css | 36 +- media/commitfest/js/commitfest.js | 516 +++++++++++++++------------- 2 files changed, 301 insertions(+), 251 deletions(-) diff --git a/media/commitfest/css/commitfest.css b/media/commitfest/css/commitfest.css index d4ab8e2c..fe6f6b80 100644 --- a/media/commitfest/css/commitfest.css +++ b/media/commitfest/css/commitfest.css @@ -4,47 +4,45 @@ /* For close button with float disabled */ .close-nofloat { - float: none !important; + float: none !important; } /* General form styling */ .form-horizontal div.form-group { - margin-bottom: 10px; + margin-bottom: 10px; } div.form-group div.controls ul { - list-style-type: none; - margin: 0px; - padding: 0px; + list-style-type: none; + margin: 0px; + padding: 0px; } div.form-group div.controls ul li { - display: inline; + display: inline; } div.form-group div.controls ul li label { - display: inline; - font-weight: normal; - vertical-align:middle; + display: inline; + font-weight: normal; + vertical-align: middle; } div.form-group div.controls ul li label input { - display: inline; - vertical-align:middle; + display: inline; + vertical-align: middle; } -div.form-group div.controls input[type='checkbox'] { - width: 10px; +div.form-group div.controls input[type="checkbox"] { + width: 10px; } div.form-group div.controls input.threadpick-input { - width: 80%; - display: inline; + width: 80%; + display: inline; } - - /* * Attach thread dialog */ #attachThreadListWrap.loading { display: block; - background: url('/media/commitfest/spinner.gif') no-repeat center; + background: url("/media/commitfest/spinner.gif") no-repeat center; width: 124px; height: 124px; margin: 0 auto; @@ -57,7 +55,7 @@ div.form-group div.controls input.threadpick-input { * Annotate message dialog */ #annotateMessageBody.loading { display: block; - background: url('/media/commitfest/spinner.gif') no-repeat center; + background: url("/media/commitfest/spinner.gif") no-repeat center; width: 124px; height: 124px; margin: 0 auto; diff --git a/media/commitfest/js/commitfest.js b/media/commitfest/js/commitfest.js index 57b34cd5..1e0bfde9 100644 --- a/media/commitfest/js/commitfest.js +++ b/media/commitfest/js/commitfest.js @@ -1,314 +1,366 @@ function verify_reject() { - return confirm('Are you sure you want to close this patch as Rejected?\n\nThis should only be done when a patch will never be applied - if more work is needed, it should instead be set to "Returned with Feedback" or "Moved to next CF".\n\nSo - are you sure?'); + return confirm( + 'Are you sure you want to close this patch as Rejected?\n\nThis should only be done when a patch will never be applied - if more work is needed, it should instead be set to "Returned with Feedback" or "Moved to next CF".\n\nSo - are you sure?', + ); } function verify_withdrawn() { - return confirm('Are you sure you want to close this patch as Withdrawn?\n\nThis should only be done when the author voluntarily withdraws the patch.\n\nSo - are you sure?'); + return confirm( + "Are you sure you want to close this patch as Withdrawn?\n\nThis should only be done when the author voluntarily withdraws the patch.\n\nSo - are you sure?", + ); } function verify_returned() { - return confirm('Are you sure you want to close this patch as Returned with Feedback?\n\nThis should be done if the patch is expected to be finished at some future time, but not necessarily in the next commitfest. If work is undergoing and expected in the next commitfest, it should instead be set to "Moved to next CF".\n\nSo - are you sure?'); + return confirm( + 'Are you sure you want to close this patch as Returned with Feedback?\n\nThis should be done if the patch is expected to be finished at some future time, but not necessarily in the next commitfest. If work is undergoing and expected in the next commitfest, it should instead be set to "Moved to next CF".\n\nSo - are you sure?', + ); } function verify_next() { - return confirm('Are you sure you want to move this patch to the next commitfest?\n\nThis means the patch will be marked as closed in this commitfest, but will automatically be moved to the next one. If no further work is expected on this patch, it should be closed with "Rejected" or "Returned with Feedback" instead.\n\nSo - are you sure?'); + return confirm( + 'Are you sure you want to move this patch to the next commitfest?\n\nThis means the patch will be marked as closed in this commitfest, but will automatically be moved to the next one. If no further work is expected on this patch, it should be closed with "Rejected" or "Returned with Feedback" instead.\n\nSo - are you sure?', + ); } function findLatestThreads() { - $('#attachThreadListWrap').addClass('loading'); - $('#attachThreadSearchButton').addClass('disabled'); - $.get('/ajax/getThreads/', { - 's': $('#attachThreadSearchField').val(), - 'a': $('#attachThreadAttachOnly').val(), - }).success(function(data) { - sel = $('#attachThreadList'); - sel.find('option').remove(); - $.each(data, function(m,i) { - sel.append($(''); - $.each(data, function(i,m) { - sel.append(''); - }); - }).always(function() { - $('#annotateMessageBody').removeClass('loading'); - }); + $("#annotateMessageBody").addClass("loading"); + $("#doAnnotateMessageButton").addClass("disabled"); + $.get("/ajax/getMessages", { + t: threadid, + }) + .success(function (data) { + sel = $("#annotateMessageList"); + sel.find("option").remove(); + sel.append(''); + $.each(data, function (i, m) { + sel.append( + '", + ); + }); + }) + .always(function () { + $("#annotateMessageBody").removeClass("loading"); + }); } function addAnnotation(threadid) { - $('#annotateThreadList').find('option').remove(); - $('#annotateMessage').val(''); - $('#annotateMsgId').val(''); - $('#annotateModal').modal(); - $('#annotateThreadList').focus(); + $("#annotateThreadList").find("option").remove(); + $("#annotateMessage").val(""); + $("#annotateMsgId").val(""); + $("#annotateModal").modal(); + $("#annotateThreadList").focus(); updateAnnotationMessages(threadid); - $('#doAnnotateMessageButton').unbind('click'); - $('#doAnnotateMessageButton').click(function() { - var msg = $('#annotateMessage').val(); - if (msg.length >= 500) { - alert('Maximum length for an annotation is 500 characters.\nYou should probably post an actual message in the thread!'); - return; - } - $('#doAnnotateMessageButton').addClass('disabled'); - $('#annotateMessageBody').addClass('loading'); - $.post('/ajax/annotateMessage/', { - 't': threadid, - 'msgid': $.trim($('#annotateMsgId').val()), - 'msg': msg - }).success(function(data) { - if (data != 'OK') { - alert(data); - $('#annotateMessageBody').removeClass('loading'); - } - else { - $('#annotateModal').modal('hide'); - location.reload(); - } - }).fail(function(data) { - alert('Failed to annotate message'); - $('#annotateMessageBody').removeClass('loading'); - }); + $("#doAnnotateMessageButton").unbind("click"); + $("#doAnnotateMessageButton").click(function () { + var msg = $("#annotateMessage").val(); + if (msg.length >= 500) { + alert( + "Maximum length for an annotation is 500 characters.\nYou should probably post an actual message in the thread!", + ); + return; + } + $("#doAnnotateMessageButton").addClass("disabled"); + $("#annotateMessageBody").addClass("loading"); + $.post("/ajax/annotateMessage/", { + t: threadid, + msgid: $.trim($("#annotateMsgId").val()), + msg: msg, + }) + .success(function (data) { + if (data != "OK") { + alert(data); + $("#annotateMessageBody").removeClass("loading"); + } else { + $("#annotateModal").modal("hide"); + location.reload(); + } + }) + .fail(function (data) { + alert("Failed to annotate message"); + $("#annotateMessageBody").removeClass("loading"); + }); }); } function annotateMsgPicked() { - var val = $('#annotateMessageList').val(); + var val = $("#annotateMessageList").val(); if (val) { - $('#annotateMsgId').val(val); - annotateChanged(); + $("#annotateMsgId").val(val); + annotateChanged(); } } function annotateChanged() { /* Enable/disable the annotate button */ - if ($('#annotateMessage').val() != '' && $('#annotateMsgId').val()) { - $('#doAnnotateMessageButton').removeClass('disabled'); - } - else { - $('#doAnnotateMessageButton').addClass('disabled'); + if ($("#annotateMessage").val() != "" && $("#annotateMsgId").val()) { + $("#doAnnotateMessageButton").removeClass("disabled"); + } else { + $("#doAnnotateMessageButton").addClass("disabled"); } } function deleteAnnotation(annid) { - if (confirm('Are you sure you want to delete this annotation?')) { - $.post('/ajax/deleteAnnotation/', { - 'id': annid, - }).success(function(data) { - location.reload(); - }).fail(function(data) { - alert('Failed to delete annotation!'); - }); + if (confirm("Are you sure you want to delete this annotation?")) { + $.post("/ajax/deleteAnnotation/", { + id: annid, + }) + .success(function (data) { + location.reload(); + }) + .fail(function (data) { + alert("Failed to delete annotation!"); + }); } } function flagCommitted(committer) { - $('#commitModal').modal(); - $('#committerSelect').val(committer); - $('#doCommitButton').unbind('click'); - $('#doCommitButton').click(function() { - var c = $('#committerSelect').val(); - if (!c) { - alert('You need to select a committer before you can mark a patch as committed!'); - return; - } - document.location.href='close/committed/?c=' + c; - }); - return false; + $("#commitModal").modal(); + $("#committerSelect").val(committer); + $("#doCommitButton").unbind("click"); + $("#doCommitButton").click(function () { + var c = $("#committerSelect").val(); + if (!c) { + alert( + "You need to select a committer before you can mark a patch as committed!", + ); + return; + } + document.location.href = "close/committed/?c=" + c; + }); + return false; } - function sortpatches(sortby) { - if ($('#id_sortkey').val() == sortby) { - $('#id_sortkey').val(0); - } else { - $('#id_sortkey').val(sortby); - } - $('#filterform').submit(); + if ($("#id_sortkey").val() == sortby) { + $("#id_sortkey").val(0); + } else { + $("#id_sortkey").val(sortby); + } + $("#filterform").submit(); - return false; + return false; } function toggleButtonCollapse(buttonId, collapseId) { - $('#' + buttonId).button('toggle'); - $('#' + collapseId).toggleClass('in') + $("#" + buttonId).button("toggle"); + $("#" + collapseId).toggleClass("in"); } function togglePatchFilterButton(buttonId, collapseId) { - /* Figure out if we are collapsing it */ - if ($('#' + collapseId).hasClass('in')) { - /* Go back to ourselves without a querystring to reset the form, unless it's already empty */ - if (document.location.href.indexOf('?') > -1) { - document.location.href = '.'; - return; - } - } + /* Figure out if we are collapsing it */ + if ($("#" + collapseId).hasClass("in")) { + /* Go back to ourselves without a querystring to reset the form, unless it's already empty */ + if (document.location.href.indexOf("?") > -1) { + document.location.href = "."; + return; + } + } - toggleButtonCollapse(buttonId, collapseId); + toggleButtonCollapse(buttonId, collapseId); } - /* * Upstream user search dialog */ function search_and_store_user() { - $('#doSelectUserButton').unbind('click'); - $('#doSelectUserButton').click(function() { - if (!$('#searchUserList').val()) { return false; } + $("#doSelectUserButton").unbind("click"); + $("#doSelectUserButton").click(function () { + if (!$("#searchUserList").val()) { + return false; + } - /* Create this user locally */ - $.get('/ajax/importUser/', { - 'u': $('#searchUserList').val(), - }).success(function(data) { - if (data == 'OK') { - alert('User imported!'); - $('#searchUserModal').modal('hide'); - } else { - alert('Failed to import user: ' + data); - } - }).fail(function(data, statustxt) { - alert('Failed to import user: ' + statustxt); - }); + /* Create this user locally */ + $.get("/ajax/importUser/", { + u: $("#searchUserList").val(), + }) + .success(function (data) { + if (data == "OK") { + alert("User imported!"); + $("#searchUserModal").modal("hide"); + } else { + alert("Failed to import user: " + data); + } + }) + .fail(function (data, statustxt) { + alert("Failed to import user: " + statustxt); + }); - return false; + return false; }); - $('#searchUserModal').modal(); + $("#searchUserModal").modal(); } function findUsers() { - if (!$('#searchUserSearchField').val()) { - alert('No search term specified'); - return false; + if (!$("#searchUserSearchField").val()) { + alert("No search term specified"); + return false; } - $('#searchUserListWrap').addClass('loading'); - $('#searchUserSearchButton').addClass('disabled'); - $.get('/ajax/searchUsers/', { - 's': $('#searchUserSearchField').val(), - }).success(function(data) { - sel = $('#searchUserList'); - sel.find('option').remove(); - $.each(data, function(i,u) { - sel.append(''); + $("#searchUserListWrap").addClass("loading"); + $("#searchUserSearchButton").addClass("disabled"); + $.get("/ajax/searchUsers/", { + s: $("#searchUserSearchField").val(), + }) + .success(function (data) { + sel = $("#searchUserList"); + sel.find("option").remove(); + $.each(data, function (i, u) { + sel.append( + '", + ); + }); + }) + .always(function () { + $("#searchUserListWrap").removeClass("loading"); + $("#searchUserSearchButton").removeClass("disabled"); + searchUserListChanged(); }); - }).always(function() { - $('#searchUserListWrap').removeClass('loading'); - $('#searchUserSearchButton').removeClass('disabled'); - searchUserListChanged(); - }); - return false; + return false; } function searchUserListChanged() { - if ($('#searchUserList').val()) { - $('#doSelectUserButton').removeClass('disabled'); - } - else { - $('#doSelectUserButton').addClass('disabled'); - } + if ($("#searchUserList").val()) { + $("#doSelectUserButton").removeClass("disabled"); + } else { + $("#doSelectUserButton").addClass("disabled"); + } } function addGitCheckoutToClipboard(patchId) { From 3d63e9f597ef83114ffa9274f1b3ec2066abcc32 Mon Sep 17 00:00:00 2001 From: Jelte Fennema-Nio Date: Sat, 15 Feb 2025 12:54:10 +0100 Subject: [PATCH 3/3] Fix biome lints using --fix --unsafe (#29) --- media/commitfest/js/commitfest.js | 118 +++++++++++++----------------- 1 file changed, 50 insertions(+), 68 deletions(-) diff --git a/media/commitfest/js/commitfest.js b/media/commitfest/js/commitfest.js index 1e0bfde9..461227f8 100644 --- a/media/commitfest/js/commitfest.js +++ b/media/commitfest/js/commitfest.js @@ -25,18 +25,18 @@ function findLatestThreads() { s: $("#attachThreadSearchField").val(), a: $("#attachThreadAttachOnly").val(), }) - .success(function (data) { + .success((data) => { sel = $("#attachThreadList"); sel.find("option").remove(); - $.each(data, function (m, i) { + $.each(data, (m, i) => { sel.append( $("'); - $.each(data, function (i, m) { + $.each(data, (i, m) => { sel.append( - '", + ``, ); }); }) - .always(function () { + .always(() => { $("#annotateMessageBody").removeClass("loading"); }); } @@ -180,8 +170,8 @@ function addAnnotation(threadid) { $("#annotateThreadList").focus(); updateAnnotationMessages(threadid); $("#doAnnotateMessageButton").unbind("click"); - $("#doAnnotateMessageButton").click(function () { - var msg = $("#annotateMessage").val(); + $("#doAnnotateMessageButton").click(() => { + const msg = $("#annotateMessage").val(); if (msg.length >= 500) { alert( "Maximum length for an annotation is 500 characters.\nYou should probably post an actual message in the thread!", @@ -195,8 +185,8 @@ function addAnnotation(threadid) { msgid: $.trim($("#annotateMsgId").val()), msg: msg, }) - .success(function (data) { - if (data != "OK") { + .success((data) => { + if (data !== "OK") { alert(data); $("#annotateMessageBody").removeClass("loading"); } else { @@ -204,7 +194,7 @@ function addAnnotation(threadid) { location.reload(); } }) - .fail(function (data) { + .fail((data) => { alert("Failed to annotate message"); $("#annotateMessageBody").removeClass("loading"); }); @@ -212,7 +202,7 @@ function addAnnotation(threadid) { } function annotateMsgPicked() { - var val = $("#annotateMessageList").val(); + const val = $("#annotateMessageList").val(); if (val) { $("#annotateMsgId").val(val); annotateChanged(); @@ -221,7 +211,7 @@ function annotateMsgPicked() { function annotateChanged() { /* Enable/disable the annotate button */ - if ($("#annotateMessage").val() != "" && $("#annotateMsgId").val()) { + if ($("#annotateMessage").val() !== "" && $("#annotateMsgId").val()) { $("#doAnnotateMessageButton").removeClass("disabled"); } else { $("#doAnnotateMessageButton").addClass("disabled"); @@ -233,10 +223,10 @@ function deleteAnnotation(annid) { $.post("/ajax/deleteAnnotation/", { id: annid, }) - .success(function (data) { + .success((data) => { location.reload(); }) - .fail(function (data) { + .fail((data) => { alert("Failed to delete annotation!"); }); } @@ -246,21 +236,21 @@ function flagCommitted(committer) { $("#commitModal").modal(); $("#committerSelect").val(committer); $("#doCommitButton").unbind("click"); - $("#doCommitButton").click(function () { - var c = $("#committerSelect").val(); + $("#doCommitButton").click(() => { + const c = $("#committerSelect").val(); if (!c) { alert( "You need to select a committer before you can mark a patch as committed!", ); return; } - document.location.href = "close/committed/?c=" + c; + document.location.href = `close/committed/?c=${c}`; }); return false; } function sortpatches(sortby) { - if ($("#id_sortkey").val() == sortby) { + if ($("#id_sortkey").val() === sortby) { $("#id_sortkey").val(0); } else { $("#id_sortkey").val(sortby); @@ -271,13 +261,13 @@ function sortpatches(sortby) { } function toggleButtonCollapse(buttonId, collapseId) { - $("#" + buttonId).button("toggle"); - $("#" + collapseId).toggleClass("in"); + $(`#${buttonId}`).button("toggle"); + $(`#${collapseId}`).toggleClass("in"); } function togglePatchFilterButton(buttonId, collapseId) { /* Figure out if we are collapsing it */ - if ($("#" + collapseId).hasClass("in")) { + if ($(`#${collapseId}`).hasClass("in")) { /* Go back to ourselves without a querystring to reset the form, unless it's already empty */ if (document.location.href.indexOf("?") > -1) { document.location.href = "."; @@ -293,7 +283,7 @@ function togglePatchFilterButton(buttonId, collapseId) { */ function search_and_store_user() { $("#doSelectUserButton").unbind("click"); - $("#doSelectUserButton").click(function () { + $("#doSelectUserButton").click(() => { if (!$("#searchUserList").val()) { return false; } @@ -302,16 +292,16 @@ function search_and_store_user() { $.get("/ajax/importUser/", { u: $("#searchUserList").val(), }) - .success(function (data) { - if (data == "OK") { + .success((data) => { + if (data === "OK") { alert("User imported!"); $("#searchUserModal").modal("hide"); } else { - alert("Failed to import user: " + data); + alert(`Failed to import user: ${data}`); } }) - .fail(function (data, statustxt) { - alert("Failed to import user: " + statustxt); + .fail((data, statustxt) => { + alert(`Failed to import user: ${statustxt}`); }); return false; @@ -330,24 +320,16 @@ function findUsers() { $.get("/ajax/searchUsers/", { s: $("#searchUserSearchField").val(), }) - .success(function (data) { + .success((data) => { sel = $("#searchUserList"); sel.find("option").remove(); - $.each(data, function (i, u) { + $.each(data, (i, u) => { sel.append( - '", + ``, ); }); }) - .always(function () { + .always(() => { $("#searchUserListWrap").removeClass("loading"); $("#searchUserSearchButton").removeClass("disabled"); searchUserListChanged();