TypeScript Migration Guidelines

Context:
We are migrating our codebase to TypeScript. This issue will remain open until the migration is fully complete. Please ensure that all new contributions follow these guidelines to maintain consistency and code quality.

File Types & Naming Conventions

• File Types:
  • Use TypeScript files only: use .tsx for React components and .ts for non-React components.
• Filename Convention:
  • Use kebab-case for filenames (lowercase only, words separated by hyphens).

Code Standards

• Component Style:
  • All components must be functional.
  • Do not use prop-types or .defaultProps as these are unnecessary in a TypeScript codebase.
• Imports:
  • All imports must include the .js extension.
• State Management & Bundles:
  • Do not use redux-bundler or redux-bundler-react.
  • Do not add new bundles; if possible, create a hook or use context instead.
• Internationalization:
  • Do not use withTransation; use useTranslation instead.

Project Configuration

• TypeScript Setup:
  • Add new TypeScript files to tsconfig.json.
  • Include any dependent files that require type checking.
  • If an existing file is too large or requires extensive changes, it can be temporarily ignored until someone can convert it properly.

Additional Guidelines for Contributors

• Linting & Formatting:
  • Follow the project’s ESLint and Prettier configurations to maintain a consistent code style.
• Testing:
  • Include unit tests & e2e tests with 100% coverage for all new code. This ensures that our code remains robust during the migration.
• Documentation:
  • Update or add documentation as necessary to reflect changes or new patterns introduced during the migration.
• Dependencies:
  • Verify that any new third-party libraries include proper TypeScript type definitions.
• Backwards Compatibility:
  • Avoid breaking changes. When updating legacy code, strive to maintain compatibility until the entire file can be migrated.
• Questions & Support:
  • If you have any questions or need clarification on migration specifics, please ping @SgtPooki.

---

Your cooperation in following these guidelines is essential for a smooth transition to a fully TypeScript codebase. Thank you for your contributions!