Skip to content

Commit

Permalink
Initial project setup.
Browse files Browse the repository at this point in the history
  • Loading branch information
orium committed Oct 20, 2022
0 parents commit 73e6030
Show file tree
Hide file tree
Showing 18 changed files with 728 additions and 0 deletions.
1 change: 1 addition & 0 deletions .cargo-rdme.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
line-terminator = "lf"
16 changes: 16 additions & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
codecov:
notify:
require_ci_to_pass: yes

coverage:
precision: 2
round: down
range: "80...100"

status:
project:
default:
target: auto
threshold: 10%
patch: no
changes: no
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
6 changes: 6 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "cargo"
directory: "/"
schedule:
interval: "daily"
50 changes: 50 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: CI

on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
schedule:
- cron: '0 19 * * 3'

env:
CARGO_TERM_COLOR: always

jobs:
build:

runs-on: ${{ matrix.os }}

strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]

steps:
- name: Install rust stable
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true
default: true
components: rustfmt

- name: Install cargo plugins
run: |
cargo install cargo-rdme
cargo install cargo-deadlinks
- name: Checkout repository
uses: actions/checkout@v2
with:
fetch-depth: 2

- name: Check everything
run: bash ./tools/check.sh

- name: Code coverage
if: ${{ runner.os == 'Linux' }}
run: |
cargo install cargo-tarpaulin
./tools/codecov.sh --xml
bash <(curl -s https://codecov.io/bash)
7 changes: 7 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
/.idea/

/target/
*.rs.bk

/Cargo.lock
/tarpaulin-report.html
10 changes: 10 additions & 0 deletions .rustfmt.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
edition = "2021"

use_field_init_shorthand = true
use_try_shorthand = true
use_small_heuristics = "max"

# TODO Awaiting stabilization
# comment_width = 100
# match_arm_blocks = false
# struct_field_align_threshold = 4
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing to dirty-debug

Thank you for your interest in contributing to dirty-debug. We appreciate it!

If you are contributing with a pull request you might want to know about a few scripts:

* [`./tools/check.sh`](tools/check.sh) — Checks that everything is fine. This includes checking that everything
builds, the unit tests pass, and the code is correctly formatted. If you need to format the code run
`cargo fmt`.
* [`./tools/codecov.sh`](tools/codecov.sh) — Creates a code coverage report. There is not a strict code coverage
threshold, but we do want pretty much everything tested.
40 changes: 40 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
[package]
name = "dirty-debug"
description = "Quick and dirty debugging"
version = "0.0.0-pre"
authors = ["Diogo Sousa <[email protected]>"]

edition = "2021"

homepage = "https://github.com/orium/dirty-debug"
repository = "https://github.com/orium/dirty-debug"
documentation = "https://docs.rs/dirty-debug"
readme = "README.md"

keywords = [
"debug",
]

categories = [
"development-tools",
]

license = "MPL-2.0"

# What to include when packaging.
include = [
"/src/**/*.rs",
"/Cargo.toml",
"/LICENSE.md",
"/README.md",
"/release-notes.md",
]

[badges]
codecov = { repository = "orium/dirty-debug", branch = "master", service = "github" }

[features]
fatal-warnings = []

[dependencies]

Loading

0 comments on commit 73e6030

Please sign in to comment.