From 47c747ddfa627ef80df26345a32216fb3dcd8e82 Mon Sep 17 00:00:00 2001 From: oiwn Date: Sun, 5 Oct 2025 13:38:51 +0700 Subject: [PATCH 1/4] add ci/coverage workflows --- .github/workflows/ci.yml | 124 +++++++++++++++++++++++++++++++++ .github/workflows/coverage.yml | 45 ++++++++++++ 2 files changed, 169 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/coverage.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 000000000..c15341818 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,124 @@ +name: "CI Pipeline" + +on: + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + push: + branches: + - main + pull_request: + branches: + - main + +# ensure that the workflow is only triggered once per PR, subsequent pushes to the PR will cancel +# and restart the workflow. See https://docs.github.com/en/actions/using-jobs/using-concurrency +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +# Make obvious and fast tests to run first, to catch issues as early as possible +jobs: + # Lint the formatting of the codebase. + formatting: + name: Check Formatting + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@nightly + with: { components: rustfmt } + - run: cargo fmt + + # Check for typos in the codebase. + # See + lint-typos: + name: Check Typos + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: crate-ci/typos@master + + # Check for any disallowed dependencies in the codebase due to license / security issues. + # See + dependencies: + name: Check Dependencies + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: EmbarkStudios/cargo-deny-action@v2 + + # Run cargo clippy. + lint-clippy: + name: Check Clippy + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: { components: clippy } + - uses: Swatinem/rust-cache@v2 + - run: cargo clippy + + # Run markdownlint on all markdown files in the repository. + lint-markdown: + name: Check Markdown + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: DavidAnson/markdownlint-cli2-action@v17 + with: + globs: | + '**/*.md' + '!target' + + # Run cargo check. This is a fast way to catch any obvious errors in the code. + check: + name: Check ${{ matrix.os }} ${{ matrix.toolchain }} + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, windows-latest, macos-latest] + toolchain: ["stable"] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@master + with: + toolchain: ${{ matrix.toolchain }} + - uses: Swatinem/rust-cache@v2 + - run: cargo check + + test: + name: "Cargo test" + runs-on: "ubuntu-latest" + steps: + - name: "Check out the repo" + uses: actions/checkout@v3 + + - uses: "actions-rs/toolchain@v1" + with: + profile: "minimal" + toolchain: "stable" + override: true + + - uses: "actions-rs/cargo@v1" + with: + command: "test" + + clippy: + name: "Cargo clippy" + runs-on: "ubuntu-latest" + steps: + - name: "Check out the repo" + uses: actions/checkout@v3 + + - uses: "actions-rs/toolchain@v1" + with: + profile: "minimal" + toolchain: "stable" + override: true + + - run: "rustup component add clippy" + + - uses: "actions-rs/cargo@v1" + with: + command: "clippy" + args: "-- -D warnings" diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml new file mode 100644 index 000000000..b0d211c53 --- /dev/null +++ b/.github/workflows/coverage.yml @@ -0,0 +1,45 @@ +name: Coverage + +on: + workflow_dispatch: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +env: + CARGO_TERM_COLOR: always + +jobs: + coverage: + name: Code coverage + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + - uses: dtolnay/rust-toolchain@stable + with: + components: llvm-tools-preview + - uses: actions/cache@v3 + with: + path: | + ~/.cargo/bin/ + ~/.cargo/registry/index/ + ~/.cargo/registry/cache/ + ~/.cargo/git/db/ + target/ + key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }} + + - name: Install cargo-llvm-cov + uses: taiki-e/install-action@cargo-llvm-cov + + - name: Generate code coverage + run: cargo llvm-cov --workspace --lcov --output-path lcov.info + + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v3 + with: + token: ${{ secrets.CODECOV_TOKEN }} + files: lcov.info + fail_ci_if_error: true + verbose: true From 55684a4d3bfe457be38aa118218f0b89b0e7977a Mon Sep 17 00:00:00 2001 From: oiwn Date: Sun, 5 Oct 2025 14:31:49 +0700 Subject: [PATCH 2/4] add files for deny and typos --- deny.toml | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ typos.toml | 14 ++++++++++++++ 2 files changed, 63 insertions(+) create mode 100644 deny.toml create mode 100644 typos.toml diff --git a/deny.toml b/deny.toml new file mode 100644 index 000000000..801ae3750 --- /dev/null +++ b/deny.toml @@ -0,0 +1,49 @@ +# cargo-deny configuration +# This policy is permissive: it allows common OSS licenses +# and treats copyleft/unlicensed as allowed, so CI won’t fail +# on typical Rust ecosystem crates. + +[licenses] +allow = [ + "Apache-2.0", + "MIT", + "MIT-0", + "BSD-3-Clause", + "BSD-2-Clause", + "ISC", + "Zlib", + "MPL-2.0", + "BSL-1.0", + "CC0-1.0", + "Unicode-DFS-2016", + "OpenSSL", +] + +# Also allow all OSI and FSF Free licenses. +# This covers most permissive/weak-copyleft cases in the ecosystem. +allow-osi-fsf-free = "both" + +# Be permissive on copyleft and unlicensed to avoid CI failures. +copyleft = "allow" +unlicensed = "allow" + +# Lower a bit to avoid false negatives on license detection heuristics. +confidence-threshold = 0.8 + +[advisories] +# Still fail on known vulnerabilities; warn on less critical classes. +vulnerability = "deny" +unmaintained = "warn" +yanked = "warn" +notice = "warn" + +[bans] +multiple-versions = "warn" +wildcards = "warn" +deny = [] + +[sources] +unknown-registry = "warn" +unknown-git = "warn" +allow-registry = ["https://github.com/rust-lang/crates.io-index"] + diff --git a/typos.toml b/typos.toml new file mode 100644 index 000000000..4b93fcb62 --- /dev/null +++ b/typos.toml @@ -0,0 +1,14 @@ +[default] +extend-ignore-words = [ + "ratatui", + "Ratatui", + "RATATUI", +] + +# Ignore all code identifiers so Rust (and other languages) are checked +# only in comments/strings, not in identifiers like variable or function names. +# This keeps docs and comments spellchecked while avoiding false positives +# on short or domain-specific names (e.g., `ot`, `ratatui_color_from_ansi`). +extend-ignore-identifiers-re = [ + "^[A-Za-z_][A-Za-z0-9_]*$", +] From fe5b29cec7c6b429832b445ef351a9ac46c77abb Mon Sep 17 00:00:00 2001 From: oiwn Date: Sun, 5 Oct 2025 14:50:39 +0700 Subject: [PATCH 3/4] proper deny config --- deny.toml | 256 ++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 221 insertions(+), 35 deletions(-) diff --git a/deny.toml b/deny.toml index 801ae3750..bd776cf32 100644 --- a/deny.toml +++ b/deny.toml @@ -1,49 +1,235 @@ -# cargo-deny configuration -# This policy is permissive: it allows common OSS licenses -# and treats copyleft/unlicensed as allowed, so CI won’t fail -# on typical Rust ecosystem crates. +# This template contains all of the possible sections and their default values +# Note that all fields that take a lint level have these possible values: +# * deny - An error will be produced and the check will fail +# * warn - A warning will be produced, but the check will not fail +# * allow - No warning or error will be produced, though in some cases a note +# will be + +# The values provided in this template are the default values that will be used +# when any section or field is not specified in your own configuration + +# Root options + +# The graph table configures how the dependency graph is constructed and thus +# which crates the checks are performed against +[graph] +# If 1 or more target triples (and optionally, target_features) are specified, +# only the specified targets will be checked when running `cargo deny check`. +# This means, if a particular package is only ever used as a target specific +# dependency, such as, for example, the `nix` crate only being used via the +# `target_family = "unix"` configuration, that only having windows targets in +# this list would mean the nix crate, as well as any of its exclusive +# dependencies not shared by any other crates, would be ignored, as the target +# list here is effectively saying which targets you are building for. +targets = [ + # The triple can be any string, but only the target triples built in to + # rustc (as of 1.40) can be checked against actual config expressions + #"x86_64-unknown-linux-musl", + # You can also specify which target_features you promise are enabled for a + # particular target. target_features are currently not validated against + # the actual valid features supported by the target architecture. + #{ triple = "wasm32-unknown-unknown", features = ["atomics"] }, +] +# When creating the dependency graph used as the source of truth when checks are +# executed, this field can be used to prune crates from the graph, removing them +# from the view of cargo-deny. This is an extremely heavy hammer, as if a crate +# is pruned from the graph, all of its dependencies will also be pruned unless +# they are connected to another crate in the graph that hasn't been pruned, +# so it should be used with care. The identifiers are [Package ID Specifications] +# (https://doc.rust-lang.org/cargo/reference/pkgid-spec.html) +#exclude = [] +# If true, metadata will be collected with `--all-features`. Note that this can't +# be toggled off if true, if you want to conditionally enable `--all-features` it +# is recommended to pass `--all-features` on the cmd line instead +all-features = false +# If true, metadata will be collected with `--no-default-features`. The same +# caveat with `all-features` applies +no-default-features = false +# If set, these feature will be enabled when collecting metadata. If `--features` +# is specified on the cmd line they will take precedence over this option. +#features = [] + +# The output table provides options for how/if diagnostics are outputted +[output] +# When outputting inclusion graphs in diagnostics that include features, this +# option can be used to specify the depth at which feature edges will be added. +# This option is included since the graphs can be quite large and the addition +# of features from the crate(s) to all of the graph roots can be far too verbose. +# This option can be overridden via `--feature-depth` on the cmd line +feature-depth = 1 + +# This section is considered when running `cargo deny check advisories` +# More documentation for the advisories section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/advisories/cfg.html +[advisories] +# The path where the advisory databases are cloned/fetched into +#db-path = "$CARGO_HOME/advisory-dbs" +# The url(s) of the advisory databases to use +#db-urls = ["https://github.com/rustsec/advisory-db"] +# A list of advisory IDs to ignore. Note that ignored advisories will still +# output a note when they are encountered. +ignore = [ + #"RUSTSEC-0000-0000", + #{ id = "RUSTSEC-0000-0000", reason = "you can specify a reason the advisory is ignored" }, + #"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish + #{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" }, +] +# If this is true, then cargo deny will use the git executable to fetch advisory database. +# If this is false, then it uses a built-in git library. +# Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support. +# See Git Authentication for more information about setting up git authentication. +#git-fetch-with-cli = true + +# This section is considered when running `cargo deny check licenses` +# More documentation for the licenses section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/licenses/cfg.html [licenses] +# List of explicitly allowed licenses +# See https://spdx.org/licenses/ for list of possible licenses +# [possible values: any SPDX 3.11 short identifier (+ optional exception)]. allow = [ - "Apache-2.0", - "MIT", - "MIT-0", - "BSD-3-Clause", - "BSD-2-Clause", - "ISC", - "Zlib", - "MPL-2.0", - "BSL-1.0", - "CC0-1.0", - "Unicode-DFS-2016", - "OpenSSL", -] - -# Also allow all OSI and FSF Free licenses. -# This covers most permissive/weak-copyleft cases in the ecosystem. -allow-osi-fsf-free = "both" - -# Be permissive on copyleft and unlicensed to avoid CI failures. -copyleft = "allow" -unlicensed = "allow" - -# Lower a bit to avoid false negatives on license detection heuristics. + #"MIT", + #"Apache-2.0", + #"Apache-2.0 WITH LLVM-exception", +] +# The confidence threshold for detecting a license from license text. +# The higher the value, the more closely the license text must be to the +# canonical license text of a valid SPDX license file. +# [possible values: any between 0.0 and 1.0]. confidence-threshold = 0.8 +# Allow 1 or more licenses on a per-crate basis, so that particular licenses +# aren't accepted for every possible crate as with the normal allow list +exceptions = [ + # Each entry is the crate and version constraint, and its specific allow + # list + #{ allow = ["Zlib"], crate = "adler32" }, +] -[advisories] -# Still fail on known vulnerabilities; warn on less critical classes. -vulnerability = "deny" -unmaintained = "warn" -yanked = "warn" -notice = "warn" +# Some crates don't have (easily) machine readable licensing information, +# adding a clarification entry for it allows you to manually specify the +# licensing information +#[[licenses.clarify]] +# The package spec the clarification applies to +#crate = "ring" +# The SPDX expression for the license requirements of the crate +#expression = "MIT AND ISC AND OpenSSL" +# One or more files in the crate's source used as the "source of truth" for +# the license expression. If the contents match, the clarification will be used +# when running the license check, otherwise the clarification will be ignored +# and the crate will be checked normally, which may produce warnings or errors +# depending on the rest of your configuration +#license-files = [ +# Each entry is a crate relative path, and the (opaque) hash of its contents +#{ path = "LICENSE", hash = 0xbd0eed23 } +#] + +[licenses.private] +# If true, ignores workspace crates that aren't published, or are only +# published to private registries. +# To see how to mark a crate as unpublished (to the official registry), +# visit https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field. +ignore = false +# One or more private registries that you might publish crates to, if a crate +# is only published to private registries, and ignore is true, the crate will +# not have its license(s) checked +registries = [ + #"https://sekretz.com/registry +] +# This section is considered when running `cargo deny check bans`. +# More documentation about the 'bans' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/bans/cfg.html [bans] +# Lint level for when multiple versions of the same crate are detected multiple-versions = "warn" -wildcards = "warn" -deny = [] +# Lint level for when a crate version requirement is `*` +wildcards = "allow" +# The graph highlighting used when creating dotgraphs for crates +# with multiple versions +# * lowest-version - The path to the lowest versioned duplicate is highlighted +# * simplest-path - The path to the version with the fewest edges is highlighted +# * all - Both lowest-version and simplest-path are used +highlight = "all" +# The default lint level for `default` features for crates that are members of +# the workspace that is being checked. This can be overridden by allowing/denying +# `default` on a crate-by-crate basis if desired. +workspace-default-features = "allow" +# The default lint level for `default` features for external crates that are not +# members of the workspace. This can be overridden by allowing/denying `default` +# on a crate-by-crate basis if desired. +external-default-features = "allow" +# List of crates that are allowed. Use with care! +allow = [ + #"ansi_term@0.11.0", + #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is allowed" }, +] +# List of crates to deny +deny = [ + #"ansi_term@0.11.0", + #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason it is banned" }, + # Wrapper crates can optionally be specified to allow the crate when it + # is a direct dependency of the otherwise banned crate + #{ crate = "ansi_term@0.11.0", wrappers = ["this-crate-directly-depends-on-ansi_term"] }, +] + +# List of features to allow/deny +# Each entry the name of a crate and a version range. If version is +# not specified, all versions will be matched. +#[[bans.features]] +#crate = "reqwest" +# Features to not allow +#deny = ["json"] +# Features to allow +#allow = [ +# "rustls", +# "__rustls", +# "__tls", +# "hyper-rustls", +# "rustls", +# "rustls-pemfile", +# "rustls-tls-webpki-roots", +# "tokio-rustls", +# "webpki-roots", +#] +# If true, the allowed features must exactly match the enabled feature set. If +# this is set there is no point setting `deny` +#exact = true + +# Certain crates/versions that will be skipped when doing duplicate detection. +skip = [ + #"ansi_term@0.11.0", + #{ crate = "ansi_term@0.11.0", reason = "you can specify a reason why it can't be updated/removed" }, +] +# Similarly to `skip` allows you to skip certain crates during duplicate +# detection. Unlike skip, it also includes the entire tree of transitive +# dependencies starting at the specified crate, up to a certain depth, which is +# by default infinite. +skip-tree = [ + #"ansi_term@0.11.0", # will be skipped along with _all_ of its direct and transitive dependencies + #{ crate = "ansi_term@0.11.0", depth = 20 }, +] +# This section is considered when running `cargo deny check sources`. +# More documentation about the 'sources' section can be found here: +# https://embarkstudios.github.io/cargo-deny/checks/sources/cfg.html [sources] +# Lint level for what to happen when a crate from a crate registry that is not +# in the allow list is encountered unknown-registry = "warn" +# Lint level for what to happen when a crate from a git repository that is not +# in the allow list is encountered unknown-git = "warn" +# List of URLs for allowed crate registries. Defaults to the crates.io index +# if not specified. If it is specified but empty, no registries are allowed. allow-registry = ["https://github.com/rust-lang/crates.io-index"] +# List of URLs for allowed Git repositories +allow-git = [] +[sources.allow-org] +# github.com organizations to allow git sources for +github = [] +# gitlab.com organizations to allow git sources for +gitlab = [] +# bitbucket.org organizations to allow git sources for +bitbucket = [] From a882e2b8335c0a491db6533ca54d6708f357fa71 Mon Sep 17 00:00:00 2001 From: oiwn Date: Sun, 5 Oct 2025 15:06:18 +0700 Subject: [PATCH 4/4] cargo deny should pass --- deny.toml | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/deny.toml b/deny.toml index bd776cf32..821a6d203 100644 --- a/deny.toml +++ b/deny.toml @@ -75,6 +75,9 @@ ignore = [ #"a-crate-that-is-yanked@0.1.1", # you can also ignore yanked crate versions if you wish #{ crate = "a-crate-that-is-yanked@0.1.1", reason = "you can specify why you are ignoring the yanked crate" }, ] +# Advisory checks scope: set to "none" to disable specific classes +unmaintained = "none" +yanked = "warn" # If this is true, then cargo deny will use the git executable to fetch advisory database. # If this is false, then it uses a built-in git library. # Setting this to true can be helpful if you have special authentication requirements that cargo-deny does not support. @@ -89,9 +92,22 @@ ignore = [ # See https://spdx.org/licenses/ for list of possible licenses # [possible values: any SPDX 3.11 short identifier (+ optional exception)]. allow = [ - #"MIT", - #"Apache-2.0", - #"Apache-2.0 WITH LLVM-exception", + "Apache-2.0", + "Apache-2.0 WITH LLVM-exception", + "MIT", + "MIT-0", + "BSD-3-Clause", + "BSD-2-Clause", + "0BSD", + "ISC", + "Zlib", + "MPL-2.0", + "BSL-1.0", + "CC0-1.0", + "Unicode-DFS-2016", + "Unicode-3.0", + "CDLA-Permissive-2.0", + "OpenSSL", ] # The confidence threshold for detecting a license from license text. # The higher the value, the more closely the license text must be to the