ui/webui/resources/PRESUBMIT.py

# Copyright 2016 The Chromium Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

PRESUBMIT_VERSION = '2.0.0'

def CheckForTranslations(input_api, output_api):
  shared_keywords = ['i18n(']
  html_keywords = shared_keywords + ['$118n{']
  js_keywords = shared_keywords + ['I18nBehavior', 'loadTimeData.get']

  errors = []

  for f in input_api.AffectedFiles():
    local_path = f.LocalPath()
    # Allow translation in i18n_behavior.js.
    if local_path.endswith('i18n_behavior.js'):
      continue
    # Allow translation in the cr_components directory.
    if 'cr_components' in local_path:
      continue
    keywords = None
    if local_path.endswith('.js'):
      keywords = js_keywords
    elif local_path.endswith('.html'):
      keywords = html_keywords

    if not keywords:
      continue

    for lnum, line in f.ChangedContents():
      if any(line for keyword in keywords if keyword in line):
        errors.append("%s:%d\n%s" % (f.LocalPath(), lnum, line))

  if not errors:
    return []

  return [output_api.PresubmitError("\n".join(errors) + """

Don't embed translations directly in shared UI code. Instead, inject your
translation from the place using the shared code. For an example: see
<cr-dialog>#closeText (http://bit.ly/2eLEsqh).""")]


def CheckSvgsOptimized(input_api, output_api):
  results = []
  try:
    import sys
    old_sys_path = sys.path[:]
    cwd = input_api.PresubmitLocalPath()
    sys.path += [input_api.os_path.join(cwd, '..', '..', '..', 'tools')]
    from resources import svgo_presubmit
    results += svgo_presubmit.CheckOptimized(input_api, output_api)
  finally:
    sys.path = old_sys_path
  return results


def CheckWebDevStyle(input_api, output_api):
  results = []
  try:
    import sys
    old_sys_path = sys.path[:]
    cwd = input_api.PresubmitLocalPath()
    sys.path += [input_api.os_path.join(cwd, '..', '..', '..', 'tools')]
    from web_dev_style import presubmit_support
    results += presubmit_support.CheckStyle(input_api, output_api)
  finally:
    sys.path = old_sys_path
  return results

def CheckNoDisallowedJS(input_api, output_api):
  # Ignore legacy files from the js/ subfolder along with tools/.
  EXCLUDE_PATH_PREFIXES = [
    'ui/webui/resources/js/dom_automation_controller.js',
    'ui/webui/resources/js/ios/',
    'ui/webui/resources/js/load_time_data_deprecated.js',
    'ui/webui/resources/js/util_deprecated.js',
    'ui/webui/resources/tools/',
  ]

  normalized_excluded_prefixes = []
  for path in EXCLUDE_PATH_PREFIXES:
    normalized_excluded_prefixes.append(input_api.os_path.normpath(path))

  # Also exempt any externs or eslint files, which must be in JS.
  EXCLUDE_PATH_SUFFIXES = [
    '_externs.js',
  ]

  def allow_js(f):
    path = f.LocalPath()
    for prefix in normalized_excluded_prefixes:
      if path.startswith(prefix):
        return True
    for suffix in EXCLUDE_PATH_SUFFIXES:
      if path.endswith(suffix):
        return True
    return False

  from web_dev_style import presubmit_support
  return presubmit_support.DisallowNewJsFiles(input_api, output_api,
                                              lambda f: not allow_js(f))


def CheckNoNewPolymer(input_api, output_api):
  IGNORE_FILES = [
    # These files are needed for testing Polymer specific ESLint rules in
    # ui/webui/resources/tools/webui_eslint_plugin.js.
    'ui/webui/resources/tools/tests/eslint_ts/with_webui_plugin_polymer_property_class_member_violations.ts',
    'ui/webui/resources/tools/tests/eslint_ts/with_webui_plugin_polymer_violations.ts',
  ]

  def ignore_filter(affected_file):
    return affected_file.LocalPath().replace("\\", "/") not in IGNORE_FILES

  from web_dev_style import presubmit_support
  return presubmit_support.DisallowNewPolymerElements(
      input_api, output_api, file_filter=ignore_filter)


def CheckPatchFormatted(input_api, output_api):
  return input_api.canned_checks.CheckPatchFormatted(input_api, output_api,
                                                     check_js=True)