Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

lint: Improve documentation lint check for JavaScript capitalization. 

Move JavaScript capitalization rule to new ruleset for HTML and
Markdown checkers to run, and add exclusion to avoid catching
URLs and divs/hrefs. Also fix affected HTML pages, and remove
now-obsolete exclusion for doc that no longer exists.

For exhaustive thought-process on this change see:
https://zulip.tabbott.net/#narrow/stream/test.20suites/topic/watch.20over.20my.20shoulder.20as.20I.20improve.20the.20linter
This commit is contained in:
Sumana Harihareswara 2016-10-16 11:40:16 -04:00 committed by Tim Abbott
parent 2bea0c46fe
commit bef73be824
2 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
templates/zerver/api.html
View File

@ -5,7 +5,7 @@
{% block portico_content %} {% block portico_content %}
<h1 class="api-page-header">We hear you like APIs...</h1> <h1 class="api-page-header">We hear you like APIs...</h1>
<p>We have a <a href="/api/endpoints">well-documented API</a> that allows you to build custom integrations, in addition to our <a href="/integrations">existing integrations</a>. For ease-of-use, we've created a Python module that you can drop in to a project to start interacting with our API. There is also a <a href="https://github.com/zulip/zulip-js">Javascript library</a> that can be used either in the browser or in Node.js.</p> <p>We have a <a href="/api/endpoints">well-documented API</a> that allows you to build custom integrations, in addition to our <a href="/integrations">existing integrations</a>. For ease-of-use, we've created a Python module that you can drop in to a project to start interacting with our API. There is also a <a href="https://github.com/zulip/zulip-js">JavaScript library</a> that can be used either in the browser or in Node.js.</p>
<p><strong>Don't want to make it yourself?</strong> Zulip <a href="/integrations">already integrates with lots of services</a>.</p> <p><strong>Don't want to make it yourself?</strong> Zulip <a href="/integrations">already integrates with lots of services</a>.</p>
@ -26,7 +26,7 @@
<li><tt>requests</tt> (0.12.1 or later)</li> <li><tt>requests</tt> (0.12.1 or later)</li>
</ul> </ul>
<p>&nbsp;</p> <p>&nbsp;</p>
<h4>Javascript</h4> <h4>JavaScript</h4>
<p>Install it with <a href="https://www.npmjs.com/package/zulip-js">npm</a>:</p> <p>Install it with <a href="https://www.npmjs.com/package/zulip-js">npm</a>:</p>
<pre><code>npm install zulip-js</code></pre> <pre><code>npm install zulip-js</code></pre>
@ -36,7 +36,7 @@
<li class="active"><a href="#curl" data-toggle="tab">curl</a></li> <li class="active"><a href="#curl" data-toggle="tab">curl</a></li>
<li><a href="#python" data-toggle="tab">Python</a></li> <li><a href="#python" data-toggle="tab">Python</a></li>
<li><a href="#commandline" data-toggle="tab">zulip-send</a></li> <li><a href="#commandline" data-toggle="tab">zulip-send</a></li>
<li><a href="#javascript" data-toggle="tab">Javascript</a></li> <li><a href="#javascript" data-toggle="tab">JavaScript</a></li>
</ul> </ul>
<div class="tab-content"> <div class="tab-content">

12
tools/lint-all
View File

@ -320,18 +320,18 @@ def build_custom_checkers(by_lang):
'description': "Missing whitespace after '{' in CSS (should be newline)."}, 'description': "Missing whitespace after '{' in CSS (should be newline)."},
]) + whitespace_rules # type: RuleList ]) + whitespace_rules # type: RuleList
handlebars_rules = whitespace_rules handlebars_rules = whitespace_rules
html_rules = whitespace_rules + [ prose_style_rules = [
{'pattern': '[^\/\#\-\"]([jJ]avascript)', # exclude usage in hrefs/divs
'description': "javascript should be spelled JavaScript"},
] # type: RuleList
html_rules = whitespace_rules + prose_style_rules + [
{'pattern': 'placeholder="[^{]', {'pattern': 'placeholder="[^{]',
'description': "`placeholder` value should be translatable."}, 'description': "`placeholder` value should be translatable."},
{'pattern': "placeholder='[^{]", {'pattern': "placeholder='[^{]",
'description': "`placeholder` value should be translatable."}, 'description': "`placeholder` value should be translatable."},
] # type: RuleList ] # type: RuleList
json_rules = [] # type: RuleList # just fix newlines at ends of files json_rules = [] # type: RuleList # just fix newlines at ends of files
markdown_rules = markdown_whitespace_rules + [ markdown_rules = markdown_whitespace_rules + prose_style_rules
{'pattern': ' [jJ]avascript',
'exclude': set(['README.dev.md']), # temporary exclusion to avoid merge conflicts
'description': "javascript should be spelled JavaScript"},
] # type: RuleList
txt_rules = whitespace_rules txt_rules = whitespace_rules
def check_custom_checks_py(): def check_custom_checks_py():