paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-11 09:27:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

linter: Add rule against using the style attribute.

Browse Source 
This has a ton of exclude rules, for two reasons:

(1) We haven't been particularly systematic about avoiding unnecessary
inline style in the past, so there's a lot of code we need to fix.

(2) There are cases where one wants to dynamically compute style
rules. For the latter category, ideally we'd figure out a way to
exclude these automatically (e.g. checking for mustache tags in the
style tag).
This commit is contained in:
derAnfaenger
2017-10-06 10:12:47 +02:00
committed by Tim Abbott
parent 1a9adbbe70
commit c022b7a8fa
2 changed files with 71 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
tools/linter_lib/custom_check.py
View File

@@ -191,6 +191,17 @@ def build_custom_checkers(by_lang):
'description': "`Use $(f) rather than `$(document).ready(f)`",
'good_lines': ['$(function () {foo();}'],
'bad_lines': ['$(document).ready(function () {foo();}']},
{'pattern': 'style ?=',
'description': "Avoid using the `style=` attribute; we prefer styling in CSS files",
'exclude': set([
'frontend_tests/node_tests/compose.js',
'frontend_tests/node_tests/templates.js',
'static/js/compose.js',
'static/js/dynamic_text.js',
'static/js/stream_color.js',
]),
'good_lines': ['#my-style {color: blue;}'],
'bad_lines': ['<p style="color: blue;">Foo</p>', 'style = "color: blue;"']},
]) + whitespace_rules
python_rules = cast(RuleList, [
{'pattern': '^(?!#)@login_required',
@@ -441,6 +452,63 @@ def build_custom_checkers(by_lang):
'exclude': set(['templates/zerver/dev_login.html']),
'good_lines': ["($('#foo').on('click', function () {}"],
'bad_lines': ["<button id='foo' onclick='myFunction()'>Foo</button>", "<input onchange='myFunction()'>"]},
{'pattern': 'style ?=',
'description': "Avoid using the `style=` attribute; we prefer styling in CSS files",
'exclude': set([
# KaTeX output uses style attribute
'templates/zerver/markdown_help.html',
# 5xx page doesn't have external CSS
'static/html/5xx.html',
# Group PMs color is dynamically calculated
'static/templates/group_pms.handlebars',
# Subscription templates with stream color need the color
'static/templates/stream_sidebar_row.handlebars',
'static/templates/single_message.handlebars',
'static/templates/draft.handlebars',
'static/templates/subscription.handlebars',
'static/templates/subscription_settings.handlebars',
'static/templates/subscription_setting_icon.handlebars',
# A bunch of files uses `display: none` for initial state
'static/templates/settings/account-settings.handlebars',
'templates/zerver/compose.html',
'templates/zerver/navbar.html',
'templates/zerver/index.html',
'static/templates/message_edit_form.handlebars',
'static/templates/compose-invite-users.handlebars',
'static/templates/recipient_row.handlebars',
# Old-style email templates need to use inline style
# attributes; it should be possible to clean these up
# when we convert these templates to use premailer.
'templates/zerver/emails/digest.html',
'templates/zerver/emails/missed_message.html',
'templates/zerver/emails/email_base_messages.html',
# Inline styling for an svg; could be moved to CSS files?
'templates/zerver/landing_nav.html',
'templates/zerver/home.html',
'templates/zerver/features.html',
'templates/zerver/portico-header.html',
# Miscellaneous violations to be cleaned up
'static/templates/user_info_popover_title.handlebars',
'static/templates/subscription_invites_warning_modal.handlebars',
'templates/zerver/reset_confirm.html',
'templates/zerver/config_error.html',
'templates/zerver/dev_env_email_access_details.html',
'templates/zerver/confirm_continue_registration.html',
'templates/zerver/register.html',
'templates/zerver/accounts_send_confirm.html',
'templates/zerver/integrations/index.html',
'templates/zerver/help/main.html',
'templates/analytics/realm_summary_table.html',
'templates/corporate/zephyr.html',
'templates/corporate/zephyr-mirror.html',
]),
'good_lines': ['#my-style {color: blue;}'],
'bad_lines': ['<p style="color: blue;">Foo</p>', 'style = "color: blue;"']},
] # type: RuleList
handlebars_rules = html_rules + [
{'pattern': "[<]script",