-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
353 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
name: build | ||
|
||
on: | ||
push: | ||
branches: | ||
- main | ||
pull_request: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
build-rust: | ||
strategy: | ||
matrix: | ||
platform: [ubuntu-latest] | ||
runs-on: ${{ matrix.platform }} | ||
steps: | ||
- uses: actions/checkout@v3 | ||
with: | ||
fetch-depth: 0 | ||
- name: Install Rust | ||
run: rustup toolchain install stable --component llvm-tools-preview | ||
- name: Install cargo-llvm-cov | ||
uses: taiki-e/install-action@cargo-llvm-cov | ||
- name: install nextest | ||
uses: taiki-e/install-action@nextest | ||
- uses: Swatinem/rust-cache@v1 | ||
- name: Check code format | ||
run: cargo fmt -- --check | ||
- name: Check the package for errors | ||
run: cargo check --all | ||
- name: Lint rust sources | ||
run: cargo clippy --all-targets --all-features --tests --benches -- -D warnings |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,61 @@ | ||
fail_fast: false | ||
repos: | ||
- repo: https://github.com/pre-commit/pre-commit-hooks | ||
rev: v2.3.0 | ||
hooks: | ||
- id: check-byte-order-marker | ||
- id: check-case-conflict | ||
- id: check-merge-conflict | ||
- id: check-symlinks | ||
- id: check-yaml | ||
- id: end-of-file-fixer | ||
exclude: '\.(md|csv|txt|xlsx)' | ||
- id: mixed-line-ending | ||
exclude: '\.(md|csv|txt|xlsx)' | ||
- id: trailing-whitespace | ||
exclude: '\.(md|csv|txt|xlsx)' | ||
- repo: https://github.com/psf/black | ||
rev: 19.3b0 | ||
hooks: | ||
- id: black | ||
- repo: https://github.com/crate-ci/typos | ||
rev: v1.8.1 | ||
hooks: | ||
- id: typos | ||
- repo: local | ||
hooks: | ||
- id: cargo-fmt | ||
name: cargo fmt | ||
description: Format files with rustfmt. | ||
entry: bash -c 'cargo fmt -- --check' | ||
language: rust | ||
files: \.rs$ | ||
args: [] | ||
# - id: cargo-deny | ||
# name: cargo deny check | ||
# description: Check cargo dependencies | ||
# entry: bash -c 'cargo deny check' | ||
# language: rust | ||
# files: \.rs$ | ||
# args: [] | ||
- id: cargo-check | ||
name: cargo check | ||
description: Check the package for errors. | ||
entry: bash -c 'cargo check --all' | ||
language: rust | ||
files: \.rs$ | ||
pass_filenames: false | ||
- id: cargo-clippy | ||
name: cargo clippy | ||
description: Lint rust sources | ||
entry: bash -c 'cargo clippy --all-targets --all-features --tests --benches -- -D warnings' | ||
language: rust | ||
files: \.rs$ | ||
pass_filenames: false | ||
- id: cargo-test | ||
name: cargo test | ||
description: unit test for the project | ||
entry: bash -c 'cargo nextest run --all-features' | ||
language: rust | ||
files: \.rs$ | ||
pass_filenames: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"editor.tabCompletion": "on", | ||
"diffEditor.codeLens": true, | ||
"rust-analyzer.showUnlinkedFileNotification": false | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
[default.extend-words] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,207 @@ | ||
# 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 | ||
|
||
# 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 | ||
#{ triple = "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"] }, | ||
] | ||
|
||
# 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 database is cloned/fetched into | ||
db-path = "~/.cargo/advisory-db" | ||
# The url(s) of the advisory databases to use | ||
db-urls = ["https://github.com/rustsec/advisory-db"] | ||
# The lint level for security vulnerabilities | ||
vulnerability = "deny" | ||
# The lint level for unmaintained crates | ||
unmaintained = "warn" | ||
# The lint level for crates that have been yanked from their source registry | ||
yanked = "warn" | ||
# The lint level for crates with security notices. Note that as of | ||
# 2019-12-17 there are no security notice advisories in | ||
# https://github.com/rustsec/advisory-db | ||
notice = "warn" | ||
# A list of advisory IDs to ignore. Note that ignored advisories will still | ||
# output a note when they are encountered. | ||
ignore = [ | ||
#"RUSTSEC-0000-0000", | ||
] | ||
# Threshold for security vulnerabilities, any vulnerability with a CVSS score | ||
# lower than the range specified will be ignored. Note that ignored advisories | ||
# will still output a note when they are encountered. | ||
# * None - CVSS Score 0.0 | ||
# * Low - CVSS Score 0.1 - 3.9 | ||
# * Medium - CVSS Score 4.0 - 6.9 | ||
# * High - CVSS Score 7.0 - 8.9 | ||
# * Critical - CVSS Score 9.0 - 10.0 | ||
#severity-threshold = | ||
|
||
# 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] | ||
# The lint level for crates which do not have a detectable license | ||
unlicensed = "allow" | ||
# List of explicitly allowed licenses | ||
# See https://spdx.org/licenses/ for list of possible licenses | ||
# [possible values: any SPDX 3.7 short identifier (+ optional exception)]. | ||
allow = [ | ||
"MIT", | ||
"Apache-2.0", | ||
"Unicode-DFS-2016", | ||
"Apache-2.0 WITH LLVM-exception", | ||
"BSD-3-Clause", | ||
"MPL-2.0", | ||
"ISC", | ||
] | ||
# List of explicitly disallowed licenses | ||
# See https://spdx.org/licenses/ for list of possible licenses | ||
# [possible values: any SPDX 3.7 short identifier (+ optional exception)]. | ||
deny = [ | ||
#"Nokia", | ||
] | ||
# Lint level for licenses considered copyleft | ||
copyleft = "warn" | ||
# Blanket approval or denial for OSI-approved or FSF Free/Libre licenses | ||
# * both - The license will be approved if it is both OSI-approved *AND* FSF | ||
# * either - The license will be approved if it is either OSI-approved *OR* FSF | ||
# * osi-only - The license will be approved if is OSI-approved *AND NOT* FSF | ||
# * fsf-only - The license will be approved if is FSF *AND NOT* OSI-approved | ||
# * neither - This predicate is ignored and the default lint level is used | ||
allow-osi-fsf-free = "neither" | ||
# Lint level used when no other predicates are matched | ||
# 1. License isn't in the allow or deny lists | ||
# 2. License isn't copyleft | ||
# 3. License isn't OSI/FSF, or allow-osi-fsf-free = "neither" | ||
default = "deny" | ||
# 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"], name = "adler32", version = "*" }, | ||
] | ||
|
||
# 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 name of the crate the clarification applies to | ||
#name = "ring" | ||
# The optional version constraint for the crate | ||
#version = "*" | ||
# 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 | ||
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" | ||
# 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" | ||
# List of crates that are allowed. Use with care! | ||
allow = [ | ||
#{ name = "ansi_term", version = "=0.11.0" }, | ||
] | ||
# List of crates to deny | ||
deny = [ | ||
# Each entry the name of a crate and a version range. If version is | ||
# not specified, all versions will be matched. | ||
#{ name = "ansi_term", version = "=0.11.0" }, | ||
# | ||
# Wrapper crates can optionally be specified to allow the crate when it | ||
# is a direct dependency of the otherwise banned crate | ||
#{ name = "ansi_term", version = "=0.11.0", wrappers = [] }, | ||
] | ||
# Certain crates/versions that will be skipped when doing duplicate detection. | ||
skip = [ | ||
#{ name = "ansi_term", version = "=0.11.0" }, | ||
] | ||
# 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 = [ | ||
#{ name = "ansi_term", version = "=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] | ||
# 1 or more github.com organizations to allow git sources for | ||
github = [] | ||
# 1 or more gitlab.com organizations to allow git sources for | ||
gitlab = [] | ||
# 1 or more bitbucket.org organizations to allow git sources for | ||
bitbucket = [] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
#!/bin/bash | ||
|
||
# Check if pre-commit is installed | ||
if ! command -v pre-commit &>/dev/null; then | ||
echo "pre-commit not found. Installing..." | ||
pip3 install pre-commit | ||
else | ||
echo "pre-commit already installed" | ||
fi | ||
|
||
# Check if rustup is installed | ||
if ! command -v rustup &>/dev/null; then | ||
echo "rustup not found. Installing..." | ||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh | ||
source "$HOME/.cargo/env" | ||
else | ||
echo "rustup already installed" | ||
fi | ||
|
||
# Check if nextest is installed | ||
if ! command -v cargo-nextest &>/dev/null; then | ||
echo "cargo-nextest not found. Installing..." | ||
cargo install cargo-nextest --locked | ||
else | ||
echo "cargo-nextest already installed" | ||
fi | ||
|
||
# Check if cargo-deny is installed | ||
if ! command -v cargo-deny &>/dev/null; then | ||
echo "cargo-deny not found. Installing..." | ||
cargo install cargo-deny --locked | ||
else | ||
echo "cargo-deny already installed" | ||
fi | ||
|
||
# Check if typos is installed | ||
if ! command -v typos &>/dev/null; then | ||
echo "typos not found. Installing..." | ||
cargo install typos-cli | ||
else | ||
echo "typos already installed" | ||
fi | ||
|
||
# Install pre-commit hooks | ||
echo "Installing pre-commit hooks..." | ||
pre-commit install |