diff --git a/web/docs/dependencies.md b/web/docs/dependencies.md index 250c6e7046..062ffeb72c 100644 --- a/web/docs/dependencies.md +++ b/web/docs/dependencies.md @@ -5,28 +5,37 @@ These are some global dev dependencies in the root `package.json`. These set the baseline for how our code be in all the workspaces in this (yarn) monorepo. -- "prettier" - Formatter -- "eslint" - Linter -- "typescript" - Type checker +- [prettier](https://prettier.io) - Formatter + +- [eslint](https://eslint.org) - Linter + +- [typescript](https://www.typescriptlang.org/) - Type checker They also need some support packages, which come from the leaf `@/build-config` package: -- "@typescript-eslint/parser" - Tells ESLint how to read TypeScript syntax. +- [@typescript-eslint/parser](https://typescript-eslint.io/packages/eslint-plugin/) + \- Tells ESLint how to read TypeScript syntax. -- "@typescript-eslint/eslint-plugin" - Provides TypeScript rules and presets +- [@typescript-eslint/eslint-plugin](https://typescript-eslint.io/packages/eslint-plugin/) + \- Provides TypeScript rules and presets -- "eslint-plugin-react-hooks", "eslint-plugin-react-namespace-import" - Some - React specific ESLint rules and configurations that are used by the - workspaces that have React code. +- [eslint-plugin-react-hooks](https://github.com/jsx-eslint/eslint-plugin-react), + [eslint-plugin-react-hooks](https://reactjs.org/) \- Some React specific + ESLint rules and configurations that are used by the workspaces that have + React code. -- "eslint-plugin-react-refresh" - A plugin to ensure that React components are - exported in a way that they can be HMR-ed. +- [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh) + \- A plugin to ensure that React components are exported in a way that they + can be HMR-ed. -- "prettier-plugin-organize-imports" - A Prettier plugin to sort imports. +- [prettier-plugin-organize-imports](https://github.com/simonhaenisch/prettier-plugin-organize-imports) + \- A Prettier plugin to sort imports. -- "prettier-plugin-packagejson" - A Prettier plugin to also prettify - `package.json`. +- [prettier-plugin-packagejson](https://github.com/matzkoh/prettier-plugin-packagejson) + \- A Prettier plugin to also prettify `package.json`. + +The root `package.json` also has a convenience dev dependency: - [concurrently](https://github.com/open-cli-tools/concurrently) for spawning parallel tasks when we invoke various yarn scripts.