Add linter for strings.xml.
Strings are tedious to get right, so write a lint script that catches
common errors to warn developers before they're uploaded.
Test: builds, boots
Bug: 76097999
Change-Id: I9826ca796c17cd93a100951d56214653de63a379
diff --git a/tools/stringslint/stringslint.py b/tools/stringslint/stringslint.py
new file mode 100644
index 0000000..d637ff3
--- /dev/null
+++ b/tools/stringslint/stringslint.py
@@ -0,0 +1,162 @@
+#!/usr/bin/env python
+
+# Copyright (C) 2018 The Android Open Source Project
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Enforces common Android string best-practices. It ignores lint messages from
+a previous strings file, if provided.
+
+Usage: stringslint.py strings.xml
+Usage: stringslint.py strings.xml old_strings.xml
+"""
+
+import re, sys
+import lxml.etree as ET
+
+BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8)
+
+def format(fg=None, bg=None, bright=False, bold=False, dim=False, reset=False):
+ # manually derived from http://en.wikipedia.org/wiki/ANSI_escape_code#Codes
+ codes = []
+ if reset: codes.append("0")
+ else:
+ if not fg is None: codes.append("3%d" % (fg))
+ if not bg is None:
+ if not bright: codes.append("4%d" % (bg))
+ else: codes.append("10%d" % (bg))
+ if bold: codes.append("1")
+ elif dim: codes.append("2")
+ else: codes.append("22")
+ return "\033[%sm" % (";".join(codes))
+
+warnings = None
+
+def warn(tag, msg, actual, expected):
+ global warnings
+ key = "%s:%d" % (tag.attrib["name"], hash(msg))
+ value = "%sLine %d: '%s':%s %s" % (format(fg=YELLOW, bold=True),
+ tag.sourceline,
+ tag.attrib["name"],
+ format(reset=True),
+ msg)
+ if not actual is None: value += "\n\tActual: %s%s%s" % (format(dim=True),
+ actual,
+ format(reset=True))
+ if not expected is None: value += "\n\tExample: %s%s%s" % (format(dim=True),
+ expected,
+ format(reset=True))
+ warnings[key] = value
+
+def lint(path):
+ global warnings
+ warnings = {}
+
+ with open(path) as f:
+ raw = f.read()
+ if len(raw.strip()) == 0:
+ return warnings
+ tree = ET.fromstring(raw)
+ root = tree #tree.getroot()
+
+ last_comment = None
+ for child in root:
+ # TODO: handle plurals
+ if isinstance(child, ET._Comment):
+ last_comment = child
+ elif child.tag == "string":
+ # We always consume comment
+ comment = last_comment
+ last_comment = None
+
+ # Validate comment
+ if comment is None:
+ warn(child, "Missing string comment to aid translation",
+ None, None)
+ continue
+ if "do not translate" in comment.text.lower():
+ continue
+ if "translatable" in child.attrib and child.attrib["translatable"].lower() == "false":
+ continue
+ if re.search("CHAR[ _-]LIMIT=(\d+|NONE|none)", comment.text) is None:
+ warn(child, "Missing CHAR LIMIT to aid translation",
+ repr(comment), "<!-- Description of string [CHAR LIMIT=32] -->")
+
+ # Look for common mistakes/substitutions
+ text = "".join(child.itertext()).strip()
+ if "'" in text:
+ warn(child, "Turned quotation mark glyphs are more polished",
+ text, "This doesn\u2019t need to \u2018happen\u2019 today")
+ if '"' in text and not text.startswith('"') and text.endswith('"'):
+ warn(child, "Turned quotation mark glyphs are more polished",
+ text, "This needs to \u201chappen\u201d today")
+ if "..." in text:
+ warn(child, "Ellipsis glyph is more polished",
+ text, "Loading\u2026")
+ if "wi-fi" in text.lower():
+ warn(child, "Non-breaking glyph is more polished",
+ text, "Wi\u2011Fi")
+ if "wifi" in text.lower():
+ warn(child, "Using non-standard spelling",
+ text, "Wi\u2011Fi")
+ if re.search("\d-\d", text):
+ warn(child, "Ranges should use en dash glyph",
+ text, "You will find this material in chapters 8\u201312")
+ if "--" in text:
+ warn(child, "Phrases should use em dash glyph",
+ text, "Upon discovering errors\u2014all 124 of them\u2014they recalled.")
+ if ". " in text:
+ warn(child, "Only use single space between sentences",
+ text, "First idea. Second idea.")
+
+ # When more than one substitution, require indexes
+ if len(re.findall("%[^%]", text)) > 1:
+ if len(re.findall("%[^\d]", text)) > 0:
+ warn(child, "Substitutions must be indexed",
+ text, "Add %1$s to %2$s")
+
+ # Require xliff substitutions
+ for gc in child.iter():
+ badsub = False
+ if gc.tail and re.search("%[^%]", gc.tail): badsub = True
+ if re.match("{.*xliff.*}g", gc.tag):
+ if "id" not in gc.attrib:
+ warn(child, "Substitutions must define id attribute",
+ None, "<xliff:g id=\"domain\" example=\"example.com\">%1$s</xliff:g>")
+ if "example" not in gc.attrib:
+ warn(child, "Substitutions must define example attribute",
+ None, "<xliff:g id=\"domain\" example=\"example.com\">%1$s</xliff:g>")
+ else:
+ if gc.text and re.search("%[^%]", gc.text): badsub = True
+ if badsub:
+ warn(child, "Substitutions must be inside xliff tags",
+ text, "<xliff:g id=\"domain\" example=\"example.com\">%1$s</xliff:g>")
+
+ return warnings
+
+if len(sys.argv) > 2:
+ before = lint(sys.argv[2])
+else:
+ before = {}
+after = lint(sys.argv[1])
+
+for b in before:
+ if b in after:
+ del after[b]
+
+if len(after) > 0:
+ for a in sorted(after.keys()):
+ print after[a]
+ print
+ sys.exit(1)
diff --git a/tools/stringslint/stringslint_sha.sh b/tools/stringslint/stringslint_sha.sh
new file mode 100755
index 0000000..c79ba04
--- /dev/null
+++ b/tools/stringslint/stringslint_sha.sh
@@ -0,0 +1,4 @@
+#!/bin/bash
+git show --name-only --pretty=format: $1 | grep values/strings.xml | while read file; do
+ python $ANDROID_BUILD_TOP/frameworks/base/tools/stringslint/stringslint.py <(git show $1:$file) <(git show $1^:$file)
+done