From d09a80260b2ca69ad8b413cbff6006538b8f64ad Mon Sep 17 00:00:00 2001 From: Vinit Singh Date: Wed, 28 Aug 2019 21:16:10 +0530 Subject: [PATCH] lint: Replace local variables named 'msgid' with 'message_id'. Follow up of commit 2a1305d. Replace all local variables named 'msgid' with 'message_id' in all JS and HTML files, and adds a linter rule for it as well. Resolves #12952. --- static/js/emoji_picker.js | 4 ++-- static/js/notifications.js | 14 +++++++------- static/js/popovers.js | 20 ++++++++++---------- static/js/reminder.js | 8 ++++---- static/js/ui_init.js | 2 +- static/templates/actions_popover_content.hbs | 2 +- static/templates/compose_notification.hbs | 2 +- tools/linter_lib/custom_check.py | 2 ++ 8 files changed, 28 insertions(+), 26 deletions(-) diff --git a/static/js/emoji_picker.js b/static/js/emoji_picker.js index 2ca975317e..4bf628d1d1 100644 --- a/static/js/emoji_picker.js +++ b/static/js/emoji_picker.js @@ -714,7 +714,7 @@ exports.register_click_handlers = function () { }); $("body").on("click", ".actions_popover .reaction_button", function (e) { - var msgid = $(e.currentTarget).data('message-id'); + var message_id = $(e.currentTarget).data('message-id'); e.preventDefault(); e.stopPropagation(); // HACK: Because we need the popover to be based off an @@ -723,7 +723,7 @@ exports.register_click_handlers = function () { // element is not present, we use the message's // .fa-chevron-down element as the base for the popover. var elem = $(".selected_message .actions_hover")[0]; - emoji_picker.toggle_emoji_popover(elem, msgid); + emoji_picker.toggle_emoji_popover(elem, message_id); }); $("body").on("click", ".emoji-popover-tab-item", function (e) { diff --git a/static/js/notifications.js b/static/js/notifications.js index 838a567be3..23e77c2c1c 100644 --- a/static/js/notifications.js +++ b/static/js/notifications.js @@ -704,24 +704,24 @@ exports.reify_message_id = function (opts) { // update that link as well _.each($('#out-of-view-notification a'), function (e) { var elem = $(e); - var msgid = elem.data('msgid'); + var message_id = elem.data('message-id'); - if (msgid === old_id) { - elem.data('msgid', new_id); + if (message_id === old_id) { + elem.data('message-id', new_id); } }); }; exports.register_click_handlers = function () { $('#out-of-view-notification').on('click', '.compose_notification_narrow_by_topic', function (e) { - var msgid = $(e.currentTarget).data('msgid'); - narrow.by_topic(msgid, {trigger: 'compose_notification'}); + var message_id = $(e.currentTarget).data('message-id'); + narrow.by_topic(message_id, {trigger: 'compose_notification'}); e.stopPropagation(); e.preventDefault(); }); $('#out-of-view-notification').on('click', '.compose_notification_scroll_to_message', function (e) { - var msgid = $(e.currentTarget).data('msgid'); - current_msg_list.select_id(msgid); + var message_id = $(e.currentTarget).data('message-id'); + current_msg_list.select_id(message_id); navigate.scroll_to_selected(); e.stopPropagation(); e.preventDefault(); diff --git a/static/js/popovers.js b/static/js/popovers.js index 3dd6d1ba2f..a00f6c408b 100644 --- a/static/js/popovers.js +++ b/static/js/popovers.js @@ -901,8 +901,8 @@ exports.register_click_handlers = function () { }); $('body').on('click', '.reminder_button', function (e) { - var msgid = $(e.currentTarget).data('message-id'); - popovers.render_actions_remind_popover($(".selected_message .actions_hover")[0], msgid); + var message_id = $(e.currentTarget).data('message-id'); + popovers.render_actions_remind_popover($(".selected_message .actions_hover")[0], message_id); e.stopPropagation(); e.preventDefault(); }); @@ -967,8 +967,8 @@ exports.register_click_handlers = function () { e.preventDefault(); }); $('body').on('click', '.popover_toggle_collapse', function (e) { - var msgid = $(e.currentTarget).data('message-id'); - var row = current_msg_list.get_row(msgid); + var message_id = $(e.currentTarget).data('message-id'); + var row = current_msg_list.get_row(message_id); var message = current_msg_list.get(rows.id(row)); popovers.hide_actions_popover(); @@ -985,16 +985,16 @@ exports.register_click_handlers = function () { e.preventDefault(); }); $('body').on('click', '.popover_edit_message', function (e) { - var msgid = $(e.currentTarget).data('message-id'); - var row = current_msg_list.get_row(msgid); + var message_id = $(e.currentTarget).data('message-id'); + var row = current_msg_list.get_row(message_id); popovers.hide_actions_popover(); message_edit.start(row); e.stopPropagation(); e.preventDefault(); }); $('body').on('click', '.view_edit_history', function (e) { - var msgid = $(e.currentTarget).data('msgid'); - var row = current_msg_list.get_row(msgid); + var message_id = $(e.currentTarget).data('message-id'); + var row = current_msg_list.get_row(message_id); var message = current_msg_list.get(rows.id(row)); var message_history_cancel_btn = $('#message-history-cancel'); @@ -1026,9 +1026,9 @@ exports.register_click_handlers = function () { }); $('body').on('click', '.delete_message', function (e) { - var msgid = $(e.currentTarget).data('message-id'); + var message_id = $(e.currentTarget).data('message-id'); popovers.hide_actions_popover(); - message_edit.delete_message(msgid); + message_edit.delete_message(message_id); e.stopPropagation(); e.preventDefault(); }); diff --git a/static/js/reminder.js b/static/js/reminder.js index 3107a91e0d..f18139017d 100644 --- a/static/js/reminder.js +++ b/static/js/reminder.js @@ -91,8 +91,8 @@ exports.schedule_message = function (request) { transmit.send_message(request, success, error); }; -exports.do_set_reminder_for_message = function (msgid, timestamp) { - var row = $("[zid='" + msgid + "']"); +exports.do_set_reminder_for_message = function (message_id, timestamp) { + var row = $("[zid='" + message_id + "']"); function error() { row.find(".alert-msg") .text(i18n.t("Reminder not set!")) @@ -103,7 +103,7 @@ exports.do_set_reminder_for_message = function (msgid, timestamp) { }); } - var message = current_msg_list.get(msgid); + var message = current_msg_list.get(message_id); if (!message.raw_content) { var msg_list = current_msg_list; @@ -113,7 +113,7 @@ exports.do_set_reminder_for_message = function (msgid, timestamp) { success: function (data) { if (current_msg_list === msg_list) { message.raw_content = data.raw_content; - exports.do_set_reminder_for_message(msgid, timestamp); + exports.do_set_reminder_for_message(message_id, timestamp); } }, error: error, diff --git a/static/js/ui_init.js b/static/js/ui_init.js index 1c88a4f61a..70e6d2015f 100644 --- a/static/js/ui_init.js +++ b/static/js/ui_init.js @@ -42,7 +42,7 @@ function message_hover(message_row) { !message.status_message) { message_row.find(".edit_content").html(''); } else { - message_row.find(".edit_content").html(''); + message_row.find(".edit_content").html(''); } } diff --git a/static/templates/actions_popover_content.hbs b/static/templates/actions_popover_content.hbs index df6a2c3593..902712e7cd 100644 --- a/static/templates/actions_popover_content.hbs +++ b/static/templates/actions_popover_content.hbs @@ -45,7 +45,7 @@ {{#if should_display_edit_history_option}}
  • - + {{t "View edit history" }} diff --git a/static/templates/compose_notification.hbs b/static/templates/compose_notification.hbs index 438248c48d..882e4ccef2 100644 --- a/static/templates/compose_notification.hbs +++ b/static/templates/compose_notification.hbs @@ -1,5 +1,5 @@ {{! Content of sent-message notifications }}
    - {{note}} {{#if link_class}}{{link_text}}{{/if}} + {{note}} {{#if link_class}}{{link_text}}{{/if}}
    diff --git a/tools/linter_lib/custom_check.py b/tools/linter_lib/custom_check.py index bb47667651..8d6e55966a 100644 --- a/tools/linter_lib/custom_check.py +++ b/tools/linter_lib/custom_check.py @@ -119,6 +119,8 @@ js_rules = RuleList( 'bad_lines': ['subject="foo"', ' MAX_SUBJECT_LEN']}, {'pattern': r'[^_]function\(', 'description': 'The keyword "function" should be followed by a space'}, + {'pattern': 'msgid|MSGID', + 'description': 'Avoid using "msgid" as a variable name; use "message_id" instead.'}, {'pattern': r'.*blueslip.warning\(.*', 'description': 'The module blueslip has no function warning, try using blueslip.warn'}, {'pattern': '[)]{$',