Skip to content
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

Jump to bottom

docs(README): Link to all pertinent tool websites #22

Merged
merged 1 commit into from
May 2, 2022
Merged

docs(README): Link to all pertinent tool websites #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
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