Skip to content

Commit

Permalink
docs(README): Link to all pertinent tool websites
Browse files Browse the repository at this point in the history
Avoid ambiguity, and make it more convenient for readers to learn about
any tools they may be unfamiliar with. Only link to each tool the first
time it is mentioned.
  • Loading branch information
Kurt-von-Laven committed May 2, 2022
1 parent c5a5964 commit 59b06a3
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@ Hooks for Use With the [pre-commit](https://pre-commit.com) Framework
<!--TOC-->

Pre-commit only supports [Git](https://git-scm.com/) and no other version
control system (VCS). The defaults for the Yarn hooks are configured for use
with a [Zero-Installs](https://yarnpkg.com/features/zero-installs)
control system (VCS). The defaults for the [Yarn](https://yarnpkg.com/) hooks
are configured for use with a
[Zero-Installs](https://yarnpkg.com/features/zero-installs)
[TypeScript](https://www.typescriptlang.org/) project. They assume Yarn and
Node.js are managed by asdf, but the file patterns may be overridden.
[Node.js](https://nodejs.org/) are managed by [asdf](https://asdf-vm.com/), but
the file patterns may be overridden.

## Hooks

Expand All @@ -54,8 +56,8 @@ Install tools (based on `.tool-versions` unless otherwise configured) by running

Validate structure of `pyproject.toml` by running
[`poetry check`](https://python-poetry.org/docs/cli/#check). Run when
Poetry dependencies or version changes (assuming Poetry is managed by asdf, but
the file pattern may be overridden).
[Poetry](https://python-poetry.org/) dependencies or version changes (assuming
Poetry is managed by asdf, but the file pattern may be overridden).

### `poetry-lock`

Expand All @@ -79,8 +81,8 @@ See also the documentation for

### `megalinter`

Run MegaLinter on files modified relative to default branch (skipping jscpd)
by running:
Run [MegaLinter](https://megalinter.github.io/) on files modified relative to
default branch (skipping jscpd) by running:

```sh
npx -- mega-linter-runner@<version> \
Expand Down

0 comments on commit 59b06a3

Please sign in to comment.