mirror of
https://github.com/servo/servo.git
synced 2025-06-06 16:45:39 +00:00
Tidy config file
This commit is contained in:
UK992
parent
ec53136863
commit
0ad905ae42
2 changed files with 104 additions and 55 deletions
|
|
@ -19,6 +19,25 @@ import subprocess
|
|||
import sys
|
||||
from licenseck import MPL, APACHE, COPYRIGHT, licenses_toml, licenses_dep_toml
|
||||
import colorama
|
||||
import toml
|
||||
|
||||
CONFIG_FILE_PATH = os.path.join(".", "servo-tidy.toml")
|
||||
|
||||
# Default configs
|
||||
config = {
|
||||
"skip-check-length": False,
|
||||
"skip-check-licenses": False,
|
||||
"ignore": {
|
||||
"files": [
|
||||
CONFIG_FILE_PATH, # ignore config file
|
||||
"./.", # ignore hidden files
|
||||
],
|
||||
"directories": [
|
||||
"./.", # ignore hidden directories
|
||||
],
|
||||
"packages": [],
|
||||
}
|
||||
}
|
||||
|
||||
COMMENTS = ["// ", "# ", " *", "/* "]
|
||||
|
||||
|
|
@ -30,53 +49,6 @@ FILE_PATTERNS_TO_CHECK = ["*.rs", "*.rc", "*.cpp", "*.c",
|
|||
# File patterns that are ignored for all tidy and lint checks.
|
||||
FILE_PATTERNS_TO_IGNORE = ["*.#*", "*.pyc"]
|
||||
|
||||
# Files that are ignored for all tidy and lint checks.
|
||||
IGNORED_FILES = [
|
||||
# Generated and upstream code combined with our own. Could use cleanup
|
||||
os.path.join(".", "ports", "geckolib", "gecko_bindings", "bindings.rs"),
|
||||
os.path.join(".", "ports", "geckolib", "gecko_bindings", "structs_debug.rs"),
|
||||
os.path.join(".", "ports", "geckolib", "gecko_bindings", "structs_release.rs"),
|
||||
os.path.join(".", "ports", "geckolib", "string_cache", "atom_macro.rs"),
|
||||
os.path.join(".", "resources", "hsts_preload.json"),
|
||||
os.path.join(".", "tests", "wpt", "metadata", "MANIFEST.json"),
|
||||
os.path.join(".", "tests", "wpt", "metadata-css", "MANIFEST.json"),
|
||||
os.path.join(".", "components", "script", "dom", "webidls", "ForceTouchEvent.webidl"),
|
||||
os.path.join(".", "support", "android", "openssl.sh"),
|
||||
# Ignore those files since the issues reported are on purpose
|
||||
os.path.join(".", "tests", "html", "bad-line-ends.html"),
|
||||
os.path.join(".", "tests", "unit", "net", "parsable_mime", "text"),
|
||||
os.path.join(".", "tests", "wpt", "mozilla", "tests", "css", "fonts"),
|
||||
os.path.join(".", "tests", "wpt", "mozilla", "tests", "css", "pre_with_tab.html"),
|
||||
# FIXME(pcwalton, #11679): This is a workaround for a tidy error on the quoted string
|
||||
# `"__TEXT,_info_plist"` inside an attribute.
|
||||
os.path.join(".", "components", "servo", "platform", "macos", "mod.rs"),
|
||||
# Hidden files
|
||||
os.path.join(".", "."),
|
||||
]
|
||||
|
||||
# Directories that are ignored for the non-WPT tidy check.
|
||||
IGNORED_DIRS = [
|
||||
# Upstream
|
||||
os.path.join(".", "support", "android", "apk"),
|
||||
os.path.join(".", "tests", "wpt", "css-tests"),
|
||||
os.path.join(".", "tests", "wpt", "harness"),
|
||||
os.path.join(".", "tests", "wpt", "update"),
|
||||
os.path.join(".", "tests", "wpt", "web-platform-tests"),
|
||||
os.path.join(".", "tests", "wpt", "mozilla", "tests", "mozilla", "referrer-policy"),
|
||||
os.path.join(".", "tests", "wpt", "sync"),
|
||||
os.path.join(".", "tests", "wpt", "sync_css"),
|
||||
os.path.join(".", "python", "mach"),
|
||||
os.path.join(".", "python", "tidy", "servo_tidy_tests"),
|
||||
os.path.join(".", "components", "script", "dom", "bindings", "codegen", "parser"),
|
||||
os.path.join(".", "components", "script", "dom", "bindings", "codegen", "ply"),
|
||||
os.path.join(".", "python", "_virtualenv"),
|
||||
# Generated and upstream code combined with our own. Could use cleanup
|
||||
os.path.join(".", "target"),
|
||||
os.path.join(".", "ports", "cef"),
|
||||
# Hidden directories
|
||||
os.path.join(".", "."),
|
||||
]
|
||||
|
||||
SPEC_BASE_PATH = "components/script/dom/"
|
||||
|
||||
WEBIDL_STANDARDS = [
|
||||
|
|
@ -125,7 +97,7 @@ def progress_wrapper(iterator):
|
|||
|
||||
|
||||
def filter_file(file_name):
|
||||
if any(file_name.startswith(ignored_file) for ignored_file in IGNORED_FILES):
|
||||
if any(file_name.startswith(ignored_file) for ignored_file in config["ignore"]["files"]):
|
||||
return False
|
||||
base_name = os.path.basename(file_name)
|
||||
if any(fnmatch.fnmatch(base_name, pattern) for pattern in FILE_PATTERNS_TO_IGNORE):
|
||||
|
|
@ -134,7 +106,7 @@ def filter_file(file_name):
|
|||
|
||||
|
||||
def filter_files(start_dir, only_changed_files, progress):
|
||||
file_iter = get_file_list(start_dir, only_changed_files, IGNORED_DIRS)
|
||||
file_iter = get_file_list(start_dir, only_changed_files, config["ignore"]["directories"])
|
||||
(has_element, file_iter) = is_iter_empty(file_iter)
|
||||
if not has_element:
|
||||
raise StopIteration
|
||||
|
|
@ -167,7 +139,8 @@ def licensed_apache(header):
|
|||
|
||||
|
||||
def check_license(file_name, lines):
|
||||
if any(file_name.endswith(ext) for ext in (".toml", ".lock", ".json", ".html")):
|
||||
if any(file_name.endswith(ext) for ext in (".toml", ".lock", ".json", ".html")) or \
|
||||
config["skip-check-licenses"]:
|
||||
raise StopIteration
|
||||
|
||||
if lines[0].startswith("#!") and lines[1].strip():
|
||||
|
|
@ -202,9 +175,10 @@ def check_modeline(file_name, lines):
|
|||
|
||||
|
||||
def check_length(file_name, idx, line):
|
||||
for suffix in [".lock", ".json", ".html", ".toml"]:
|
||||
if file_name.endswith(suffix):
|
||||
raise StopIteration
|
||||
if any(file_name.endswith(ext) for ext in (".lock", ".json", ".html", ".toml")) or \
|
||||
config["skip-check-length"]:
|
||||
raise StopIteration
|
||||
|
||||
# Prefer shorter lines when shell scripting.
|
||||
if file_name.endswith(".sh"):
|
||||
max_length = 80
|
||||
|
|
@ -296,14 +270,13 @@ def check_lock(file_name, contents):
|
|||
raise StopIteration
|
||||
|
||||
# package names to be neglected (as named by cargo)
|
||||
exceptions = ["lazy_static"]
|
||||
exceptions = config["ignore"]["packages"]
|
||||
|
||||
# toml.py has a bug(?) that we trip up in [metadata] sections;
|
||||
# see https://github.com/uiri/toml/issues/61
|
||||
# This should only affect a very few lines (that have embedded ?branch=...),
|
||||
# and most of them won't be in the repo
|
||||
try:
|
||||
import toml
|
||||
content = toml.loads(contents)
|
||||
except:
|
||||
print "WARNING!"
|
||||
|
|
@ -694,6 +667,33 @@ def check_spec(file_name, lines):
|
|||
brace_count -= 1
|
||||
|
||||
|
||||
def parse_config(content):
|
||||
config_file = toml.loads(content)
|
||||
exclude = config_file.get("ignore", {})
|
||||
# Add list of ignored directories to config
|
||||
config["ignore"]["directories"] += exclude.get("directories", [])
|
||||
# Add list of ignored files to config
|
||||
config["ignore"]["files"] += exclude.get("files", [])
|
||||
# Add list of ignored packages to config
|
||||
config["ignore"]["packages"] = exclude.get("packages", [])
|
||||
# Fix the necessary paths if we're in Windows
|
||||
if sys.platform == "win32":
|
||||
files = []
|
||||
for f in config["ignore"]["files"]:
|
||||
files += [os.path.join(*f.split("/"))]
|
||||
config["ignore"]["files"] = files
|
||||
dirs = []
|
||||
for f in config["ignore"]["directories"]:
|
||||
dirs += [os.path.join(*f.split("/"))]
|
||||
config["ignore"]["directories"] = dirs
|
||||
|
||||
# Override default configs
|
||||
configs = config_file.get("configs", [])
|
||||
for pref in configs:
|
||||
if pref in config:
|
||||
config[pref] = configs[pref]
|
||||
|
||||
|
||||
def collect_errors_for_files(files_to_check, checking_functions, line_checking_functions, print_text=True):
|
||||
(has_element, files_to_check) = is_iter_empty(files_to_check)
|
||||
if not has_element:
|
||||
|
|
@ -773,6 +773,7 @@ def get_file_list(directory, only_changed_files=False, exclude_dirs=[]):
|
|||
args = ["git", "ls-files", "--others", "--exclude-standard", directory]
|
||||
file_list += subprocess.check_output(args)
|
||||
for f in file_list.splitlines():
|
||||
f = os.path.join(*f.split("/")) if sys.platform == "win32" else f
|
||||
if not any(os.path.join('.', os.path.dirname(f)).startswith(path) for path in exclude_dirs):
|
||||
yield os.path.join('.', f)
|
||||
elif exclude_dirs:
|
||||
|
|
|
|||
48
servo-tidy.toml
Normal file
48
servo-tidy.toml
Normal file
|
|
@ -0,0 +1,48 @@
|
|||
[configs]
|
||||
skip-check-length = false
|
||||
skip-check-licenses = false
|
||||
|
||||
[ignore]
|
||||
# Ignored packages with duplicated versions
|
||||
packages = ["lazy_static"]
|
||||
# Files that are ignored for all tidy and lint checks.
|
||||
files = [
|
||||
# Generated and upstream code combined with our own. Could use cleanup
|
||||
"./ports/geckolib/gecko_bindings/bindings.rs",
|
||||
"./ports/geckolib/gecko_bindings/structs_debug.rs",
|
||||
"./ports/geckolib/gecko_bindings/structs_release.rs",
|
||||
"./ports/geckolib/string_cache/atom_macro.rs",
|
||||
"./resources/hsts_preload.json",
|
||||
"./tests/wpt/metadata/MANIFEST.json",
|
||||
"./tests/wpt/metadata-css/MANIFEST.json",
|
||||
"./components/script/dom/webidls/ForceTouchEvent.webidl",
|
||||
"./support/android/openssl.sh",
|
||||
# Ignore those files since the issues reported are on purpose
|
||||
"./tests/html/bad-line-ends.html",
|
||||
"./tests/unit/net/parsable_mime/text",
|
||||
"./tests/wpt/mozilla/tests/css/fonts",
|
||||
"./tests/wpt/mozilla/tests/css/pre_with_tab.html",
|
||||
# FIXME(pcwalton, #11679): This is a workaround for a tidy error on the quoted string
|
||||
# `"__TEXT,_info_plist"` inside an attribute.
|
||||
"./components/servo/platform/macos/mod.rs",
|
||||
]
|
||||
# Directories that are ignored for the non-WPT tidy check.
|
||||
directories = [
|
||||
# Upstream
|
||||
"./support/android/apk",
|
||||
"./tests/wpt/css-tests",
|
||||
"./tests/wpt/harness",
|
||||
"./tests/wpt/update",
|
||||
"./tests/wpt/web-platform-tests",
|
||||
"./tests/wpt/mozilla/tests/mozilla/referrer-policy",
|
||||
"./tests/wpt/sync",
|
||||
"./tests/wpt/sync_css",
|
||||
"./python/mach",
|
||||
"./python/tidy/servo_tidy_tests",
|
||||
"./components/script/dom/bindings/codegen/parser",
|
||||
"./components/script/dom/bindings/codegen/ply",
|
||||
"./python/_virtualenv",
|
||||
# Generated and upstream code combined with our own. Could use cleanup
|
||||
"./target",
|
||||
"./ports/cef",
|
||||
]
|
||||
Loading…
Add table
Add a link
Reference in a new issue