diff --git a/README.md b/README.md index 91c1b5b..e240401 100644 --- a/README.md +++ b/README.md @@ -55,32 +55,32 @@ npm publish --access public | Command | Description | | ------- | ----------- | -| `npm run build` | Build all packages | -| `npm run docs` | Generate documentation | +| `npm run build` | Build all packages | +| `npm run docs` | Generate documentation | | `npm run docs-watch` | Generate documentation in watch mode | -| `npm run clean` | Remove all generated files | -| `npm run test` | Run unit tests | -| `npm run test-ci` | Run unit tests in CI mode | -| `npm run test-ui` | Run unit tests in UI/browser mode | +| `npm run clean` | Remove all generated files | +| `npm run test` | Run unit tests | +| `npm run test-ci` | Run unit tests in CI mode | +| `npm run test-ui` | Run unit tests in UI/browser mode | | `npm run test-watch` | Run unit tests in watch mode | -| `npm run lint` | Check for ESLint/publint errors | -| `npm run lint-fix` | Fix ESLint errors (publint errors must be fixed manually) | -| `npm run eslint` | Check for ESLint errors | +| `npm run lint` | Check for ESLint/publint errors | +| `npm run lint-fix` | Fix ESLint errors (publint errors must be fixed manually) | +| `npm run eslint` | Check for ESLint errors | | `npm run eslint-fix` | Fix ESLint errors | -| `npm run publint` | Check for NPM packaging errors | +| `npm run publint` | Check for NPM packaging errors | ### Developer tools -| Tool | File | Documentation | -| ---- | ---- | ------------- | -| NPM package | [`package.json`](package.json) | [docs](https://docs.npmjs.com/cli/v10/configuring-npm/package-json), [website](https://docs.npmjs.com/) | -| TypeScript | [`tsconfig.json`](./tsconfig.json), [`packages/*/tsconfig.json`](packages/pkg1/tsconfig.json) | [docs](https://www.typescriptlang.org/tsconfig), [website](https://www.typescriptlang.org/) | -| TypeDoc (documentation generator) | [`tsconfig.json`](tsconfig.json) (`typedocOptions`) | [docs](https://typedoc.org/options/configuration/), [website](https://typedoc.org/) | -| ESLint (code formatter + linter) | [`eslint.config.js`](./eslint.config.js) | [docs](https://eslint.org/docs/latest/use/configure/), [website](https://eslint.org/) | -| Vite (bundler) | [`packages/*/vite.config.ts`](packages/pkg1/vite.config.ts) | [docs](https://vitejs.dev/config/), [website](https://vitejs.dev/) | -| Vitest (testing framework) | [`packages/*/vite.config.ts`](packages/pkg1/vite.config.ts) (`test`) | [docs](https://vitest.dev/config/), [website](https://vitest.dev/) | -| Vitest workspace | [`vitest.workspace.ts`](./vitest.workspace.ts) | [docs](https://vitest.dev/guide/workspace.html#workspace) | -| Dependabot | [`.github/dependabot.yml`](./.github/dependabot.yml) | [docs](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file), [website](https://github.com/dependabot) | +| Tool | File | Documentation | +| ------------------ | ---- | ------------- | +| NPM | [`package.json`](package.json) | [docs](https://docs.npmjs.com/cli/v10/configuring-npm/package-json), [website](https://docs.npmjs.com/) | +| TypeScript | [`tsconfig.json`](./tsconfig.json), [`packages/*/tsconfig.json`](packages/pkg1/tsconfig.json) | [docs](https://www.typescriptlang.org/tsconfig), [website](https://www.typescriptlang.org/) | +| TypeDoc | [`tsconfig.json`](tsconfig.json) (`typedocOptions`) | [docs](https://typedoc.org/options/configuration/), [website](https://typedoc.org/) | +| ESLint | [`eslint.config.js`](./eslint.config.js) | [docs](https://eslint.org/docs/latest/use/configure/), [website](https://eslint.org/) | +| Vite | [`packages/*/vite.config.ts`](packages/pkg1/vite.config.ts) | [docs](https://vitejs.dev/config/), [website](https://vitejs.dev/) | +| Vitest | [`packages/*/vite.config.ts`](packages/pkg1/vite.config.ts) (`test`) | [docs](https://vitest.dev/config/), [website](https://vitest.dev/) | +| Vitest (workspace) | [`vitest.workspace.ts`](./vitest.workspace.ts) | [docs](https://vitest.dev/guide/workspace.html) | +| Dependabot | [`.github/dependabot.yml`](./.github/dependabot.yml) | [docs](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file), [website](https://github.com/dependabot) | ## License