From f9053fac4b3acd36779ac410157342aa30a11a2e Mon Sep 17 00:00:00 2001 From: Tyr Chen Date: Tue, 19 Mar 2024 22:00:16 -0700 Subject: [PATCH] init the template project --- .github/workflows/build.yml | 55 ++++++++++ .gitignore | 1 + .pre-commit-config.yaml | 61 +++++++++++ CHANGELOG.md | 16 +++ Cargo.lock | 7 ++ Cargo.toml | 8 ++ README.md | 69 ++++++++++++ _typos.toml | 4 + assets/README.md | 3 + assets/juventus.csv | 28 +++++ cliff.toml | 95 ++++++++++++++++ deny.toml | 208 ++++++++++++++++++++++++++++++++++++ src/main.rs | 3 + 13 files changed, 558 insertions(+) create mode 100644 .github/workflows/build.yml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 CHANGELOG.md create mode 100644 Cargo.lock create mode 100644 Cargo.toml create mode 100644 README.md create mode 100644 _typos.toml create mode 100644 assets/README.md create mode 100644 assets/juventus.csv create mode 100644 cliff.toml create mode 100644 deny.toml create mode 100644 src/main.rs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..67074ab --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,55 @@ +name: build + +on: + push: + branches: + - master + tags: + - v* + pull_request: + branches: + - master + +permissions: + contents: write + +jobs: + build-rust: + strategy: + matrix: + platform: [ubuntu-latest] + runs-on: ${{ matrix.platform }} + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + submodules: recursive + - 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@v2 + - 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 + - name: Execute rust tests + run: cargo nextest run --all-features + - name: Generate a changelog + uses: orhun/git-cliff-action@v2 + id: git-cliff + if: startsWith(github.ref, 'refs/tags/') + with: + config: cliff.toml + args: -vv --latest --strip header + env: + OUTPUT: CHANGES.md + - name: Release + uses: softprops/action-gh-release@v1 + if: startsWith(github.ref, 'refs/tags/') + with: + body: ${{ steps.git-cliff.outputs.content }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..dee6400 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,61 @@ +fail_fast: false +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.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 + - id: mixed-line-ending + - id: trailing-whitespace + - repo: https://github.com/psf/black + rev: 22.10.0 + hooks: + - id: black + - 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 -d' + language: rust + files: \.rs$ + args: [] + - id: typos + name: typos + description: check typo + entry: bash -c 'typos' + language: rust + files: \.*$ + pass_filenames: false + - 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 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2f5d3ce --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +# Changelog + +All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines. + +--- +## [unreleased] + +### Miscellaneous Chores + +- initialize basic structure for the repo - ([2436bec](https://github.com/tyrchen/qdrant-lib/commit/2436bec4a02caac64f6c1f97ca79b6ce745b4f53)) - Tyr Chen + +### Other + +- init the project and add the assets - ([6a3ca0a](https://github.com/tyrchen/qdrant-lib/commit/6a3ca0a900451c55969cc8dec20afb5351d86599)) - Tyr Chen + + diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..92ee501 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,7 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "template" +version = "0.1.0" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..a13e012 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "template" +version = "0.1.0" +edition = "2021" + +# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html + +[dependencies] diff --git a/README.md b/README.md new file mode 100644 index 0000000..8caa253 --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# Geektime Rust 语言训练营 + +## 环境设置 + +### 安装 Rust + +```bash +curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh +``` + +### 安装 VSCode 插件 + +- crates: Rust 包管理 +- Even Better TOML: TOML 文件支持 +- Better Comments: 优化注释显示 +- Error Lens: 错误提示优化 +- GitLens: Git 增强 +- Github Copilot: 代码提示 +- indent-rainbow: 缩进显示优化 +- Prettier - Code formatter: 代码格式化 +- REST client: REST API 调试 +- rust-analyzer: Rust 语言支持 +- Rust Test lens: Rust 测试支持 +- Rust Test Explorer: Rust 测试概览 +- TODO Highlight: TODO 高亮 +- vscode-icons: 图标优化 +- YAML: YAML 文件支持 + +### 安装 pre-commit + +pre-commit 是一个代码检查工具，可以在提交代码前进行代码检查。 + +```bash +pipx install pre-commit +``` + +安装成功后运行 `pre-commit install` 即可。 + +### 安装 Cargo deny + +Cargo deny 是一个 Cargo 插件，可以用于检查依赖的安全性。 + +```bash +cargo install --locked cargo-deny +``` + +### 安装 typos + +typos 是一个拼写检查工具。 + +```bash +cargo install typos-cli +``` + +### 安装 git cliff + +git cliff 是一个生成 changelog 的工具。 + +```bash +cargo install git-cliff +``` + +### 安装 cargo nextest + +cargo nextest 是一个 Rust 增强测试工具。 + +```bash +cargo install cargo-nextest --locked +``` diff --git a/_typos.toml b/_typos.toml new file mode 100644 index 0000000..83eada3 --- /dev/null +++ b/_typos.toml @@ -0,0 +1,4 @@ +[default.extend-words] + +[files] +extend-exclude = ["CHANGELOG.md", "notebooks/*"] diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 0000000..ff1895d --- /dev/null +++ b/assets/README.md @@ -0,0 +1,3 @@ +# Assets + +- [juventus.csv](./juventus.csv): dataset from [The-Football-Data](https://github.com/buckthorndev/The-Football-Data). diff --git a/assets/juventus.csv b/assets/juventus.csv new file mode 100644 index 0000000..9ec71e6 --- /dev/null +++ b/assets/juventus.csv @@ -0,0 +1,28 @@ +Name,Position,DOB,Nationality,Kit Number +Wojciech Szczesny,Goalkeeper,"Apr 18, 1990 (29)",Poland,1 +Mattia Perin,Goalkeeper,"Nov 10, 1992 (26)",Italy,37 +Gianluigi Buffon,Goalkeeper,"Jan 28, 1978 (41)",Italy,77 +Carlo Pinsoglio,Goalkeeper,"Mar 16, 1990 (29)",Italy,31 +Matthijs de Ligt,Centre-Back,"Aug 12, 1999 (20)",Netherlands,4 +Leonardo Bonucci,Centre-Back,"May 1, 1987 (32)",Italy,19 +Daniele Rugani,Centre-Back,"Jul 29, 1994 (25)",Italy,24 +Merih Demiral,Centre-Back,"Mar 5, 1998 (21)",Turkey,28 +Giorgio Chiellini,Centre-Back,"Aug 14, 1984 (35)",Italy,3 +Alex Sandro,Left-Back,"Jan 26, 1991 (28)",Brazil,12 +Danilo,Right-Back,"Jul 15, 1991 (28)",Brazil,13 +Mattia De Sciglio,Right-Back,"Oct 20, 1992 (27)",Italy,2 +Emre Can,Defensive Midfield,"Jan 12, 1994 (25)",Germany,23 +Miralem Pjanic,Central Midfield,"Apr 2, 1990 (29)",Bosnia-Herzegovina,5 +Aaron Ramsey,Central Midfield,"Dec 26, 1990 (28)",Wales,8 +Adrien Rabiot,Central Midfield,"Apr 3, 1995 (24)",France,25 +Rodrigo Bentancur,Central Midfield,"Jun 25, 1997 (22)",Uruguay,30 +Blaise Matuidi,Central Midfield,"Apr 9, 1987 (32)",France,14 +Sami Khedira,Central Midfield,"Apr 4, 1987 (32)",Germany,6 +Cristiano Ronaldo,Left Winger,"Feb 5, 1985 (34)",Portugal,7 +Marko Pjaca,Left Winger,"May 6, 1995 (24)",Croatia,15 +Federico Bernardeschi,Right Winger,"Feb 16, 1994 (25)",Italy,33 +Douglas Costa,Right Winger,"Sep 14, 1990 (29)",Brazil,11 +Juan Cuadrado,Right Winger,"May 26, 1988 (31)",Colombia,16 +Paulo Dybala,Second Striker,"Nov 15, 1993 (25)",Argentina,10 +Gonzalo Higuaín,Centre-Forward,"Dec 10, 1987 (31)",Argentina,21 +Mario Mandzukic,Centre-Forward,"May 21, 1986 (33)",Croatia,17 diff --git a/cliff.toml b/cliff.toml new file mode 100644 index 0000000..abaa3ed --- /dev/null +++ b/cliff.toml @@ -0,0 +1,95 @@ +# git-cliff ~ configuration file +# https://git-cliff.org/docs/configuration + +[changelog] +# changelog header +header = """ +# Changelog\n +All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\n +""" +# template for the changelog body +# https://keats.github.io/tera/docs/#introduction +body = """ +--- +{% if version %}\ + {% if previous.version %}\ + ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }} + {% else %}\ + ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }} + {% endif %}\ +{% else %}\ + ## [unreleased] +{% endif %}\ +{% for group, commits in commits | group_by(attribute="group") %} + ### {{ group | striptags | trim | upper_first }} + {% for commit in commits + | filter(attribute="scope") + | sort(attribute="scope") %} + - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \ + {{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} + {%- endfor -%} + {% raw %}\n{% endraw %}\ + {%- for commit in commits %} + {%- if commit.scope -%} + {% else -%} + - {% if commit.breaking %} [**breaking**]{% endif %}\ + {{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }} + {% endif -%} + {% endfor -%} +{% endfor %}\n +""" +# template for the changelog footer +footer = """ + +""" +# remove the leading and trailing whitespace from the templates +trim = true +# postprocessors +postprocessors = [ + { pattern = '\$REPO', replace = "https://github.com/tyrchen/geektime-rust-live-coding" }, # replace repository URL +] + +[git] +# parse the commits based on https://www.conventionalcommits.org +conventional_commits = true +# filter out the commits that are not conventional +filter_unconventional = false +# process each line of a commit as an individual commit +split_commits = false +# regex for preprocessing the commit messages +commit_preprocessors = [ + # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers +] +# regex for parsing and grouping commits +commit_parsers = [ + { message = "\\[skip", skip = true }, + { message = "\\p{Han}", skip = true }, + { message = "^feat", group = "Features" }, + { message = "^fix", group = "Bug Fixes" }, + { message = "^doc", group = "Documentation" }, + { message = "^perf", group = "Performance" }, + { message = "^refactor", group = "Refactoring" }, + { message = "^style", group = "Style" }, + { message = "^revert", group = "Revert" }, + { message = "^test", group = "Tests" }, + { message = "^chore\\(version\\):", skip = true }, + { message = "^chore", group = "Miscellaneous Chores" }, + { message = ".*", group = "Other" }, + { body = ".*security", group = "Security" }, +] +# protect breaking changes from being skipped due to matching a skipping commit_parser +protect_breaking_commits = false +# filter out the commits that are not matched by commit parsers +filter_commits = false +# regex for matching git tags +tag_pattern = "v[0-9].*" +# regex for skipping tags +skip_tags = "v0.1.0-beta.1" +# regex for ignoring tags +ignore_tags = "" +# sort the tags topologically +topo_order = false +# sort the commits inside sections by oldest/newest order +sort_commits = "oldest" +# limit the number of commits included in the changelog. +# limit_commits = 42 diff --git a/deny.toml b/deny.toml new file mode 100644 index 0000000..ba7d5ad --- /dev/null +++ b/deny.toml @@ -0,0 +1,208 @@ +# 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", + "MPL-2.0", + "BSD-2-Clause", + "BSD-3-Clause", + "ISC", + "CC0-1.0", +] +# 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 = [] diff --git a/src/main.rs b/src/main.rs new file mode 100644 index 0000000..e7a11a9 --- /dev/null +++ b/src/main.rs @@ -0,0 +1,3 @@ +fn main() { + println!("Hello, world!"); +}