diff --git a/README.md b/README.md index bbd7917..4d2ceed 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,20 @@ - `no-undeclared-dependencies`: imported packages are declared in the nearest `package.json`. `devDependencies` are only allowed with the `allowDevDependencies` option, for example in tests. Type-only imports are skipped. - `organize-imports`: imports are grouped by builtin, external, parent, sibling and index modules, then other paths like tsconfig aliases, and sorted alphabetically within each group. Side-effect imports stay in place. Fixable. - `test-root-describe`: the root `describe` of a spec file is named after its path, without `src/`, `lib/` or `test/` and the `.spec.ts` suffix. Fixable. + +## Development + +Node.js, pnpm and jactionlint are pinned in [`mise.toml`](./mise.toml), so [`mise`](https://mise.jdx.dev) installs them and the dependencies with `mise install`. +Without mise, install the dependencies with `pnpm install`. + +```bash +mise install +pnpm lint +pnpm test +pnpm build +jactionlint +``` + +- `pnpm lint-fix` fixes the formatting and the fixable lint findings. +- `pnpm build` compiles the plugin to `dist/`, which is what the package ships. +- `jactionlint` checks the GitHub workflows. diff --git a/mise.toml b/mise.toml index 2a77543..0b102e8 100644 --- a/mise.toml +++ b/mise.toml @@ -2,3 +2,10 @@ jactionlint = "1.8.2" node = "24.21.0" pnpm = "12.11.0" + +[hooks] +postinstall = "pnpm install" + +[settings] +# needed for hooks +experimental = true