docs: document infrastructure #1854
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
matijs
reviewed
Jan 8, 2025
| - Gebruik [ESLint](https://eslint.org) om ECMAScript, JavaScript en TypeScript te controleren. | ||
| - Gebruik [Stylelint](https://stylelint.io) om CSS en SCSS te controleren. | ||
| - Gebruik [Prettier](http://prettier.io) voor de opmaak van code. | ||
| - Gebruik een GitHub Action voor het controleren van code, testen van functionaliteit en het compileren van code, als je GitHub gebruikt. |
There was a problem hiding this comment.
Suggested change
| - Gebruik een GitHub Action voor het controleren van code, testen van functionaliteit en het compileren van code, als je GitHub gebruikt. | |
| - Gebruik GitHub Actions voor het controleren van code, testen van functionaliteit en het compileren van code, als je GitHub gebruikt. |
|
|
||
| - Gebruik Node.js 22 voor nieuwe project, of migreer zo snel mogelijk naar Node 22. | ||
| - Stel de Node.js versie in bij `"engines"` in `package.json`. | ||
| - Stel de Node.js versie in bij de `.nvmrc` of `.node-version` file, of in beide. |
There was a problem hiding this comment.
Suggested change
| - Stel de Node.js versie in bij de `.nvmrc` of `.node-version` file, of in beide. | |
| - Stel de Node.js versie in in het bestand `.nvmrc` of `.node-version`, of in beide. |
|
|
||
| ## Storybook | ||
|
|
||
| - Gebruik geen [webpack](https://webpack.js.org) voor nieuwe projecten, en migreer van webpack naar alternatieven wanneer je de mogelijkheid hebt. |
There was a problem hiding this comment.
Suggested change
| - Gebruik geen [webpack](https://webpack.js.org) voor nieuwe projecten, en migreer van webpack naar alternatieven wanneer je de mogelijkheid hebt. | |
| - Gebruik voor nieuwe projecten niet langer [webpack](https://webpack.js.org), en migreer van webpack naar alternatieven wanneer je de mogelijkheid hebt. De standaard-infrastructuur van NL Design System maakt gebruik van Vite en Storybook's Vite builder. |
| - Gebruik `stylelint` voor Continuous Integration om CSS en SCSS te controleren. | ||
| - Gebruik `eslint` voor Continuous Integration om JavaScript te controleren. | ||
| - Gebruik `tsc --noEmit` voor Continuous Integration om TypeScript projecten te controleren. | ||
| - Gebruik [`lint-staged`](https://www.npmjs.com/package/lint-staged) zodat committers niet hoeven te wachten op een GitHub Action om te weten dat er nog een foutje is. |
There was a problem hiding this comment.
Suggested change
| - Gebruik [`lint-staged`](https://www.npmjs.com/package/lint-staged) zodat committers niet hoeven te wachten op een GitHub Action om te weten dat er nog een foutje is. | |
| - Gebruik [`lint-staged`](https://www.npmjs.com/package/lint-staged) in combinatie met [`husky`](https://www.npmjs.com/package/husky) zodat committers niet hoeven te wachten op een GitHub Action om te weten dat er nog een foutje is. |
| ## Visuele regressietests | ||
|
|
||
| - Gebruik een tool voor visuele regressietests, om het resultaat van front-end code te controleren door te vergelijken met referentie-screenshots. | ||
| - Als je Chromatic. |
There was a problem hiding this comment.
Suggested change
| - Als je Chromatic. | |
| - De NL Design System standaard-infrastructuur maakt gebruik van Chromatic. |
| - Wat is de open source licentie? | ||
| - Wat is de Code of Conduct? | ||
| - Maak een `/LICENSE.md` bestand met de open source licentie. Wij gebruiken de [EUPL-1.2 licentie](https://opensource.org/license/eupl-1-2). | ||
| - Maak een `/CODE_OF_CONDUCT.md` bestand met de Code of Conduct. Wij gebruiken de [Contributor Covenant 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). |
There was a problem hiding this comment.
Suggested change
| - Maak een `/CODE_OF_CONDUCT.md` bestand met de Code of Conduct. Wij gebruiken de [Contributor Covenant 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). | |
| - Maak een `CODE_OF_CONDUCT.md` bestand in de root van je repository met daarin de Code of Conduct. Wij gebruiken de [Contributor Covenant 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). |
| - GitHub repository access rights. | ||
| - Vercel deployments. | ||
|
|
||
| Als deze instellingen in Terraform worden beheerd, dan moeten ze niet meer handmatig gewijzigd worden via de GitHub user interface. Om handmatige wijzigingen te voorkomen hebben zo min mogelijk users maintainer rechten. |
There was a problem hiding this comment.
Suggested change
| Als deze instellingen in Terraform worden beheerd, dan moeten ze niet meer handmatig gewijzigd worden via de GitHub user interface. Om handmatige wijzigingen te voorkomen hebben zo min mogelijk users maintainer rechten. | |
| Als deze instellingen in Terraform worden beheerd, dan **moeten** ze niet meer handmatig gewijzigd worden via de GitHub user interface. Om handmatige wijzigingen te voorkomen hebben zo min mogelijk users maintainer rechten. |
| 1. `nvm install` | ||
| 2. `nvm use` | ||
| 3. `corepack enable` | ||
| - Upgrade npm dependencies van `@types/node` aan naar de meest recente 22.x versie, met het command: `pnpm exec npm-check-updates --filter @types/node --install always --upgrade` |
There was a problem hiding this comment.
Suggested change
| - Upgrade npm dependencies van `@types/node` aan naar de meest recente 22.x versie, met het command: `pnpm exec npm-check-updates --filter @types/node --install always --upgrade` | |
| - Upgrade de dependency `@types/node` naar de meest recente 22.x versie, met het command: `pnpm exec npm-check-updates --filter @types/node --install always --upgrade` |
| - GitHub Actions kun je instellen dat ze de Node-versie gebruiken die in `.nvmrc` staat, dus je hoeft voor GitHub Actions niets te doen als je dat gebruikt. | ||
| - Als je Vercel gebruikt: pas in de General Settings van je Project aan dat je [Node 22.x wilt gebruiken voor Vercel](https://vercel.com/docs/functions/runtimes/node-js/node-js-versions). Helaas lijkt het niet mogelijk dit via Terraform te configureren. | ||
|
|
||
| #### ESLint 9 |
There was a problem hiding this comment.
We zouden kunnen verwijzen naar https://github.com/nl-design-system/basis/tree/main/packages/eslint-config
Co-authored-by: matijs <matijs@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.