Skip to content

Define default options in a single place, autogenerate CLI help #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lkmgr merged 6 commits into from
Aug 29, 2025
Merged

Define default options in a single place, autogenerate CLI help #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6f0a9d7
refactor: migrate CLI parser from `meow` to `yargs`
lkmgr Aug 21, 2025
6e22810
refactor: create `SharedOptions` type
lkmgr Aug 22, 2025
0454500
refactor: define option defaults in a single location
lkmgr Aug 25, 2025
0364d73
docs: update README binary instructions
lkmgr Aug 27, 2025
c605945
ci: run tests only once
lkmgr Aug 27, 2025
9976e6e
test: exclude cli from coverage because it is tested using `execa`
lkmgr Aug 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ jobs:
cache: npm
- run: node -v
- run: npm ci
- run: npm run test
- run: npm run coverage
- name: Upload results to Codecov
uses: codecov/codecov-action@v5
Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,8 @@ chmod +x linkinator

[macOS arm64 Download](https://github.com/avenga/linkinator/releases/latest/download/linkinator-darwin-arm64)

The binary needs to be marked as executable. Also, there might be a quarantine attribute applied automatically because the binary is unsigned, which needs to be removed.
The binary needs to be marked as executable.
**Important:** when downloading the binary using a browser instead of `wget`/`curl`, it might receive a quarantine attribute. See below on how to remove it.

```sh
# x64
Expand All @@ -76,7 +77,7 @@ chmod +x linkinator
./linkinator --help
```

If you see an error when executing (file damaged, invalid signature or similar), there might be a quarantine attribute applied automatically because the binary is unsigned, which needs to be removed.
**If you see an error when executing** (file damaged, invalid signature or similar), there might be a quarantine attribute applied automatically because the binary is unsigned, which needs to be removed:

```sh
xattr -d com.apple.quarantine linkinator
Expand Down
Loading