Feature/polite (#2)

* mentions * tests * Update rust.yml * Update rust.yml * Create publish.yaml * Update publish.yaml * fix: other source * update tests * fix interval * fix: store token * version
anvlkv · Jun 22, 2024 · fba72ff · fba72ff
1 parent a14c552
commit fba72ff
Show file tree

Hide file tree

Showing 16 changed files with 2,557 additions and 1,554 deletions.
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -2,22 +2,20 @@ name: Rust
 
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 env:
   CARGO_TERM_COLOR: always
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Build
-      run: cargo build --verbose
-    - name: Run tests
-      run: cargo test --verbose --no-run
-
+      - uses: actions/checkout@v4
+      - name: Build
+        run: cargo build --verbose
+      - name: Run tests
+        run: cargo test --verbose --test help
diff --git a/ACKNOWLEDGEMENTS-BuildAndDev.md b/ACKNOWLEDGEMENTS-BuildAndDev.md
diff --git a/ACKNOWLEDGEMENTS-DepAndNames.md b/ACKNOWLEDGEMENTS-DepAndNames.md
diff --git a/ACKNOWLEDGEMENTS-NameAndDeps.md b/ACKNOWLEDGEMENTS-NameAndDeps.md
diff --git a/ACKNOWLEDGEMENTS.md b/ACKNOWLEDGEMENTS.md
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "acknowledgements-rs"
-version = "0.1.2"
+version = "1.0.0"
 edition = "2021"
 authors = ["a.nvlkv <acknowledgements_rs@proton.me>"]
 license = "CC-BY-4.0"
@@ -39,3 +39,11 @@ cacache = { version = "13.0.0", default-features = false, features = [
     "mmap",
 ] }
 chrono = { version = "0.4.38", default-features = false, features = ["now"] }
+
+[dev-dependencies]
+insta = { version = "1.39.0", features = ["yaml"] }
+
+
+[profile.dev.package]
+insta.opt-level = 3
+similar.opt-level = 3
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 `acknowledge` is a CLI tool for generating list of acknowledgements based on your `Cargo.toml` file.
 
-It works with github and gitlab APIs. **Only** public repos are supported.
+It works with github and gitlab APIs. Only public repos are supported.
 
 ## Install
 
@@ -28,10 +28,12 @@ Options:
           Running Acknowledgements on any project of reasonable size you're likely to face rate limits. Please provide a personal access token
   -o, --output <OUTPUT>
           Output file path, defaults to project path if not provided
+  -m, --mention
+          Whether to include @ (at) symbol in front of a github user's name
   -f, --format <FORMAT>
           Format of the output file [default: NameAndCount]
-  -d, --depth <DEPTH>
-          Depth of scan, whether to include minor and optional depes contributors [default: Major]
+  -b, --breadth <BREADTH>
+          Breadth of scan, whether to include optional, build and dev deps contributors [default: NonOpt]
   -c, --contributions-threshold <CONTRIBUTIONS_THRESHOLD>
           Min number of contributions to be included in the list, doesn't apply to sole contributors [default: 2]
   -s, --sources <SOURCES>
@@ -48,17 +50,17 @@ Options:
 
 #### Github access token
 
-Be sure to provide one if you're waiting for limit reset for too long or too often.
+Be sure to provide one if you're waiting for limit reset for too long or too often. No permissions are needed for this token.
 
 #### Sources
 
 Links any repos not discoverable via `Cargo.toml`
 
-#### Depth
+#### Breadth
 
-- `Major` - Non-optional dependencies
-- `Direct` - All dependencies
-- `Indepth` - All dependencies including `[build-dependencies]` and `[dev-dependencies]`
+- `NonOpt` - Non-optional dependencies
+- `All` - All dependencies
+- `BuildAndDev` - All dependencies including `[build-dependencies]` and `[dev-dependencies]`
 
 #### Format
 
@@ -72,3 +74,4 @@ Links any repos not discoverable via `Cargo.toml`
 - [`NameAndCount`](https://github.com/anvlkv/acknowledgements/blob/main/ACKNOWLEDGEMENTS.md) - `acknowledge -p .`
 - [`DepAndNames`](https://github.com/anvlkv/acknowledgements/blob/main/ACKNOWLEDGEMENTS-DepAndNames.md) - `acknowledge -p . -f DepAndNames`
 - [`NameAndDeps` ](https://github.com/anvlkv/acknowledgements/blob/main/ACKNOWLEDGEMENTS-NameAndDeps.md) - `acknowledge -p . -f NameAndDeps`
+- [`BuildAndDev`](https://github.com/anvlkv/acknowledgements/blob/main/ACKNOWLEDGEMENTS-BuildAndDev.md) - `acknowledge -p . -b BuildAndDev`