servo-tidy.toml

[configs]
skip-check-length = false
skip-check-licenses = false
check-alphabetical-order = true
check-ordered-json-keys = ["./resources/prefs.json"]

# Packages which we avoid using in Servo.
# For each blocked package, we can list the exceptions,
# which are packages allowed to use the blocked package.
[blocked-packages]
num = []
rand = [
    "ipc-channel",
    "phf_generator",
    "quickcheck", # Only used in tests
    "servo_rand",
    "tungstenite",
    "tracing-perfetto",
]

[ignore]
# Ignored packages with duplicated versions
packages = [
    "bitflags",
    "cfg_aliases",
    "cookie",
    "futures",
    "hermit-abi",
    "redox_syscall",
    "time",
    "wasi",
    "wayland-sys",

    # New versions of these dependencies is pulled in by GStreamer / GLib.
    "itertools",
    "toml",

    # Duplicated by winit.
    "windows-sys",
    "windows-targets",
    "windows_aarch64_gnullvm",
    "windows_aarch64_msvc",
    "windows_i686_gnu",
    "windows_i686_msvc",
    "windows_x86_64_gnu",
    "windows_x86_64_gnullvm",
    "windows_x86_64_msvc",

    # wgpu has the latest and greatest.
    "foreign-types",
    "foreign-types-shared",
    "metal",
    "windows-core",

    # wgpu-hal depends on 0.5.0.
    "ndk-sys",

    # quickcheck (required by layout_2020 for tests) is
    # stuck on 0.8.4 with no new releases.
    "env_logger",

    # Required until a new version of string-cache is released.
    "phf_generator",
    "phf_shared",

    # petgraph uses old version
    "fixedbitset",

    # servo-media-audio uses old version
    "petgraph",

    # icu (from mozjs) uses old version
    # tracing-subscriber (tokio-rs/tracing#3033) uses old version
    # regex -> regex-automata 0.4.7
    # icu_list -> regex-automata 0.2.0
    # tracing-subscriber -> matchers -> regex-automata 0.1.0
    "regex-automata",

    # tracing-subscriber (tokio-rs/tracing#3033) uses old version
    # regex [-> regex-automata 0.4.7] -> regex-syntax 0.8.4
    # tracing-subscriber -> matchers -> regex-automata 0.1.0 -> regex-syntax 0.6.29
    "regex-syntax",

    # gilrs is on 0.10.0, but Servo is still on 0.9.4
    "core-foundation",

    # some non-servo crates still use 0.14
    "glow",
]
# Files that are ignored for all tidy and lint checks.
files = [
    "./components/net/tests/parsable_mime/text",
    "./resources/hsts_preload.json",
    "./tests/wpt/meta/MANIFEST.json",
    "./tests/wpt/meta-legacy-layout/MANIFEST.json",
    "./tests/wpt/mozilla/meta/MANIFEST.json",
    "./tests/wpt/mozilla/meta-legacy-layout/MANIFEST.json",
    # Long encoded string
    "./tests/wpt/mozilla/tests/mozilla/resources/brotli.py",
    "./tests/wpt/webgl/meta/MANIFEST.json",
    # Upstream code from Khronos/WebGL uses tabs for indentation
    "./tests/wpt/webgl/tests",
    # Vendored from upstream
    "./tests/wpt/webgpu/tests",
    # Our import script is not currently respecting the lint.
    "./tests/wpt/webgl/tools/import-conformance-tests.py",
    # Ignore those files since the issues reported are on purpose
    "./tests/html/bad-line-ends.html",
    "./tests/wpt/mozilla/tests/css/fonts",
    "./tests/wpt/mozilla/tests/css/pre_with_tab.html",
    "./tests/wpt/mozilla/tests/mozilla/textarea_placeholder.html",
    # The tidy tests currently don't pass tidy.
    "./python/tidy/test.py",
]
# Directories that are ignored for the non-WPT tidy check.
directories = [
    # Test have expectations in them, causing tidy to fail.
    "./support/crown/tests",
    # Upstream
    "./support/android/apk",
    "./tests/wpt/harness",
    "./tests/wpt/tests",
    "./tests/wpt/mozilla/tests/mozilla/referrer-policy",
    "./tests/wpt/mozilla/tests/webgl",
    "./python/tidy/tests",
    "./python/_v*",
    "./python/mach",
    # Generated and upstream code combined with our own. Could use cleanup
    "./target",
    "./support/crown/target",
    "./third_party",
]

# Directories that are checked for correct file extension
[check_ext]
# directory, list of expected file extensions
"./components/script/dom/webidls" = [".webidl", "noidl"]