JavaScript Design Guidelines

Outline

1. Dependency versions
   1. By default, float using ^ for maximum compatibility, including things like security updates in dependencies.
   2. If a dependency is known to make breaking changes in minor versions (like typescript), float using ~ instead of ^.
   3. If a dependency is a pre-release (e.g. 0.X.Y), it MUST be pinned, since pre-release allows breaking changes even in patch versions.
2. Lock file
3. ESLint
4. Prettier
5. JavaScript vs TypeScript

High-Quality Examples

• JS: https://github.com/Azure/azure-rest-api-specs/tree/main/.github/shared
• TS: https://github.com/Azure/azure-rest-api-specs/tree/main/eng/tools/typespec-validation