forked from
npmx.dev/npmx.dev
[READ-ONLY]
a fast, modern browser for the npm registry
1# Core Requirements
2
3- The end goal is stability, speed and great user experience.
4
5## Code Quality Requirements
6
7- Follow standard TypeScript conventions and best practices
8- Use the Composition API when creating Vue components
9- Use clear, descriptive variable and function names
10- Accessibility should always be a first-class consideration and should be part of the initial planning and design.
11- Add comments only to explain complex logic or non-obvious implementations
12- Write unit tests for core functionality using `vitest`
13- Write end-to-end tests using Playwright and `@nuxt/test-utils`
14- Keep functions focused and manageable (generally under 50 lines)
15- Use error handling patterns consistently
16- Ensure you write strictly type-safe code, for example by ensuring you always check when accessing an array value by index