samanthanguyen.me
+11
.clippy.toml
+11
.clippy.toml
···
1
+
# .clippy.toml is a configuration file to configure different types of
2
+
# Clippy lints. Please note that through this file:
3
+
# - it is only possible to configure the behavior of lints
4
+
# - it is not possible to add new lints, or allow/deny lints
5
+
#
6
+
# To run Clippy, run: `cargo clippy`
7
+
#
8
+
# Further readings:
9
+
# - Repository: https://github.com/rust-lang/rust-clippy
10
+
# - Documentation: https://rust-lang.github.io/rust-clippy/master/index.html
11
+
# - Allowing/denying lints: https://github.com/rust-lang/rust-clippy#allowingdenying-lints
+11
.devcontainer/Dockerfile
+11
.devcontainer/Dockerfile
···
1
+
# [Choice] Debian OS version (use bookworm, or bullseye on local arm64/Apple Silicon): bookworm, buster, bullseye
2
+
ARG VARIANT="bookworm"
3
+
FROM rust:1-${VARIANT}
4
+
5
+
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
6
+
# Remove imagemagick due to https://security-tracker.debian.org/tracker/CVE-2019-10131
7
+
&& apt-get purge -y imagemagick imagemagick-6-common
8
+
9
+
# [Optional] Uncomment this section to install additional OS packages.
10
+
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
11
+
# && apt-get -y install --no-install-recommends <your-package-list-here>
+67
.devcontainer/devcontainer.json
+67
.devcontainer/devcontainer.json
···
1
+
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
2
+
// https://github.com/devcontainers/images/tree/main/src/rust
3
+
{
4
+
"name": "Rust",
5
+
"build": {
6
+
"dockerfile": "./Dockerfile",
7
+
"context": "."
8
+
},
9
+
"features": {
10
+
"ghcr.io/devcontainers/features/common-utils:2": {
11
+
"installZsh": "true",
12
+
"username": "vscode",
13
+
"userUid": "1000",
14
+
"userGid": "1000",
15
+
"upgradePackages": "true"
16
+
},
17
+
"ghcr.io/devcontainers/features/rust:1": "latest",
18
+
"ghcr.io/devcontainers/features/git:1": {
19
+
"version": "latest",
20
+
"ppa": "false"
21
+
}
22
+
},
23
+
24
+
// Configure tool-specific properties.
25
+
"customizations": {
26
+
// Configure properties specific to VS Code.
27
+
"vscode": {
28
+
// Set *default* container specific settings.json values on container create.
29
+
"settings": {
30
+
// VS Code don't watch files under ./target
31
+
"files.watcherExclude": {
32
+
"**/target/**": true
33
+
},
34
+
"rust-analyzer.checkOnSave.command": "clippy"
35
+
},
36
+
37
+
// Add the IDs of extensions you want installed when the container is created.
38
+
"extensions": [
39
+
// quality-of-life
40
+
"mutantdino.resourcemonitor",
41
+
42
+
// Rust + debugging
43
+
"rust-lang.rust-analyzer",
44
+
"serayuzgur.crates",
45
+
"tamasfe.even-better-toml",
46
+
47
+
// Markdown
48
+
"mathiassoeholm.markdown-link-updater",
49
+
"yzhang.markdown-all-in-one"
50
+
]
51
+
}
52
+
},
53
+
54
+
// Use 'forwardPorts' to make a list of ports inside the container available locally.
55
+
// "forwardPorts": [],
56
+
// "onCreateCommand": "rustup default nightly",
57
+
58
+
// Use 'postCreateCommand' to run commands after the container is created.
59
+
"postCreateCommand": [
60
+
"cargo --version",
61
+
"rustup --version",
62
+
"rustc --version"
63
+
],
64
+
65
+
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
66
+
"remoteUser": "vscode"
67
+
}
+18
.editorconfig
+18
.editorconfig
···
1
+
root = true
2
+
3
+
end_of_line = lf
4
+
insert_final_newline = true
5
+
6
+
[*]
7
+
charset = utf-8
8
+
trim_trailing_whitespace = true
9
+
insert_final_newline = true
10
+
indent_style = tab
11
+
indent_tab = 8
12
+
13
+
[*.md]
14
+
trim_trailing_whitespace = false
15
+
16
+
[*.yml]
17
+
indent_style = space
18
+
indent_size = 2
+50
.github/dependabot.yml
+50
.github/dependabot.yml
···
1
+
# To get started with Dependabot version updates, you'll need to specify which
2
+
# package ecosystems to update and where the package manifests are located.
3
+
# Please see the documentation for all configuration options:
4
+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5
+
6
+
version: 2
7
+
updates:
8
+
- package-ecosystem: "cargo"
9
+
directory: "/"
10
+
schedule:
11
+
interval: "weekly"
12
+
commit-message:
13
+
prefix: "chore(deps/cargo):"
14
+
labels:
15
+
- "t-dependencies"
16
+
- "pkg-cargo"
17
+
open-pull-requests-limit: 4
18
+
19
+
- package-ecosystem: "cargo"
20
+
directory: "/fuzz"
21
+
schedule:
22
+
interval: "weekly"
23
+
commit-message:
24
+
prefix: "chore(deps/cargo):"
25
+
labels:
26
+
- "t-dependencies"
27
+
- "pkg-cargo"
28
+
open-pull-requests-limit: 4
29
+
30
+
- package-ecosystem: "github-actions"
31
+
directory: "/"
32
+
schedule:
33
+
interval: "weekly"
34
+
commit-message:
35
+
prefix: "chore(deps/actions):"
36
+
labels:
37
+
- "t-dependencies"
38
+
- "pkg-gh-actions"
39
+
open-pull-requests-limit: 4
40
+
41
+
- package-ecosystem: "npm"
42
+
directory: "/book"
43
+
schedule:
44
+
interval: "weekly"
45
+
commit-message:
46
+
prefix: "chore(deps/npm):"
47
+
labels:
48
+
- "t-dependencies"
49
+
- "pkg-npm"
50
+
open-pull-requests-limit: 4
+44
.github/workflows/docs.yml
+44
.github/workflows/docs.yml
···
1
+
name: rustdoc
2
+
3
+
on:
4
+
push:
5
+
branches: [main]
6
+
pull_request:
7
+
branches: [main]
8
+
workflow_dispatch:
9
+
10
+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
11
+
permissions:
12
+
contents: write
13
+
14
+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
15
+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
16
+
concurrency:
17
+
group: "pages"
18
+
cancel-in-progress: false
19
+
20
+
jobs:
21
+
rustdoc-build:
22
+
runs-on: ubuntu-latest
23
+
steps:
24
+
- uses: actions/checkout@v4
25
+
- name: Install Rust
26
+
run: |
27
+
rustup set profile minimal
28
+
rustup toolchain install nightly
29
+
rustup override set nightly
30
+
- name: Compile crates
31
+
run: cargo build --verbose
32
+
- name: Build documentation
33
+
run: cargo doc --workspace --no-deps --all-features
34
+
env:
35
+
RUSTDOCFLAGS: --enable-index-page -Zunstable-options
36
+
- name: Print out build files in /target/doc
37
+
run: find ./target/doc -exec echo {} \;
38
+
- name: Deploy to GitHub Pages
39
+
if: github.event_name != 'pull_request'
40
+
uses: peaceiris/actions-gh-pages@v3
41
+
with:
42
+
github_token: ${{ secrets.GITHUB_TOKEN }}
43
+
publish_dir: ./target/doc
44
+
force_orphan: true
+198
.github/workflows/main.yml
+198
.github/workflows/main.yml
···
1
+
name: CI
2
+
3
+
# # NOTES
4
+
#
5
+
# ## GitHub Apps
6
+
#
7
+
# To use Codecov (for uploading and analyzing code coverage), you must
8
+
# authenticate the Codecov GitHub App via https://github.com/apps/codecov.
9
+
#
10
+
# ## GitHub Actions
11
+
#
12
+
# This workflow avoids the following GitHub Actions at the moment:
13
+
# - `actions-rs/cargo`: See https://github.com/actions-rs/cargo/issues/216 (Node.js 12)
14
+
# - `actions-rs/toolchain`: See https://github.com/actions-rs/toolchain/issues/219 (Node.js 12)
15
+
# - `actions-rs/tarpaulin`: This seems to be shaky, and will sometimes fail, and sometimes work.
16
+
#
17
+
# For `actions-rs/cargo` and `actions-rs/toolchain`, we instead use
18
+
# `cargo` and `rustup` directly in the CLI instead respectively.
19
+
#
20
+
# For `actions-rs/tarpaulin`, we instead use `cargo-llvm-codecov` via
21
+
# `taiki-e/install-action@cargo-llvm-cov`.
22
+
23
+
on:
24
+
push:
25
+
branches: [ main ]
26
+
pull_request:
27
+
28
+
jobs:
29
+
build:
30
+
name: build (${{ matrix.label }})
31
+
runs-on: ubuntu-latest
32
+
strategy:
33
+
# Documentation:
34
+
# - https://docs.github.com/en/actions/using-jobs/using-a-matrix-for-your-jobs
35
+
# - https://rust-lang.github.io/rustup/concepts/channels.html
36
+
# - https://rust-lang.github.io/rustup/concepts/toolchains.html
37
+
matrix:
38
+
include:
39
+
- label: msrv
40
+
toolchain: '1.70'
41
+
- label: stable
42
+
toolchain: stable
43
+
- label: beta
44
+
toolchain: beta
45
+
- label: nightly
46
+
toolchain: nightly
47
+
48
+
steps:
49
+
- name: Checkout repository
50
+
uses: actions/checkout@v4
51
+
- name: Install Rust (${{ matrix.toolchain }})
52
+
run: |
53
+
rustup set profile minimal
54
+
rustup toolchain install ${{ matrix.toolchain }}
55
+
rustup override set ${{ matrix.toolchain }}
56
+
- name: Print environment info
57
+
run: |
58
+
rustc --version --verbose
59
+
cargo --version
60
+
rustup --version
61
+
- name: Cache dependencies
62
+
uses: Swatinem/rust-cache@v2
63
+
with:
64
+
shared-key: full-build-cache
65
+
- name: Build
66
+
run: cargo build --verbose
67
+
68
+
test:
69
+
name: test
70
+
runs-on: ubuntu-latest
71
+
72
+
steps:
73
+
- name: Checkout repository
74
+
uses: actions/checkout@v4
75
+
- name: Install Rust
76
+
run: |
77
+
rustup set profile minimal
78
+
rustup toolchain install stable
79
+
rustup override set stable
80
+
rustup component add llvm-tools-preview
81
+
- name: Print environment info
82
+
run: |
83
+
rustc --version --verbose
84
+
cargo --version
85
+
rustup --version
86
+
- name: Cache dependencies
87
+
uses: Swatinem/rust-cache@v2
88
+
with:
89
+
shared-key: full-build-cache
90
+
- name: Install cargo-llvm-codecov
91
+
uses: taiki-e/install-action@cargo-llvm-cov
92
+
- name: Generate code coverage
93
+
run: cargo llvm-cov --all-features --workspace --lcov --output-path lcov.info
94
+
- name: Upload code coverage
95
+
uses: codecov/codecov-action@v3
96
+
with:
97
+
token: ${{ secrets.CODECOV_TOKEN }}
98
+
verbose: true
99
+
files: lcov.info
100
+
101
+
miri:
102
+
runs-on: ubuntu-latest
103
+
104
+
steps:
105
+
- name: Checkout repository
106
+
uses: actions/checkout@v4
107
+
- name: Install Rust (nightly)
108
+
run: |
109
+
rustup set profile minimal
110
+
rustup toolchain install nightly
111
+
rustup override set nightly
112
+
rustup component add miri
113
+
- name: Print environment info
114
+
run: |
115
+
rustc --version --verbose
116
+
cargo --version
117
+
rustup --version
118
+
cargo miri --version
119
+
- name: Cache dependencies
120
+
uses: Swatinem/rust-cache@v2
121
+
with:
122
+
shared-key: full-build-cache
123
+
- name: Setup Miri
124
+
run: |
125
+
cargo miri setup
126
+
- name: Run tests with Miri
127
+
run: cargo miri test
128
+
129
+
# bench:
130
+
# name: bench
131
+
# runs-on: ubuntu-latest
132
+
# needs: build
133
+
134
+
# steps:
135
+
# - name: Checkout repository
136
+
# uses: actions/checkout@v4
137
+
# - name: Install Rust
138
+
# run: |
139
+
# rustup set profile minimal
140
+
# rustup toolchain install stable
141
+
# rustup override set stable
142
+
# - name: Print environment info
143
+
# run: |
144
+
# rustc --version --verbose
145
+
# cargo --version
146
+
# rustup --version
147
+
# - name: Install Valgrind
148
+
# run: sudo apt install -y valgrind
149
+
# - name: Run benchmarks
150
+
# run: cargo bench --no-fail-fast
151
+
152
+
codequality-check:
153
+
name: codequality-check (${{ matrix.tool }})
154
+
runs-on: ubuntu-latest
155
+
strategy:
156
+
matrix:
157
+
include:
158
+
- tool: clippy
159
+
cmd-cargo: clippy
160
+
cmd-check: cargo clippy --all-features
161
+
- tool: rustfmt
162
+
cmd-cargo: fmt
163
+
cmd-check: cargo fmt --all -- --check
164
+
steps:
165
+
- name: Checkout repository
166
+
uses: actions/checkout@v4
167
+
- name: Install Rust
168
+
run: |
169
+
rustup set profile minimal
170
+
rustup toolchain install stable
171
+
rustup override set stable
172
+
rustup component add ${{ matrix.tool }}
173
+
- name: Print environment info
174
+
run: |
175
+
rustc --version --verbose
176
+
cargo --version
177
+
cargo ${{ matrix.cmd-cargo }} --version
178
+
rustup --version
179
+
- name: Cache dependencies
180
+
uses: Swatinem/rust-cache@v2
181
+
with:
182
+
shared-key: full-build-cache
183
+
- name: Run code quality assurance check (${{ matrix.tool }})
184
+
run: ${{ matrix.cmd-check }}
185
+
186
+
ci-success:
187
+
name: ci-success
188
+
if: ${{ success() }}
189
+
needs:
190
+
- build
191
+
- test
192
+
- miri
193
+
# - bench
194
+
- codequality-check
195
+
runs-on: ubuntu-latest
196
+
steps:
197
+
- name: ✅ CI succeeded
198
+
run: exit 0
+37
.github/workflows/security-audit.yml
+37
.github/workflows/security-audit.yml
···
1
+
name: Security audit
2
+
on:
3
+
pull_request:
4
+
paths:
5
+
- '**/Cargo.toml'
6
+
- '**/Cargo.lock'
7
+
push:
8
+
branches:
9
+
- main
10
+
paths:
11
+
- '**/Cargo.toml'
12
+
- '**/Cargo.lock'
13
+
schedule:
14
+
# Run once a week on Monday at 00:00 (12:00AM or Midnight, UTC)
15
+
# See POSIX cron syntax visualized at https://crontab.guru/#0_0_*_*_1
16
+
# GitHub Docs: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#onschedule
17
+
# Cron syntax reference: https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07
18
+
- cron: '0 0 * * 1'
19
+
workflow_dispatch:
20
+
21
+
jobs:
22
+
audit:
23
+
runs-on: ubuntu-latest
24
+
strategy:
25
+
matrix:
26
+
checks:
27
+
- advisories
28
+
- bans licenses sources
29
+
30
+
# Prevent sudden announcement of a new advisory from failing ci:
31
+
continue-on-error: ${{ matrix.checks == 'advisories' }}
32
+
33
+
steps:
34
+
- uses: actions/checkout@v4
35
+
- uses: EmbarkStudios/cargo-deny-action@v1
36
+
with:
37
+
command: check ${{ matrix.checks }}
+12
.gitignore
+12
.gitignore
···
1
+
# Generated by Cargo
2
+
# will have compiled files and executables
3
+
/target/
4
+
5
+
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
6
+
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
7
+
Cargo.lock
8
+
9
+
# These are backup files generated by rustfmt
10
+
**/*.rs.bk
11
+
12
+
node_modules
+9
CHANGELOG.md
+9
CHANGELOG.md
···
1
+
# Changelog
2
+
3
+
## 0.1.0 (2022-10-14)
4
+
5
+
6
+
### Features
7
+
8
+
* add commit message linting ([990a371](https://github.com/neoncitylights/rust/commit/990a371b939964283bc2c1e351aecf9339840a4f))
9
+
* add support for mdBook ([5bd6394](https://github.com/neoncitylights/rust/commit/5bd6394975b4c5c355d7ea8a0091e7b604963d6b))
+201
LICENSE-APACHE
+201
LICENSE-APACHE
···
1
+
Apache License
2
+
Version 2.0, January 2004
3
+
http://www.apache.org/licenses/
4
+
5
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+
1. Definitions.
8
+
9
+
"License" shall mean the terms and conditions for use, reproduction,
10
+
and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+
"Licensor" shall mean the copyright owner or entity authorized by
13
+
the copyright owner that is granting the License.
14
+
15
+
"Legal Entity" shall mean the union of the acting entity and all
16
+
other entities that control, are controlled by, or are under common
17
+
control with that entity. For the purposes of this definition,
18
+
"control" means (i) the power, direct or indirect, to cause the
19
+
direction or management of such entity, whether by contract or
20
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+
outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+
"You" (or "Your") shall mean an individual or Legal Entity
24
+
exercising permissions granted by this License.
25
+
26
+
"Source" form shall mean the preferred form for making modifications,
27
+
including but not limited to software source code, documentation
28
+
source, and configuration files.
29
+
30
+
"Object" form shall mean any form resulting from mechanical
31
+
transformation or translation of a Source form, including but
32
+
not limited to compiled object code, generated documentation,
33
+
and conversions to other media types.
34
+
35
+
"Work" shall mean the work of authorship, whether in Source or
36
+
Object form, made available under the License, as indicated by a
37
+
copyright notice that is included in or attached to the work
38
+
(an example is provided in the Appendix below).
39
+
40
+
"Derivative Works" shall mean any work, whether in Source or Object
41
+
form, that is based on (or derived from) the Work and for which the
42
+
editorial revisions, annotations, elaborations, or other modifications
43
+
represent, as a whole, an original work of authorship. For the purposes
44
+
of this License, Derivative Works shall not include works that remain
45
+
separable from, or merely link (or bind by name) to the interfaces of,
46
+
the Work and Derivative Works thereof.
47
+
48
+
"Contribution" shall mean any work of authorship, including
49
+
the original version of the Work and any modifications or additions
50
+
to that Work or Derivative Works thereof, that is intentionally
51
+
submitted to Licensor for inclusion in the Work by the copyright owner
52
+
or by an individual or Legal Entity authorized to submit on behalf of
53
+
the copyright owner. For the purposes of this definition, "submitted"
54
+
means any form of electronic, verbal, or written communication sent
55
+
to the Licensor or its representatives, including but not limited to
56
+
communication on electronic mailing lists, source code control systems,
57
+
and issue tracking systems that are managed by, or on behalf of, the
58
+
Licensor for the purpose of discussing and improving the Work, but
59
+
excluding communication that is conspicuously marked or otherwise
60
+
designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+
"Contributor" shall mean Licensor and any individual or Legal Entity
63
+
on behalf of whom a Contribution has been received by Licensor and
64
+
subsequently incorporated within the Work.
65
+
66
+
2. Grant of Copyright License. Subject to the terms and conditions of
67
+
this License, each Contributor hereby grants to You a perpetual,
68
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+
copyright license to reproduce, prepare Derivative Works of,
70
+
publicly display, publicly perform, sublicense, and distribute the
71
+
Work and such Derivative Works in Source or Object form.
72
+
73
+
3. Grant of Patent License. Subject to the terms and conditions of
74
+
this License, each Contributor hereby grants to You a perpetual,
75
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+
(except as stated in this section) patent license to make, have made,
77
+
use, offer to sell, sell, import, and otherwise transfer the Work,
78
+
where such license applies only to those patent claims licensable
79
+
by such Contributor that are necessarily infringed by their
80
+
Contribution(s) alone or by combination of their Contribution(s)
81
+
with the Work to which such Contribution(s) was submitted. If You
82
+
institute patent litigation against any entity (including a
83
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+
or a Contribution incorporated within the Work constitutes direct
85
+
or contributory patent infringement, then any patent licenses
86
+
granted to You under this License for that Work shall terminate
87
+
as of the date such litigation is filed.
88
+
89
+
4. Redistribution. You may reproduce and distribute copies of the
90
+
Work or Derivative Works thereof in any medium, with or without
91
+
modifications, and in Source or Object form, provided that You
92
+
meet the following conditions:
93
+
94
+
(a) You must give any other recipients of the Work or
95
+
Derivative Works a copy of this License; and
96
+
97
+
(b) You must cause any modified files to carry prominent notices
98
+
stating that You changed the files; and
99
+
100
+
(c) You must retain, in the Source form of any Derivative Works
101
+
that You distribute, all copyright, patent, trademark, and
102
+
attribution notices from the Source form of the Work,
103
+
excluding those notices that do not pertain to any part of
104
+
the Derivative Works; and
105
+
106
+
(d) If the Work includes a "NOTICE" text file as part of its
107
+
distribution, then any Derivative Works that You distribute must
108
+
include a readable copy of the attribution notices contained
109
+
within such NOTICE file, excluding those notices that do not
110
+
pertain to any part of the Derivative Works, in at least one
111
+
of the following places: within a NOTICE text file distributed
112
+
as part of the Derivative Works; within the Source form or
113
+
documentation, if provided along with the Derivative Works; or,
114
+
within a display generated by the Derivative Works, if and
115
+
wherever such third-party notices normally appear. The contents
116
+
of the NOTICE file are for informational purposes only and
117
+
do not modify the License. You may add Your own attribution
118
+
notices within Derivative Works that You distribute, alongside
119
+
or as an addendum to the NOTICE text from the Work, provided
120
+
that such additional attribution notices cannot be construed
121
+
as modifying the License.
122
+
123
+
You may add Your own copyright statement to Your modifications and
124
+
may provide additional or different license terms and conditions
125
+
for use, reproduction, or distribution of Your modifications, or
126
+
for any such Derivative Works as a whole, provided Your use,
127
+
reproduction, and distribution of the Work otherwise complies with
128
+
the conditions stated in this License.
129
+
130
+
5. Submission of Contributions. Unless You explicitly state otherwise,
131
+
any Contribution intentionally submitted for inclusion in the Work
132
+
by You to the Licensor shall be under the terms and conditions of
133
+
this License, without any additional terms or conditions.
134
+
Notwithstanding the above, nothing herein shall supersede or modify
135
+
the terms of any separate license agreement you may have executed
136
+
with Licensor regarding such Contributions.
137
+
138
+
6. Trademarks. This License does not grant permission to use the trade
139
+
names, trademarks, service marks, or product names of the Licensor,
140
+
except as required for reasonable and customary use in describing the
141
+
origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+
7. Disclaimer of Warranty. Unless required by applicable law or
144
+
agreed to in writing, Licensor provides the Work (and each
145
+
Contributor provides its Contributions) on an "AS IS" BASIS,
146
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+
implied, including, without limitation, any warranties or conditions
148
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+
PARTICULAR PURPOSE. You are solely responsible for determining the
150
+
appropriateness of using or redistributing the Work and assume any
151
+
risks associated with Your exercise of permissions under this License.
152
+
153
+
8. Limitation of Liability. In no event and under no legal theory,
154
+
whether in tort (including negligence), contract, or otherwise,
155
+
unless required by applicable law (such as deliberate and grossly
156
+
negligent acts) or agreed to in writing, shall any Contributor be
157
+
liable to You for damages, including any direct, indirect, special,
158
+
incidental, or consequential damages of any character arising as a
159
+
result of this License or out of the use or inability to use the
160
+
Work (including but not limited to damages for loss of goodwill,
161
+
work stoppage, computer failure or malfunction, or any and all
162
+
other commercial damages or losses), even if such Contributor
163
+
has been advised of the possibility of such damages.
164
+
165
+
9. Accepting Warranty or Additional Liability. While redistributing
166
+
the Work or Derivative Works thereof, You may choose to offer,
167
+
and charge a fee for, acceptance of support, warranty, indemnity,
168
+
or other liability obligations and/or rights consistent with this
169
+
License. However, in accepting such obligations, You may act only
170
+
on Your own behalf and on Your sole responsibility, not on behalf
171
+
of any other Contributor, and only if You agree to indemnify,
172
+
defend, and hold each Contributor harmless for any liability
173
+
incurred by, or claims asserted against, such Contributor by reason
174
+
of your accepting any such warranty or additional liability.
175
+
176
+
END OF TERMS AND CONDITIONS
177
+
178
+
APPENDIX: How to apply the Apache License to your work.
179
+
180
+
To apply the Apache License to your work, attach the following
181
+
boilerplate notice, with the fields enclosed by brackets "[]"
182
+
replaced with your own identifying information. (Don't include
183
+
the brackets!) The text should be enclosed in the appropriate
184
+
comment syntax for the file format. We also recommend that a
185
+
file or class name and description of purpose be included on the
186
+
same "printed page" as the copyright notice for easier
187
+
identification within third-party archives.
188
+
189
+
Copyright 2022 [name of copyright owner]
190
+
191
+
Licensed under the Apache License, Version 2.0 (the "License");
192
+
you may not use this file except in compliance with the License.
193
+
You may obtain a copy of the License at
194
+
195
+
http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+
Unless required by applicable law or agreed to in writing, software
198
+
distributed under the License is distributed on an "AS IS" BASIS,
199
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+
See the License for the specific language governing permissions and
201
+
limitations under the License.
+21
LICENSE-MIT
+21
LICENSE-MIT
···
1
+
MIT License
2
+
3
+
Copyright (c) 2022 {{author}}
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+58
README.md
+58
README.md
···
1
+
# Rust Repository Template 🦀
2
+
3
+
Repository template to get quickly started with writing Rust libraries, ready for distributing.
4
+
5
+
## Getting started
6
+
7
+
Open your favorite terminal and clone this locally.
8
+
9
+
- With the [GitHub CLI](https://cli.github.com/): Use the command below. Replace `<project>` with what you'd like to call your project.
10
+
```shell
11
+
gh repo create <project> --template neoncitylights/rust
12
+
```
13
+
- With the GitHub UI: You can create a new repository based on this template by clicking the "Use this template" button in the top-right corner of this page.
14
+
15
+
### Replace placeholders
16
+
17
+
Replace the following placeholders with your editor's find-and-replace:
18
+
19
+
- `{{library}}` - The name of the library.
20
+
- `{{desc}}` - The description of the library.
21
+
- `{{author}}` - The author's name of the library. For example, this could be a username, nickname, or real name.
22
+
- `{{email}}` - The author's email address. This is optional and can be deleted.
23
+
24
+
## Features
25
+
26
+
- [x] Remote development support with [GitHub Codespaces](https://github.com/features/codespaces)
27
+
- [x] Fuzz testing with LLVM's [libFuzzer](https://llvm.org/docs/LibFuzzer.html) tool and [`cargo fuzz`](https://github.com/rust-fuzz/cargo-fuzz) ([Reference](https://rust-fuzz.github.io/book/introduction.html))
28
+
- [x] Performance benchmarks in Rust with Criterion and Iai (suitable to run in GitHub Actions CI environments)
29
+
- [x] CI/CD support with [GitHub Actions](https://github.com/features/actions)
30
+
- [x] Running tests and benchmarks
31
+
- [x] Running [Rustfmt](https://github.com/rust-lang/rustfmt) and [Clippy](https://github.com/rust-lang/rust-clippy) for detecting formatting and linting errors, respectively
32
+
- [x] Weekly, midnight scheduled audits of Rust packages (for outdated dependencies, compatible software licenses, and software vulnerabilities) with [`EmbarkStudios/cargo-deny-action`](https://github.com/EmbarkStudios/cargo-deny-action)
33
+
34
+
## Configure
35
+
36
+
| Tool | File path | Reference |
37
+
|--------------------------|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
38
+
| GitHub Codespaces | [`devcontainer.json`](./.devcontainer/devcontainer.json) | [Reference](https://containers.dev/implementors/json_reference/) |
39
+
| GitHub Actions | [`.github/workflows`](./.github/workflows) | [Reference](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) |
40
+
| Cargo package | [`Cargo.toml`](crates/pkg1/Cargo.toml) | [Reference](https://doc.rust-lang.org/cargo/reference/manifest.html) |
41
+
| Clippy (Rust linter) | [`.clippy.toml`](./.clippy.toml) | [Repository](https://github.com/rust-lang/rust-clippy), [Reference]( https://rust-lang.github.io/rust-clippy/) |
42
+
| Rustfmt (Rust formatter) | [`.rustfmt.toml`](./.rustfmt.toml) | [Repository](https://github.com/rust-lang/rustfmt), [Reference](https://rust-lang.github.io/rustfmt/) |
43
+
| `cargo-deny` | [`deny.toml`](./deny.toml) | [Repository](https://github.com/EmbarkStudios/cargo-deny) |
44
+
45
+
## Run scripts locally
46
+
47
+
| Script | Command |
48
+
|-------------|---------|
49
+
| Run unit/integration/doc tests | `cargo test` |
50
+
| Run fuzz tests | `cargo fuzz <fuzz-target>` |
51
+
| Run Rustfmt | `cargo fmt` |
52
+
| Run Clippy | `cargo clippy` |
53
+
| Run performance benchmarks | `cargo bench` |
54
+
| Generate API docs for crate | `cargo doc` |
55
+
| Generate mdBook docs for crate | `mdbook build` |
56
+
| Run security audits | `cargo audit`[^cargo-audit] |
57
+
58
+
[^cargo-audit]: Requires installing [`cargo-audit`](https://crates.io/crates/cargo-audit) locally
+5
crates/pkg1/CHANGELOG.md
+5
crates/pkg1/CHANGELOG.md
+34
crates/pkg1/Cargo.toml
+34
crates/pkg1/Cargo.toml
···
1
+
[package]
2
+
name = "rust-template"
3
+
version = "0.1.0"
4
+
authors = [
5
+
"{{author}} <{{email}}>"
6
+
]
7
+
description = "{{desc}}"
8
+
readme = "README.md"
9
+
license = "MIT OR Apache-2.0"
10
+
edition = "2021"
11
+
rust-version = "1.70.0"
12
+
# keywords = []
13
+
# categories = []
14
+
exclude = [
15
+
"fuzz",
16
+
"book",
17
+
"benches",
18
+
]
19
+
20
+
# [dev-dependencies]
21
+
# criterion = { version = "0.5.1", features = ["html_reports"] }
22
+
# iai = "0.1.0"
23
+
24
+
# # criterion benchmarks
25
+
# [[bench]]
26
+
# path = "benches/criterion/fibb.rs"
27
+
# name = "criterion_fibb"
28
+
# harness = false
29
+
30
+
# # iai benchmarks
31
+
# [[bench]]
32
+
# path = "benches/iai/fibb.rs"
33
+
# name = "iai_fibb"
34
+
# harness = false
+201
crates/pkg1/LICENSE-APACHE
+201
crates/pkg1/LICENSE-APACHE
···
1
+
Apache License
2
+
Version 2.0, January 2004
3
+
http://www.apache.org/licenses/
4
+
5
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+
1. Definitions.
8
+
9
+
"License" shall mean the terms and conditions for use, reproduction,
10
+
and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+
"Licensor" shall mean the copyright owner or entity authorized by
13
+
the copyright owner that is granting the License.
14
+
15
+
"Legal Entity" shall mean the union of the acting entity and all
16
+
other entities that control, are controlled by, or are under common
17
+
control with that entity. For the purposes of this definition,
18
+
"control" means (i) the power, direct or indirect, to cause the
19
+
direction or management of such entity, whether by contract or
20
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+
outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+
"You" (or "Your") shall mean an individual or Legal Entity
24
+
exercising permissions granted by this License.
25
+
26
+
"Source" form shall mean the preferred form for making modifications,
27
+
including but not limited to software source code, documentation
28
+
source, and configuration files.
29
+
30
+
"Object" form shall mean any form resulting from mechanical
31
+
transformation or translation of a Source form, including but
32
+
not limited to compiled object code, generated documentation,
33
+
and conversions to other media types.
34
+
35
+
"Work" shall mean the work of authorship, whether in Source or
36
+
Object form, made available under the License, as indicated by a
37
+
copyright notice that is included in or attached to the work
38
+
(an example is provided in the Appendix below).
39
+
40
+
"Derivative Works" shall mean any work, whether in Source or Object
41
+
form, that is based on (or derived from) the Work and for which the
42
+
editorial revisions, annotations, elaborations, or other modifications
43
+
represent, as a whole, an original work of authorship. For the purposes
44
+
of this License, Derivative Works shall not include works that remain
45
+
separable from, or merely link (or bind by name) to the interfaces of,
46
+
the Work and Derivative Works thereof.
47
+
48
+
"Contribution" shall mean any work of authorship, including
49
+
the original version of the Work and any modifications or additions
50
+
to that Work or Derivative Works thereof, that is intentionally
51
+
submitted to Licensor for inclusion in the Work by the copyright owner
52
+
or by an individual or Legal Entity authorized to submit on behalf of
53
+
the copyright owner. For the purposes of this definition, "submitted"
54
+
means any form of electronic, verbal, or written communication sent
55
+
to the Licensor or its representatives, including but not limited to
56
+
communication on electronic mailing lists, source code control systems,
57
+
and issue tracking systems that are managed by, or on behalf of, the
58
+
Licensor for the purpose of discussing and improving the Work, but
59
+
excluding communication that is conspicuously marked or otherwise
60
+
designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+
"Contributor" shall mean Licensor and any individual or Legal Entity
63
+
on behalf of whom a Contribution has been received by Licensor and
64
+
subsequently incorporated within the Work.
65
+
66
+
2. Grant of Copyright License. Subject to the terms and conditions of
67
+
this License, each Contributor hereby grants to You a perpetual,
68
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+
copyright license to reproduce, prepare Derivative Works of,
70
+
publicly display, publicly perform, sublicense, and distribute the
71
+
Work and such Derivative Works in Source or Object form.
72
+
73
+
3. Grant of Patent License. Subject to the terms and conditions of
74
+
this License, each Contributor hereby grants to You a perpetual,
75
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+
(except as stated in this section) patent license to make, have made,
77
+
use, offer to sell, sell, import, and otherwise transfer the Work,
78
+
where such license applies only to those patent claims licensable
79
+
by such Contributor that are necessarily infringed by their
80
+
Contribution(s) alone or by combination of their Contribution(s)
81
+
with the Work to which such Contribution(s) was submitted. If You
82
+
institute patent litigation against any entity (including a
83
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+
or a Contribution incorporated within the Work constitutes direct
85
+
or contributory patent infringement, then any patent licenses
86
+
granted to You under this License for that Work shall terminate
87
+
as of the date such litigation is filed.
88
+
89
+
4. Redistribution. You may reproduce and distribute copies of the
90
+
Work or Derivative Works thereof in any medium, with or without
91
+
modifications, and in Source or Object form, provided that You
92
+
meet the following conditions:
93
+
94
+
(a) You must give any other recipients of the Work or
95
+
Derivative Works a copy of this License; and
96
+
97
+
(b) You must cause any modified files to carry prominent notices
98
+
stating that You changed the files; and
99
+
100
+
(c) You must retain, in the Source form of any Derivative Works
101
+
that You distribute, all copyright, patent, trademark, and
102
+
attribution notices from the Source form of the Work,
103
+
excluding those notices that do not pertain to any part of
104
+
the Derivative Works; and
105
+
106
+
(d) If the Work includes a "NOTICE" text file as part of its
107
+
distribution, then any Derivative Works that You distribute must
108
+
include a readable copy of the attribution notices contained
109
+
within such NOTICE file, excluding those notices that do not
110
+
pertain to any part of the Derivative Works, in at least one
111
+
of the following places: within a NOTICE text file distributed
112
+
as part of the Derivative Works; within the Source form or
113
+
documentation, if provided along with the Derivative Works; or,
114
+
within a display generated by the Derivative Works, if and
115
+
wherever such third-party notices normally appear. The contents
116
+
of the NOTICE file are for informational purposes only and
117
+
do not modify the License. You may add Your own attribution
118
+
notices within Derivative Works that You distribute, alongside
119
+
or as an addendum to the NOTICE text from the Work, provided
120
+
that such additional attribution notices cannot be construed
121
+
as modifying the License.
122
+
123
+
You may add Your own copyright statement to Your modifications and
124
+
may provide additional or different license terms and conditions
125
+
for use, reproduction, or distribution of Your modifications, or
126
+
for any such Derivative Works as a whole, provided Your use,
127
+
reproduction, and distribution of the Work otherwise complies with
128
+
the conditions stated in this License.
129
+
130
+
5. Submission of Contributions. Unless You explicitly state otherwise,
131
+
any Contribution intentionally submitted for inclusion in the Work
132
+
by You to the Licensor shall be under the terms and conditions of
133
+
this License, without any additional terms or conditions.
134
+
Notwithstanding the above, nothing herein shall supersede or modify
135
+
the terms of any separate license agreement you may have executed
136
+
with Licensor regarding such Contributions.
137
+
138
+
6. Trademarks. This License does not grant permission to use the trade
139
+
names, trademarks, service marks, or product names of the Licensor,
140
+
except as required for reasonable and customary use in describing the
141
+
origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+
7. Disclaimer of Warranty. Unless required by applicable law or
144
+
agreed to in writing, Licensor provides the Work (and each
145
+
Contributor provides its Contributions) on an "AS IS" BASIS,
146
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+
implied, including, without limitation, any warranties or conditions
148
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+
PARTICULAR PURPOSE. You are solely responsible for determining the
150
+
appropriateness of using or redistributing the Work and assume any
151
+
risks associated with Your exercise of permissions under this License.
152
+
153
+
8. Limitation of Liability. In no event and under no legal theory,
154
+
whether in tort (including negligence), contract, or otherwise,
155
+
unless required by applicable law (such as deliberate and grossly
156
+
negligent acts) or agreed to in writing, shall any Contributor be
157
+
liable to You for damages, including any direct, indirect, special,
158
+
incidental, or consequential damages of any character arising as a
159
+
result of this License or out of the use or inability to use the
160
+
Work (including but not limited to damages for loss of goodwill,
161
+
work stoppage, computer failure or malfunction, or any and all
162
+
other commercial damages or losses), even if such Contributor
163
+
has been advised of the possibility of such damages.
164
+
165
+
9. Accepting Warranty or Additional Liability. While redistributing
166
+
the Work or Derivative Works thereof, You may choose to offer,
167
+
and charge a fee for, acceptance of support, warranty, indemnity,
168
+
or other liability obligations and/or rights consistent with this
169
+
License. However, in accepting such obligations, You may act only
170
+
on Your own behalf and on Your sole responsibility, not on behalf
171
+
of any other Contributor, and only if You agree to indemnify,
172
+
defend, and hold each Contributor harmless for any liability
173
+
incurred by, or claims asserted against, such Contributor by reason
174
+
of your accepting any such warranty or additional liability.
175
+
176
+
END OF TERMS AND CONDITIONS
177
+
178
+
APPENDIX: How to apply the Apache License to your work.
179
+
180
+
To apply the Apache License to your work, attach the following
181
+
boilerplate notice, with the fields enclosed by brackets "[]"
182
+
replaced with your own identifying information. (Don't include
183
+
the brackets!) The text should be enclosed in the appropriate
184
+
comment syntax for the file format. We also recommend that a
185
+
file or class name and description of purpose be included on the
186
+
same "printed page" as the copyright notice for easier
187
+
identification within third-party archives.
188
+
189
+
Copyright 2022 [name of copyright owner]
190
+
191
+
Licensed under the Apache License, Version 2.0 (the "License");
192
+
you may not use this file except in compliance with the License.
193
+
You may obtain a copy of the License at
194
+
195
+
http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+
Unless required by applicable law or agreed to in writing, software
198
+
distributed under the License is distributed on an "AS IS" BASIS,
199
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+
See the License for the specific language governing permissions and
201
+
limitations under the License.
+21
crates/pkg1/LICENSE-MIT
+21
crates/pkg1/LICENSE-MIT
···
1
+
MIT License
2
+
3
+
Copyright (c) 2022 {{author}}
4
+
5
+
Permission is hereby granted, free of charge, to any person obtaining a copy
6
+
of this software and associated documentation files (the "Software"), to deal
7
+
in the Software without restriction, including without limitation the rights
8
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+
copies of the Software, and to permit persons to whom the Software is
10
+
furnished to do so, subject to the following conditions:
11
+
12
+
The above copyright notice and this permission notice shall be included in all
13
+
copies or substantial portions of the Software.
14
+
15
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+
SOFTWARE.
+27
crates/pkg1/README.md
+27
crates/pkg1/README.md
···
1
+
# {{library}}
2
+
3
+
[](#license)
4
+
[](https://github.com/neoncitylights/rust/actions/workflows/main.yml)
5
+
[](https://github.com/neoncitylights/rust/actions/workflows/security-audit.yml)
6
+
[](https://codecov.io/gh/neoncitylights/rust)
7
+
8
+
{{desc}}
9
+
10
+
## Install
11
+
12
+
```shell
13
+
cargo add {{library}}
14
+
```
15
+
16
+
## License
17
+
18
+
Licensed under either of
19
+
20
+
- Apache License, Version 2.0 ([`LICENSE-APACHE`](LICENSE-APACHE) or <http://www.apache.org/licenses/LICENSE-2.0>)
21
+
- MIT license ([`LICENSE-MIT`](LICENSE-MIT) or <http://opensource.org/licenses/MIT>)
22
+
23
+
at your option.
24
+
25
+
### Contribution
26
+
27
+
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
+17
crates/pkg1/benches/criterion/fibb.rs
+17
crates/pkg1/benches/criterion/fibb.rs
···
1
+
use criterion::{black_box, criterion_group, criterion_main, Criterion};
2
+
3
+
#[inline]
4
+
fn fibonacci(n: u64) -> u64 {
5
+
match n {
6
+
0 => 1,
7
+
1 => 1,
8
+
n => fibonacci(n - 1) + fibonacci(n - 2),
9
+
}
10
+
}
11
+
12
+
pub fn criterion_benchmark(c: &mut Criterion) {
13
+
c.bench_function("fib 20", |b| b.iter(|| fibonacci(black_box(20))));
14
+
}
15
+
16
+
criterion_group!(benches, criterion_benchmark);
17
+
criterion_main!(benches);
+19
crates/pkg1/benches/iai/fibb.rs
+19
crates/pkg1/benches/iai/fibb.rs
···
1
+
use iai::{black_box, main};
2
+
3
+
fn fibonacci(n: u64) -> u64 {
4
+
match n {
5
+
0 => 1,
6
+
1 => 1,
7
+
n => fibonacci(n - 1) + fibonacci(n - 2),
8
+
}
9
+
}
10
+
11
+
fn iai_benchmark_short() -> u64 {
12
+
fibonacci(black_box(10))
13
+
}
14
+
15
+
fn iai_benchmark_long() -> u64 {
16
+
fibonacci(black_box(30))
17
+
}
18
+
19
+
main!(iai_benchmark_short, iai_benchmark_long);
+17
crates/pkg1/book/.markdownlint.json
+17
crates/pkg1/book/.markdownlint.json
+19
crates/pkg1/book/book.toml
+19
crates/pkg1/book/book.toml
···
1
+
[book]
2
+
title = "Markdown Book"
3
+
authors = ["Samantha"]
4
+
language = "en"
5
+
multilingual = false
6
+
src = "src"
7
+
8
+
[build]
9
+
create-missing = false
10
+
11
+
[rust]
12
+
edition = "2021"
13
+
14
+
[output.html]
15
+
git-repository-url = "https://github.com/neoncitylights/rust"
16
+
17
+
[output.katex]
18
+
[preprocessor.katex]
19
+
trust = true
+629
crates/pkg1/book/package-lock.json
+629
crates/pkg1/book/package-lock.json
···
1
+
{
2
+
"name": "book",
3
+
"lockfileVersion": 3,
4
+
"requires": true,
5
+
"packages": {
6
+
"": {
7
+
"dependencies": {
8
+
"markdownlint-cli": "0.37.0"
9
+
}
10
+
},
11
+
"node_modules/@isaacs/cliui": {
12
+
"version": "8.0.2",
13
+
"resolved": "https://registry.npmjs.org/@isaacs/cliui/-/cliui-8.0.2.tgz",
14
+
"integrity": "sha512-O8jcjabXaleOG9DQ0+ARXWZBTfnP4WNAqzuiJK7ll44AmxGKv/J2M4TPjxjY3znBCfvBXFzucm1twdyFybFqEA==",
15
+
"dependencies": {
16
+
"string-width": "^5.1.2",
17
+
"string-width-cjs": "npm:string-width@^4.2.0",
18
+
"strip-ansi": "^7.0.1",
19
+
"strip-ansi-cjs": "npm:strip-ansi@^6.0.1",
20
+
"wrap-ansi": "^8.1.0",
21
+
"wrap-ansi-cjs": "npm:wrap-ansi@^7.0.0"
22
+
},
23
+
"engines": {
24
+
"node": ">=12"
25
+
}
26
+
},
27
+
"node_modules/@pkgjs/parseargs": {
28
+
"version": "0.11.0",
29
+
"resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz",
30
+
"integrity": "sha512-+1VkjdD0QBLPodGrJUeqarH8VAIvQODIbwh9XpP5Syisf7YoQgsJKPNFoqqLQlu+VQ/tVSshMR6loPMn8U+dPg==",
31
+
"optional": true,
32
+
"engines": {
33
+
"node": ">=14"
34
+
}
35
+
},
36
+
"node_modules/ansi-regex": {
37
+
"version": "6.0.1",
38
+
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-6.0.1.tgz",
39
+
"integrity": "sha512-n5M855fKb2SsfMIiFFoVrABHJC8QtHwVx+mHWP3QcEqBHYienj5dHSgjbxtC0WEZXYt4wcD6zrQElDPhFuZgfA==",
40
+
"engines": {
41
+
"node": ">=12"
42
+
},
43
+
"funding": {
44
+
"url": "https://github.com/chalk/ansi-regex?sponsor=1"
45
+
}
46
+
},
47
+
"node_modules/ansi-styles": {
48
+
"version": "6.2.1",
49
+
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-6.2.1.tgz",
50
+
"integrity": "sha512-bN798gFfQX+viw3R7yrGWRqnrN2oRkEkUjjl4JNn4E8GxxbjtG3FbrEIIY3l8/hrwUwIeCZvi4QuOTP4MErVug==",
51
+
"engines": {
52
+
"node": ">=12"
53
+
},
54
+
"funding": {
55
+
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
56
+
}
57
+
},
58
+
"node_modules/argparse": {
59
+
"version": "2.0.1",
60
+
"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
61
+
"integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q=="
62
+
},
63
+
"node_modules/balanced-match": {
64
+
"version": "1.0.2",
65
+
"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
66
+
"integrity": "sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw=="
67
+
},
68
+
"node_modules/brace-expansion": {
69
+
"version": "2.0.1",
70
+
"resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-2.0.1.tgz",
71
+
"integrity": "sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==",
72
+
"dependencies": {
73
+
"balanced-match": "^1.0.0"
74
+
}
75
+
},
76
+
"node_modules/color-convert": {
77
+
"version": "2.0.1",
78
+
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz",
79
+
"integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==",
80
+
"dependencies": {
81
+
"color-name": "~1.1.4"
82
+
},
83
+
"engines": {
84
+
"node": ">=7.0.0"
85
+
}
86
+
},
87
+
"node_modules/color-name": {
88
+
"version": "1.1.4",
89
+
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz",
90
+
"integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA=="
91
+
},
92
+
"node_modules/commander": {
93
+
"version": "11.0.0",
94
+
"resolved": "https://registry.npmjs.org/commander/-/commander-11.0.0.tgz",
95
+
"integrity": "sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==",
96
+
"engines": {
97
+
"node": ">=16"
98
+
}
99
+
},
100
+
"node_modules/cross-spawn": {
101
+
"version": "7.0.3",
102
+
"resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.3.tgz",
103
+
"integrity": "sha512-iRDPJKUPVEND7dHPO8rkbOnPpyDygcDFtWjpeWNCgy8WP2rXcxXL8TskReQl6OrB2G7+UJrags1q15Fudc7G6w==",
104
+
"dependencies": {
105
+
"path-key": "^3.1.0",
106
+
"shebang-command": "^2.0.0",
107
+
"which": "^2.0.1"
108
+
},
109
+
"engines": {
110
+
"node": ">= 8"
111
+
}
112
+
},
113
+
"node_modules/deep-extend": {
114
+
"version": "0.6.0",
115
+
"resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz",
116
+
"integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==",
117
+
"engines": {
118
+
"node": ">=4.0.0"
119
+
}
120
+
},
121
+
"node_modules/eastasianwidth": {
122
+
"version": "0.2.0",
123
+
"resolved": "https://registry.npmjs.org/eastasianwidth/-/eastasianwidth-0.2.0.tgz",
124
+
"integrity": "sha512-I88TYZWc9XiYHRQ4/3c5rjjfgkjhLyW2luGIheGERbNQ6OY7yTybanSpDXZa8y7VUP9YmDcYa+eyq4ca7iLqWA=="
125
+
},
126
+
"node_modules/emoji-regex": {
127
+
"version": "9.2.2",
128
+
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-9.2.2.tgz",
129
+
"integrity": "sha512-L18DaJsXSUk2+42pv8mLs5jJT2hqFkFE4j21wOmgbUqsZ2hL72NsUU785g9RXgo3s0ZNgVl42TiHp3ZtOv/Vyg=="
130
+
},
131
+
"node_modules/entities": {
132
+
"version": "3.0.1",
133
+
"resolved": "https://registry.npmjs.org/entities/-/entities-3.0.1.tgz",
134
+
"integrity": "sha512-WiyBqoomrwMdFG1e0kqvASYfnlb0lp8M5o5Fw2OFq1hNZxxcNk8Ik0Xm7LxzBhuidnZB/UtBqVCgUz3kBOP51Q==",
135
+
"engines": {
136
+
"node": ">=0.12"
137
+
},
138
+
"funding": {
139
+
"url": "https://github.com/fb55/entities?sponsor=1"
140
+
}
141
+
},
142
+
"node_modules/foreground-child": {
143
+
"version": "3.1.1",
144
+
"resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.1.1.tgz",
145
+
"integrity": "sha512-TMKDUnIte6bfb5nWv7V/caI169OHgvwjb7V4WkeUvbQQdjr5rWKqHFiKWb/fcOwB+CzBT+qbWjvj+DVwRskpIg==",
146
+
"dependencies": {
147
+
"cross-spawn": "^7.0.0",
148
+
"signal-exit": "^4.0.1"
149
+
},
150
+
"engines": {
151
+
"node": ">=14"
152
+
},
153
+
"funding": {
154
+
"url": "https://github.com/sponsors/isaacs"
155
+
}
156
+
},
157
+
"node_modules/get-stdin": {
158
+
"version": "9.0.0",
159
+
"resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-9.0.0.tgz",
160
+
"integrity": "sha512-dVKBjfWisLAicarI2Sf+JuBE/DghV4UzNAVe9yhEJuzeREd3JhOTE9cUaJTeSa77fsbQUK3pcOpJfM59+VKZaA==",
161
+
"engines": {
162
+
"node": ">=12"
163
+
},
164
+
"funding": {
165
+
"url": "https://github.com/sponsors/sindresorhus"
166
+
}
167
+
},
168
+
"node_modules/glob": {
169
+
"version": "10.3.10",
170
+
"resolved": "https://registry.npmjs.org/glob/-/glob-10.3.10.tgz",
171
+
"integrity": "sha512-fa46+tv1Ak0UPK1TOy/pZrIybNNt4HCv7SDzwyfiOZkvZLEbjsZkJBPtDHVshZjbecAoAGSC20MjLDG/qr679g==",
172
+
"dependencies": {
173
+
"foreground-child": "^3.1.0",
174
+
"jackspeak": "^2.3.5",
175
+
"minimatch": "^9.0.1",
176
+
"minipass": "^5.0.0 || ^6.0.2 || ^7.0.0",
177
+
"path-scurry": "^1.10.1"
178
+
},
179
+
"bin": {
180
+
"glob": "dist/esm/bin.mjs"
181
+
},
182
+
"engines": {
183
+
"node": ">=16 || 14 >=14.17"
184
+
},
185
+
"funding": {
186
+
"url": "https://github.com/sponsors/isaacs"
187
+
}
188
+
},
189
+
"node_modules/ignore": {
190
+
"version": "5.2.4",
191
+
"resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz",
192
+
"integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==",
193
+
"engines": {
194
+
"node": ">= 4"
195
+
}
196
+
},
197
+
"node_modules/ini": {
198
+
"version": "4.1.1",
199
+
"resolved": "https://registry.npmjs.org/ini/-/ini-4.1.1.tgz",
200
+
"integrity": "sha512-QQnnxNyfvmHFIsj7gkPcYymR8Jdw/o7mp5ZFihxn6h8Ci6fh3Dx4E1gPjpQEpIuPo9XVNY/ZUwh4BPMjGyL01g==",
201
+
"engines": {
202
+
"node": "^14.17.0 || ^16.13.0 || >=18.0.0"
203
+
}
204
+
},
205
+
"node_modules/is-fullwidth-code-point": {
206
+
"version": "3.0.0",
207
+
"resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz",
208
+
"integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==",
209
+
"engines": {
210
+
"node": ">=8"
211
+
}
212
+
},
213
+
"node_modules/isexe": {
214
+
"version": "2.0.0",
215
+
"resolved": "https://registry.npmjs.org/isexe/-/isexe-2.0.0.tgz",
216
+
"integrity": "sha512-RHxMLp9lnKHGHRng9QFhRCMbYAcVpn69smSGcq3f36xjgVVWThj4qqLbTLlq7Ssj8B+fIQ1EuCEGI2lKsyQeIw=="
217
+
},
218
+
"node_modules/jackspeak": {
219
+
"version": "2.3.6",
220
+
"resolved": "https://registry.npmjs.org/jackspeak/-/jackspeak-2.3.6.tgz",
221
+
"integrity": "sha512-N3yCS/NegsOBokc8GAdM8UcmfsKiSS8cipheD/nivzr700H+nsMOxJjQnvwOcRYVuFkdH0wGUvW2WbXGmrZGbQ==",
222
+
"dependencies": {
223
+
"@isaacs/cliui": "^8.0.2"
224
+
},
225
+
"engines": {
226
+
"node": ">=14"
227
+
},
228
+
"funding": {
229
+
"url": "https://github.com/sponsors/isaacs"
230
+
},
231
+
"optionalDependencies": {
232
+
"@pkgjs/parseargs": "^0.11.0"
233
+
}
234
+
},
235
+
"node_modules/js-yaml": {
236
+
"version": "4.1.0",
237
+
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz",
238
+
"integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==",
239
+
"dependencies": {
240
+
"argparse": "^2.0.1"
241
+
},
242
+
"bin": {
243
+
"js-yaml": "bin/js-yaml.js"
244
+
}
245
+
},
246
+
"node_modules/jsonc-parser": {
247
+
"version": "3.2.0",
248
+
"resolved": "https://registry.npmjs.org/jsonc-parser/-/jsonc-parser-3.2.0.tgz",
249
+
"integrity": "sha512-gfFQZrcTc8CnKXp6Y4/CBT3fTc0OVuDofpre4aEeEpSBPV5X5v4+Vmx+8snU7RLPrNHPKSgLxGo9YuQzz20o+w=="
250
+
},
251
+
"node_modules/linkify-it": {
252
+
"version": "4.0.1",
253
+
"resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-4.0.1.tgz",
254
+
"integrity": "sha512-C7bfi1UZmoj8+PQx22XyeXCuBlokoyWQL5pWSP+EI6nzRylyThouddufc2c1NDIcP9k5agmN9fLpA7VNJfIiqw==",
255
+
"dependencies": {
256
+
"uc.micro": "^1.0.1"
257
+
}
258
+
},
259
+
"node_modules/lru-cache": {
260
+
"version": "10.1.0",
261
+
"resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-10.1.0.tgz",
262
+
"integrity": "sha512-/1clY/ui8CzjKFyjdvwPWJUYKiFVXG2I2cY0ssG7h4+hwk+XOIX7ZSG9Q7TW8TW3Kp3BUSqgFWBLgL4PJ+Blag==",
263
+
"engines": {
264
+
"node": "14 || >=16.14"
265
+
}
266
+
},
267
+
"node_modules/markdown-it": {
268
+
"version": "13.0.1",
269
+
"resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-13.0.1.tgz",
270
+
"integrity": "sha512-lTlxriVoy2criHP0JKRhO2VDG9c2ypWCsT237eDiLqi09rmbKoUetyGHq2uOIRoRS//kfoJckS0eUzzkDR+k2Q==",
271
+
"dependencies": {
272
+
"argparse": "^2.0.1",
273
+
"entities": "~3.0.1",
274
+
"linkify-it": "^4.0.1",
275
+
"mdurl": "^1.0.1",
276
+
"uc.micro": "^1.0.5"
277
+
},
278
+
"bin": {
279
+
"markdown-it": "bin/markdown-it.js"
280
+
}
281
+
},
282
+
"node_modules/markdownlint": {
283
+
"version": "0.31.1",
284
+
"resolved": "https://registry.npmjs.org/markdownlint/-/markdownlint-0.31.1.tgz",
285
+
"integrity": "sha512-CKMR2hgcIBrYlIUccDCOvi966PZ0kJExDrUi1R+oF9PvqQmCrTqjOsgIvf2403OmJ+CWomuzDoylr6KbuMyvHA==",
286
+
"dependencies": {
287
+
"markdown-it": "13.0.1",
288
+
"markdownlint-micromark": "0.1.7"
289
+
},
290
+
"engines": {
291
+
"node": ">=16"
292
+
}
293
+
},
294
+
"node_modules/markdownlint-cli": {
295
+
"version": "0.37.0",
296
+
"resolved": "https://registry.npmjs.org/markdownlint-cli/-/markdownlint-cli-0.37.0.tgz",
297
+
"integrity": "sha512-hNKAc0bWBBuVhJbSWbUhRzavstiB4o1jh3JeSpwC4/dt6eJ54lRfYHRxVdzVp4qGWBKbeE6Pg490PFEfrKjqSg==",
298
+
"dependencies": {
299
+
"commander": "~11.0.0",
300
+
"get-stdin": "~9.0.0",
301
+
"glob": "~10.3.4",
302
+
"ignore": "~5.2.4",
303
+
"js-yaml": "^4.1.0",
304
+
"jsonc-parser": "~3.2.0",
305
+
"markdownlint": "~0.31.1",
306
+
"minimatch": "~9.0.3",
307
+
"run-con": "~1.3.2"
308
+
},
309
+
"bin": {
310
+
"markdownlint": "markdownlint.js"
311
+
},
312
+
"engines": {
313
+
"node": ">=16"
314
+
}
315
+
},
316
+
"node_modules/markdownlint-micromark": {
317
+
"version": "0.1.7",
318
+
"resolved": "https://registry.npmjs.org/markdownlint-micromark/-/markdownlint-micromark-0.1.7.tgz",
319
+
"integrity": "sha512-BbRPTC72fl5vlSKv37v/xIENSRDYL/7X/XoFzZ740FGEbs9vZerLrIkFRY0rv7slQKxDczToYuMmqQFN61fi4Q==",
320
+
"engines": {
321
+
"node": ">=16"
322
+
}
323
+
},
324
+
"node_modules/mdurl": {
325
+
"version": "1.0.1",
326
+
"resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz",
327
+
"integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g=="
328
+
},
329
+
"node_modules/minimatch": {
330
+
"version": "9.0.3",
331
+
"resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.3.tgz",
332
+
"integrity": "sha512-RHiac9mvaRw0x3AYRgDC1CxAP7HTcNrrECeA8YYJeWnpo+2Q5CegtZjaotWTWxDG3UeGA1coE05iH1mPjT/2mg==",
333
+
"dependencies": {
334
+
"brace-expansion": "^2.0.1"
335
+
},
336
+
"engines": {
337
+
"node": ">=16 || 14 >=14.17"
338
+
},
339
+
"funding": {
340
+
"url": "https://github.com/sponsors/isaacs"
341
+
}
342
+
},
343
+
"node_modules/minimist": {
344
+
"version": "1.2.8",
345
+
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
346
+
"integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
347
+
"funding": {
348
+
"url": "https://github.com/sponsors/ljharb"
349
+
}
350
+
},
351
+
"node_modules/minipass": {
352
+
"version": "7.0.4",
353
+
"resolved": "https://registry.npmjs.org/minipass/-/minipass-7.0.4.tgz",
354
+
"integrity": "sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==",
355
+
"engines": {
356
+
"node": ">=16 || 14 >=14.17"
357
+
}
358
+
},
359
+
"node_modules/path-key": {
360
+
"version": "3.1.1",
361
+
"resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz",
362
+
"integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==",
363
+
"engines": {
364
+
"node": ">=8"
365
+
}
366
+
},
367
+
"node_modules/path-scurry": {
368
+
"version": "1.10.1",
369
+
"resolved": "https://registry.npmjs.org/path-scurry/-/path-scurry-1.10.1.tgz",
370
+
"integrity": "sha512-MkhCqzzBEpPvxxQ71Md0b1Kk51W01lrYvlMzSUaIzNsODdd7mqhiimSZlr+VegAz5Z6Vzt9Xg2ttE//XBhH3EQ==",
371
+
"dependencies": {
372
+
"lru-cache": "^9.1.1 || ^10.0.0",
373
+
"minipass": "^5.0.0 || ^6.0.2 || ^7.0.0"
374
+
},
375
+
"engines": {
376
+
"node": ">=16 || 14 >=14.17"
377
+
},
378
+
"funding": {
379
+
"url": "https://github.com/sponsors/isaacs"
380
+
}
381
+
},
382
+
"node_modules/run-con": {
383
+
"version": "1.3.2",
384
+
"resolved": "https://registry.npmjs.org/run-con/-/run-con-1.3.2.tgz",
385
+
"integrity": "sha512-CcfE+mYiTcKEzg0IqS08+efdnH0oJ3zV0wSUFBNrMHMuxCtXvBCLzCJHatwuXDcu/RlhjTziTo/a1ruQik6/Yg==",
386
+
"dependencies": {
387
+
"deep-extend": "^0.6.0",
388
+
"ini": "~4.1.0",
389
+
"minimist": "^1.2.8",
390
+
"strip-json-comments": "~3.1.1"
391
+
},
392
+
"bin": {
393
+
"run-con": "cli.js"
394
+
}
395
+
},
396
+
"node_modules/shebang-command": {
397
+
"version": "2.0.0",
398
+
"resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz",
399
+
"integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==",
400
+
"dependencies": {
401
+
"shebang-regex": "^3.0.0"
402
+
},
403
+
"engines": {
404
+
"node": ">=8"
405
+
}
406
+
},
407
+
"node_modules/shebang-regex": {
408
+
"version": "3.0.0",
409
+
"resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz",
410
+
"integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==",
411
+
"engines": {
412
+
"node": ">=8"
413
+
}
414
+
},
415
+
"node_modules/signal-exit": {
416
+
"version": "4.1.0",
417
+
"resolved": "https://registry.npmjs.org/signal-exit/-/signal-exit-4.1.0.tgz",
418
+
"integrity": "sha512-bzyZ1e88w9O1iNJbKnOlvYTrWPDl46O1bG0D3XInv+9tkPrxrN8jUUTiFlDkkmKWgn1M6CfIA13SuGqOa9Korw==",
419
+
"engines": {
420
+
"node": ">=14"
421
+
},
422
+
"funding": {
423
+
"url": "https://github.com/sponsors/isaacs"
424
+
}
425
+
},
426
+
"node_modules/string-width": {
427
+
"version": "5.1.2",
428
+
"resolved": "https://registry.npmjs.org/string-width/-/string-width-5.1.2.tgz",
429
+
"integrity": "sha512-HnLOCR3vjcY8beoNLtcjZ5/nxn2afmME6lhrDrebokqMap+XbeW8n9TXpPDOqdGK5qcI3oT0GKTW6wC7EMiVqA==",
430
+
"dependencies": {
431
+
"eastasianwidth": "^0.2.0",
432
+
"emoji-regex": "^9.2.2",
433
+
"strip-ansi": "^7.0.1"
434
+
},
435
+
"engines": {
436
+
"node": ">=12"
437
+
},
438
+
"funding": {
439
+
"url": "https://github.com/sponsors/sindresorhus"
440
+
}
441
+
},
442
+
"node_modules/string-width-cjs": {
443
+
"name": "string-width",
444
+
"version": "4.2.3",
445
+
"resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
446
+
"integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
447
+
"dependencies": {
448
+
"emoji-regex": "^8.0.0",
449
+
"is-fullwidth-code-point": "^3.0.0",
450
+
"strip-ansi": "^6.0.1"
451
+
},
452
+
"engines": {
453
+
"node": ">=8"
454
+
}
455
+
},
456
+
"node_modules/string-width-cjs/node_modules/ansi-regex": {
457
+
"version": "5.0.1",
458
+
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
459
+
"integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
460
+
"engines": {
461
+
"node": ">=8"
462
+
}
463
+
},
464
+
"node_modules/string-width-cjs/node_modules/emoji-regex": {
465
+
"version": "8.0.0",
466
+
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
467
+
"integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
468
+
},
469
+
"node_modules/string-width-cjs/node_modules/strip-ansi": {
470
+
"version": "6.0.1",
471
+
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
472
+
"integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
473
+
"dependencies": {
474
+
"ansi-regex": "^5.0.1"
475
+
},
476
+
"engines": {
477
+
"node": ">=8"
478
+
}
479
+
},
480
+
"node_modules/strip-ansi": {
481
+
"version": "7.1.0",
482
+
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-7.1.0.tgz",
483
+
"integrity": "sha512-iq6eVVI64nQQTRYq2KtEg2d2uU7LElhTJwsH4YzIHZshxlgZms/wIc4VoDQTlG/IvVIrBKG06CrZnp0qv7hkcQ==",
484
+
"dependencies": {
485
+
"ansi-regex": "^6.0.1"
486
+
},
487
+
"engines": {
488
+
"node": ">=12"
489
+
},
490
+
"funding": {
491
+
"url": "https://github.com/chalk/strip-ansi?sponsor=1"
492
+
}
493
+
},
494
+
"node_modules/strip-ansi-cjs": {
495
+
"name": "strip-ansi",
496
+
"version": "6.0.1",
497
+
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
498
+
"integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
499
+
"dependencies": {
500
+
"ansi-regex": "^5.0.1"
501
+
},
502
+
"engines": {
503
+
"node": ">=8"
504
+
}
505
+
},
506
+
"node_modules/strip-ansi-cjs/node_modules/ansi-regex": {
507
+
"version": "5.0.1",
508
+
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
509
+
"integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
510
+
"engines": {
511
+
"node": ">=8"
512
+
}
513
+
},
514
+
"node_modules/strip-json-comments": {
515
+
"version": "3.1.1",
516
+
"resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz",
517
+
"integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==",
518
+
"engines": {
519
+
"node": ">=8"
520
+
},
521
+
"funding": {
522
+
"url": "https://github.com/sponsors/sindresorhus"
523
+
}
524
+
},
525
+
"node_modules/uc.micro": {
526
+
"version": "1.0.6",
527
+
"resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz",
528
+
"integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA=="
529
+
},
530
+
"node_modules/which": {
531
+
"version": "2.0.2",
532
+
"resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
533
+
"integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==",
534
+
"dependencies": {
535
+
"isexe": "^2.0.0"
536
+
},
537
+
"bin": {
538
+
"node-which": "bin/node-which"
539
+
},
540
+
"engines": {
541
+
"node": ">= 8"
542
+
}
543
+
},
544
+
"node_modules/wrap-ansi": {
545
+
"version": "8.1.0",
546
+
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz",
547
+
"integrity": "sha512-si7QWI6zUMq56bESFvagtmzMdGOtoxfR+Sez11Mobfc7tm+VkUckk9bW2UeffTGVUbOksxmSw0AA2gs8g71NCQ==",
548
+
"dependencies": {
549
+
"ansi-styles": "^6.1.0",
550
+
"string-width": "^5.0.1",
551
+
"strip-ansi": "^7.0.1"
552
+
},
553
+
"engines": {
554
+
"node": ">=12"
555
+
},
556
+
"funding": {
557
+
"url": "https://github.com/chalk/wrap-ansi?sponsor=1"
558
+
}
559
+
},
560
+
"node_modules/wrap-ansi-cjs": {
561
+
"name": "wrap-ansi",
562
+
"version": "7.0.0",
563
+
"resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz",
564
+
"integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==",
565
+
"dependencies": {
566
+
"ansi-styles": "^4.0.0",
567
+
"string-width": "^4.1.0",
568
+
"strip-ansi": "^6.0.0"
569
+
},
570
+
"engines": {
571
+
"node": ">=10"
572
+
},
573
+
"funding": {
574
+
"url": "https://github.com/chalk/wrap-ansi?sponsor=1"
575
+
}
576
+
},
577
+
"node_modules/wrap-ansi-cjs/node_modules/ansi-regex": {
578
+
"version": "5.0.1",
579
+
"resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz",
580
+
"integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==",
581
+
"engines": {
582
+
"node": ">=8"
583
+
}
584
+
},
585
+
"node_modules/wrap-ansi-cjs/node_modules/ansi-styles": {
586
+
"version": "4.3.0",
587
+
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz",
588
+
"integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==",
589
+
"dependencies": {
590
+
"color-convert": "^2.0.1"
591
+
},
592
+
"engines": {
593
+
"node": ">=8"
594
+
},
595
+
"funding": {
596
+
"url": "https://github.com/chalk/ansi-styles?sponsor=1"
597
+
}
598
+
},
599
+
"node_modules/wrap-ansi-cjs/node_modules/emoji-regex": {
600
+
"version": "8.0.0",
601
+
"resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz",
602
+
"integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A=="
603
+
},
604
+
"node_modules/wrap-ansi-cjs/node_modules/string-width": {
605
+
"version": "4.2.3",
606
+
"resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz",
607
+
"integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==",
608
+
"dependencies": {
609
+
"emoji-regex": "^8.0.0",
610
+
"is-fullwidth-code-point": "^3.0.0",
611
+
"strip-ansi": "^6.0.1"
612
+
},
613
+
"engines": {
614
+
"node": ">=8"
615
+
}
616
+
},
617
+
"node_modules/wrap-ansi-cjs/node_modules/strip-ansi": {
618
+
"version": "6.0.1",
619
+
"resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz",
620
+
"integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==",
621
+
"dependencies": {
622
+
"ansi-regex": "^5.0.1"
623
+
},
624
+
"engines": {
625
+
"node": ">=8"
626
+
}
627
+
}
628
+
}
629
+
}
+12
crates/pkg1/book/package.json
+12
crates/pkg1/book/package.json
+32
crates/pkg1/book/src/README.md
+32
crates/pkg1/book/src/README.md
···
1
+
# Introduction to Markdown and mdBook
2
+
3
+
Welcome to your documentation site! This site is built using:
4
+
5
+
- **Markdown**: a lightweight markup language for formatting plaintext.
6
+
- **mdBook**: a static site generator for Markdown files, created by Rust.
7
+
8
+
In this repository, you'll see these files:
9
+
10
+
```txt
11
+
src/
12
+
├── README.md
13
+
├── SUMMARY.md
14
+
└── chapter-1.md
15
+
```
16
+
17
+
- `README.md`: This file is the introduction to your book.
18
+
- `SUMMARY.md`: This file lists all the chapters in your books. You can have sub-chapters using sub-bullets.
19
+
- `chapter-1.md`: This is an example Markdown file.
20
+
21
+
## Examples
22
+
23
+
Looking for inspiration of other documentation sites built using mdBook? Try these (not affiliated):
24
+
25
+
- [The Rust Reference](https://doc.rust-lang.org/reference/): An informal handbook describing the syntax, language constructs, and idioms of the Rust programming language.
26
+
- [The Rust Programming Guide](https://doc.rust-lang.org/book/): A detailed guide to learning how to write Rust code.
27
+
- [Rust by Example](https://doc.rust-lang.org/stable/rust-by-example/): A guide of learning how to write Rust, using examples.
28
+
- [Learn Rust With Entirely Too Many Linked Lists](https://rust-unofficial.github.io/too-many-lists/): A different approach to learning Rust and it's memory-safety using a data structure known as a *linked list*.
29
+
- [Rust and WebAssembly](https://rustwasm.github.io/docs/book/): A guide on how to write Rust code for the WebAssembly runtime.
30
+
31
+
- [Amethyst](https://book.amethyst.rs/book/stable/): A game engine written in Rust, developed by the Amethyst team and open-source community.
32
+
- [Void Linux Handbook](https://docs.voidlinux.org/): A guide on how to use the Void Linux operating system.
+8
crates/pkg1/book/src/SUMMARY.md
+8
crates/pkg1/book/src/SUMMARY.md
+49
crates/pkg1/book/src/chapter-1.md
+49
crates/pkg1/book/src/chapter-1.md
···
1
+
# Chapter 1
2
+
3
+
We then sought for Alexander, but were unable to find him. One of his neighbors, who did not seem to bear him any affection, said that he had gone away two days before, no one knew whither. This was corroborated by his landlord, who had received by messenger the key of the house together with the rent due, in English money. This had been between ten and eleven o'clock last night. We were at a standstill again.
4
+
5
+
Whilst we were talking one came running and breathlessly gasped out that the body of Alexander had been found inside the wall of the churchyard of St. Peter, and that the throat had been torn open as if by some wild animal. Those we had been speaking with ran off to see the horror, the women crying out "This is the work of a Slovak!" We hurried away lest we should have been in some way drawn into the affair, and so detained.
6
+
7
+
- This is an un-bulleted list item.
8
+
- This is another un-bulleted list item.
9
+
- And another!
10
+
11
+
12
+
13
+
```rust
14
+
fn main() {
15
+
println!("Hello, world!");
16
+
}
17
+
```
18
+
19
+
1. This is the 1st item.
20
+
1. This is a nested item.
21
+
2. This is the 2nd item.
22
+
3. This is the 3rd item.
23
+
4. This is the 4th item.
24
+
25
+
| First name | Last name |
26
+
| ---------- | --------- |
27
+
| Aaron | Swartz |
28
+
| Joan | Clarke |
29
+
30
+
Is today's hectic lifestyle making you tense and impatient? Michelle, I don't regret this, but I both rue and lament it. I could if you hadn't turned on the light and shut off my stereo. For the last time, I don't like lilacs! Your 'first' wife was the one who liked lilacs!
31
+
32
+
Well, then good news! It's a suppository. Oh Leela! You're the only person I could turn to; you're the only person who ever loved me. We can't compete with Mom! Her company is big and evil! Ours is small and neutral!
33
+
34
+
You've killed me! Oh, you've killed me! It's a T. It goes "tuh". And until then, I can never die? Now that the, uh, garbage ball is in space, Doctor, perhaps you can help me with my sexual inhibitions?
35
+
36
+
## $\KaTeX$ Example
37
+
38
+
The below formula is the definition of a Fourier transform (FT) in $\KaTeX$.
39
+
40
+
Given the input:
41
+
42
+
```tex
43
+
\stackrel{\wedge}{f}(\xi) = \int^{\infty}_{-\infty} f(x)e^{2\pi ix\xi}dx, \forall\xi\in\Reals
44
+
```
45
+
46
+
Will output:
47
+
$$
48
+
\stackrel{\wedge}{f}(\xi) = \int^{\infty}_{-\infty} f(x)e^{2\pi ix\xi}dx, \forall\xi\in\Reals
49
+
$$
+25
crates/pkg1/fuzz/Cargo.toml
+25
crates/pkg1/fuzz/Cargo.toml
···
1
+
[package]
2
+
name = "rust-template-fuzz"
3
+
version = "0.0.0"
4
+
authors = ["Automatically generated"]
5
+
publish = false
6
+
edition = "2021"
7
+
8
+
[package.metadata]
9
+
cargo-fuzz = true
10
+
11
+
[dependencies]
12
+
libfuzzer-sys = "0.4"
13
+
14
+
[dependencies.rust-template]
15
+
path = ".."
16
+
17
+
# Prevent this from interfering with workspaces
18
+
[workspace]
19
+
members = ["."]
20
+
21
+
[[bin]]
22
+
name = "fuzz_target_1"
23
+
path = "fuzz_targets/fuzz_target_1.rs"
24
+
test = false
25
+
doc = false
+6
crates/pkg1/fuzz/fuzz_targets/fuzz_target_1.rs
+6
crates/pkg1/fuzz/fuzz_targets/fuzz_target_1.rs
+21
crates/pkg1/src/lib.rs
+21
crates/pkg1/src/lib.rs
···
1
+
#![doc = include_str!("../README.md")]
2
+
3
+
/// Say hi to someone! <3
4
+
pub fn greet(name: &str) -> String {
5
+
format!("Hello {}!", name)
6
+
}
7
+
8
+
#[cfg(test)]
9
+
mod tests {
10
+
use crate::greet;
11
+
12
+
#[test]
13
+
fn greet_bob() {
14
+
assert_eq!(greet("Bob"), String::from("Hello Bob!"));
15
+
}
16
+
17
+
#[test]
18
+
fn greet_the_world() {
19
+
assert_eq!(greet("World"), String::from("Hello World!"));
20
+
}
21
+
}
+60
deny.toml
+60
deny.toml
···
1
+
## If you're looking for the deny.toml template, head over to
2
+
## https://github.com/EmbarkStudios/cargo-deny/blob/main/deny.template.toml
3
+
4
+
# cargo-deny is really only ever intended to run on the "normal" tier-1 targets
5
+
targets = [
6
+
{ triple = "x86_64-unknown-linux-gnu" },
7
+
{ triple = "aarch64-unknown-linux-gnu" },
8
+
{ triple = "x86_64-unknown-linux-musl" },
9
+
{ triple = "aarch64-apple-darwin" },
10
+
{ triple = "x86_64-apple-darwin" },
11
+
{ triple = "x86_64-pc-windows-msvc" },
12
+
]
13
+
14
+
[advisories]
15
+
vulnerability = "deny"
16
+
unmaintained = "deny"
17
+
notice = "deny"
18
+
unsound = "deny"
19
+
ignore = [
20
+
# ansi_term is unmaintained, but it does exactly what it needs to and no more
21
+
# so no reason to change just for the sake of it
22
+
"RUSTSEC-2021-0139",
23
+
# atty is unmaintained, but the only issue for which we're affected by is
24
+
# the criterion crate, which only runs for performance bencharmks and therefore
25
+
# a false positive
26
+
# see: https://rustsec.org/advisories/RUSTSEC-2021-0145
27
+
"RUSTSEC-2021-0145"
28
+
]
29
+
30
+
[bans]
31
+
multiple-versions = "deny"
32
+
deny = []
33
+
skip = [
34
+
# cargo dependes on two versions
35
+
{ name = "hex", version = "=0.3.2" },
36
+
]
37
+
38
+
[sources]
39
+
unknown-registry = "warn"
40
+
unknown-git = "warn"
41
+
allow-registry = ["https://github.com/rust-lang/crates.io-index"]
42
+
43
+
[licenses]
44
+
unlicensed = "deny"
45
+
allow-osi-fsf-free = "neither"
46
+
copyleft = "deny"
47
+
# We want really high confidence when inferring licenses from text
48
+
confidence-threshold = 0.93
49
+
allow = [
50
+
"Apache-2.0",
51
+
"Apache-2.0 WITH LLVM-exception",
52
+
"MIT",
53
+
"MPL-2.0"
54
+
]
55
+
56
+
exceptions = [
57
+
{ allow = [ "Zlib", ], name = "tinyvec" },
58
+
{ allow = [ "Apache-2.0", "BSD-2-Clause", ], name = "crossbeam-queue" },
59
+
{ allow = [ "Unicode-DFS-2016", ], name = "unicode-ident" },
60
+
]