Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neoncitylights/etalia
a citation parser and formatter engine in Rust (work-in-progress)
https://github.com/neoncitylights/etalia
apa chicago citation mla
Last synced: 2 days ago
JSON representation
a citation parser and formatter engine in Rust (work-in-progress)
- Host: GitHub
- URL: https://github.com/neoncitylights/etalia
- Owner: neoncitylights
- License: apache-2.0
- Created: 2023-12-05T21:19:29.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-02-05T11:59:58.000Z (9 months ago)
- Last Synced: 2024-05-01T16:19:44.350Z (7 months ago)
- Topics: apa, chicago, citation, mla
- Language: Rust
- Homepage:
- Size: 32.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Rust Repository Template 🦀
Repository template to get quickly started with writing Rust libraries, ready for distributing.
## Getting started
Open your favorite terminal and clone this locally.
- With the [GitHub CLI](https://cli.github.com/): Use the command below. Replace `` with what you'd like to call your project.
```shell
gh repo create --template neoncitylights/rust
```
- 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.
## Features
- [x] Remote development support with [GitHub Codespaces](https://github.com/features/codespaces)
- [x] Debugging with the [LLDB Debugger](https://lldb.llvm.org/) tool in Visual Studio Code ([VSCode Marketplace](https://marketplace.visualstudio.com/items?itemName=vadimcn.vscode-lldb))
- [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))
- [x] Performance benchmarks in Rust with Criterion and Iai (suitable to run in GitHub Actions CI environments)
- [x] CI/CD support with [GitHub Actions](https://github.com/features/actions)
- [x] Running tests and benchmarks
- [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
- [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)
## Configure
| Tool | File path | Reference |
|--------------------------|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| GitHub Codespaces | [`devcontainer.json`](./.devcontainer/devcontainer.json) | [Reference](https://containers.dev/implementors/json_reference/) |
| GitHub Actions | [`.github/workflows`](./.github/workflows) | [Reference](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions) |
| Cargo package | [`Cargo.toml`](crates/pkg1/Cargo.toml) | [Reference](https://doc.rust-lang.org/cargo/reference/manifest.html) |
| Clippy (Rust linter) | [`.clippy.toml`](./.clippy.toml) | [Repository](https://github.com/rust-lang/rust-clippy), [Reference]( https://rust-lang.github.io/rust-clippy/) |
| Rustfmt (Rust formatter) | [`.rustfmt.toml`](./.rustfmt.toml) | [Repository](https://github.com/rust-lang/rustfmt), [Reference](https://rust-lang.github.io/rustfmt/) |
| `cargo-deny` | [`deny.toml`](./deny.toml) | [Repository](https://github.com/EmbarkStudios/cargo-deny) |
## Run scripts locally
| Script | Command |
|-------------|---------|
| Run unit/integration/doc tests | `cargo test` |
| Run fuzz tests | `cargo fuzz ` |
| Run Rustfmt | `cargo fmt` |
| Run Clippy | `cargo clippy` |
| Run performance benchmarks | `cargo bench` |
| Generate API docs for crate | `cargo doc` |
| Generate mdBook docs for crate | `mdbook build` |
| Run security audits | `cargo audit`[^cargo-audit] |
[^cargo-audit]: Requires installing [`cargo-audit`](https://crates.io/crates/cargo-audit) locally