12da489cd246702bee5938545b18a6f710ed214bcJamie Gennis#!/usr/bin/env python 22da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# 32da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# Copyright 2011 The Closure Linter Authors. All Rights Reserved. 42da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# 52da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# Licensed under the Apache License, Version 2.0 (the "License"); 62da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# you may not use this file except in compliance with the License. 72da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# You may obtain a copy of the License at 82da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# 92da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# http://www.apache.org/licenses/LICENSE-2.0 102da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# 112da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# Unless required by applicable law or agreed to in writing, software 122da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# distributed under the License is distributed on an "AS-IS" BASIS, 132da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 142da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# See the License for the specific language governing permissions and 152da489cd246702bee5938545b18a6f710ed214bcJamie Gennis# limitations under the License. 162da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 172da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 182da489cd246702bee5938545b18a6f710ed214bcJamie Gennis"""Specific JSLint errors checker.""" 192da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 202da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 212da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 222da489cd246702bee5938545b18a6f710ed214bcJamie Gennisimport gflags as flags 232da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 242da489cd246702bee5938545b18a6f710ed214bcJamie GennisFLAGS = flags.FLAGS 252da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 262da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 272da489cd246702bee5938545b18a6f710ed214bcJamie Gennisclass Rule(object): 282da489cd246702bee5938545b18a6f710ed214bcJamie Gennis """Different rules to check.""" 292da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 302da489cd246702bee5938545b18a6f710ed214bcJamie Gennis # Documentations for specific rules goes in flag definition. 312da489cd246702bee5938545b18a6f710ed214bcJamie Gennis BLANK_LINES_AT_TOP_LEVEL = 'blank_lines_at_top_level' 322da489cd246702bee5938545b18a6f710ed214bcJamie Gennis INDENTATION = 'indentation' 332da489cd246702bee5938545b18a6f710ed214bcJamie Gennis WELL_FORMED_AUTHOR = 'well_formed_author' 342da489cd246702bee5938545b18a6f710ed214bcJamie Gennis NO_BRACES_AROUND_INHERIT_DOC = 'no_braces_around_inherit_doc' 352da489cd246702bee5938545b18a6f710ed214bcJamie Gennis BRACES_AROUND_TYPE = 'braces_around_type' 362da489cd246702bee5938545b18a6f710ed214bcJamie Gennis OPTIONAL_TYPE_MARKER = 'optional_type_marker' 372da489cd246702bee5938545b18a6f710ed214bcJamie Gennis UNUSED_PRIVATE_MEMBERS = 'unused_private_members' 382da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 392da489cd246702bee5938545b18a6f710ed214bcJamie Gennis # Rule to raise all known errors. 402da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ALL = 'all' 412da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 422da489cd246702bee5938545b18a6f710ed214bcJamie Gennis # All rules that are to be checked when using the strict flag. E.g. the rules 432da489cd246702bee5938545b18a6f710ed214bcJamie Gennis # that are specific to the stricter Closure style. 442da489cd246702bee5938545b18a6f710ed214bcJamie Gennis CLOSURE_RULES = frozenset([BLANK_LINES_AT_TOP_LEVEL, 452da489cd246702bee5938545b18a6f710ed214bcJamie Gennis INDENTATION, 462da489cd246702bee5938545b18a6f710ed214bcJamie Gennis WELL_FORMED_AUTHOR, 472da489cd246702bee5938545b18a6f710ed214bcJamie Gennis NO_BRACES_AROUND_INHERIT_DOC, 482da489cd246702bee5938545b18a6f710ed214bcJamie Gennis BRACES_AROUND_TYPE, 492da489cd246702bee5938545b18a6f710ed214bcJamie Gennis OPTIONAL_TYPE_MARKER]) 502da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 512da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 522da489cd246702bee5938545b18a6f710ed214bcJamie Gennisflags.DEFINE_boolean('strict', False, 532da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'Whether to validate against the stricter Closure style. ' 542da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'This includes ' + (', '.join(Rule.CLOSURE_RULES)) + '.') 552da489cd246702bee5938545b18a6f710ed214bcJamie Gennisflags.DEFINE_multistring('jslint_error', [], 562da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'List of specific lint errors to check. Here is a list' 572da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' of accepted values:\n' 582da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.ALL + ': enables all following errors.\n' 592da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.BLANK_LINES_AT_TOP_LEVEL + ': validates' 602da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'number of blank lines between blocks at top level.\n' 612da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.INDENTATION + ': checks correct ' 622da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'indentation of code.\n' 632da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.WELL_FORMED_AUTHOR + ': validates the ' 642da489cd246702bee5938545b18a6f710ed214bcJamie Gennis '@author JsDoc tags.\n' 652da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.NO_BRACES_AROUND_INHERIT_DOC + ': ' 662da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'forbids braces around @inheritdoc JsDoc tags.\n' 672da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.BRACES_AROUND_TYPE + ': enforces braces ' 682da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'around types in JsDoc tags.\n' 692da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.OPTIONAL_TYPE_MARKER + ': checks correct ' 702da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'use of optional marker = in param types.\n' 712da489cd246702bee5938545b18a6f710ed214bcJamie Gennis ' - ' + Rule.UNUSED_PRIVATE_MEMBERS + ': checks for ' 722da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 'unused private variables.\n') 732da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 742da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 752da489cd246702bee5938545b18a6f710ed214bcJamie Gennisdef ShouldCheck(rule): 762da489cd246702bee5938545b18a6f710ed214bcJamie Gennis """Returns whether the optional rule should be checked. 772da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 782da489cd246702bee5938545b18a6f710ed214bcJamie Gennis Computes different flags (strict, jslint_error, jslint_noerror) to find out if 792da489cd246702bee5938545b18a6f710ed214bcJamie Gennis this specific rule should be checked. 802da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 812da489cd246702bee5938545b18a6f710ed214bcJamie Gennis Args: 822da489cd246702bee5938545b18a6f710ed214bcJamie Gennis rule: Name of the rule (see Rule). 832da489cd246702bee5938545b18a6f710ed214bcJamie Gennis 842da489cd246702bee5938545b18a6f710ed214bcJamie Gennis Returns: 852da489cd246702bee5938545b18a6f710ed214bcJamie Gennis True if the rule should be checked according to the flags, otherwise False. 862da489cd246702bee5938545b18a6f710ed214bcJamie Gennis """ 872da489cd246702bee5938545b18a6f710ed214bcJamie Gennis if rule in FLAGS.jslint_error or Rule.ALL in FLAGS.jslint_error: 882da489cd246702bee5938545b18a6f710ed214bcJamie Gennis return True 892da489cd246702bee5938545b18a6f710ed214bcJamie Gennis # Checks strict rules. 902da489cd246702bee5938545b18a6f710ed214bcJamie Gennis return FLAGS.strict and rule in Rule.CLOSURE_RULES 91