-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #75 from ethereum-optimism/refcell/fixes
fix: Justfile and Link Lints
- Loading branch information
Showing
2 changed files
with
24 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,41 @@ | ||
set positional-arguments | ||
|
||
# default recipe to display help information | ||
default: | ||
@just --list | ||
|
||
# Install required dependencies | ||
deps: | ||
pnpm i --frozen-lockfile | ||
|
||
# Lint the workspace for all available targets | ||
lint: lint-specs-md-check lint-specs-toc-check lint-links | ||
|
||
# Updates all files to fix linting issues | ||
lint-fix: lint-specs-md-fix lint-specs-toc | ||
|
||
# Validates markdown file formatting | ||
lint-specs-md-check: | ||
npx markdownlint-cli2 "./specs/**/*.md" | ||
|
||
# Updates markdown files formatting to satisfy lints | ||
lint-specs-md-fix: | ||
npx markdownlint-cli2-fix "./specs/**/*.md" | ||
|
||
# Validates Table of Content Sections with doctoc | ||
lint-specs-toc-check: | ||
npx doctoc '--title=**Table of Contents**' ./specs && git diff --exit-code . | ||
npx doctoc '--title=**Table of Contents**' ./specs && git diff --exit-code ./specs | ||
|
||
# Updates Table of Content Sections with doctoc | ||
lint-specs-toc: | ||
npx doctoc '--title=**Table of Contents**' ./specs | ||
|
||
# Validates all hyperlinks respond with status 200 | ||
lint-links: | ||
docker run --init -it -v `pwd`:/input lycheeverse/lychee --verbose --no-progress --exclude-loopback \ | ||
--exclude twitter.com --exclude explorer.optimism.io --exclude linux-mips.org --exclude vitalik.ca \ | ||
--exclude-mail /input/README.md "/input/specs/**/*.md" | ||
|
||
serve: | ||
mdbook serve | ||
# Serves the mdbook locally | ||
serve *args='': | ||
mdbook serve $@ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters