github/endurain
1
1
Fork 0
mirror of https://github.com/joaovitoriasilva/endurain.git synced 2026-01-08 23:38:01 -05:00
Code Issues 45 Packages Projects Releases Wiki Activity

Update Crowdin config and remove TypeScript guide

Browse Source 
Changed translation path variables in crowdin.yml to use %original_file_name% for consistency. Removed the frontend/app/TYPESCRIPT.md documentation file, likely to consolidate or relocate TypeScript support information.
This commit is contained in:
João Vitória Silva
2025-10-02 10:13:23 +01:00
parent aabb205ae3
commit 9faf22d42a
2 changed files with 4 additions and 179 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
crowdin.yml
View File

@@ -1,12 +1,12 @@
files:
- source: /frontend/app/src/i18n/us/*.json
translation: /frontend/app/src/i18n/%two_letters_code%/%file_name%.%file_extension%
translation: /frontend/app/src/i18n/%two_letters_code%/%original_file_name%
- source: /frontend/app/src/i18n/us/components/*.json
translation: /frontend/app/src/i18n/%two_letters_code%/components/%file_name%.%file_extension%
translation: /frontend/app/src/i18n/%two_letters_code%/components/%original_file_name%
- source: /frontend/app/src/i18n/us/gears/*.json
translation: /frontend/app/src/i18n/%two_letters_code%/gears/%file_name%.%file_extension%
translation: /frontend/app/src/i18n/%two_letters_code%/gears/%original_file_name%
- source: /frontend/app/src/i18n/us/strava/*.json
translation: /frontend/app/src/i18n/%two_letters_code%/strava/%file_name%.%file_extension%
translation: /frontend/app/src/i18n/%two_letters_code%/strava/%original_file_name%
- source: /frontend/app/src/i18n/us/components/activities/*.json
translation: /frontend/app/src/i18n/%two_letters_code%/components/activities/%original_file_name%
- source: /frontend/app/src/i18n/us/components/activities/modals/*.json

175
frontend/app/TYPESCRIPT.md
View File

@@ -1,175 +0,0 @@
# TypeScript Support
This project now supports TypeScript alongside JavaScript, enabling gradual migration and improved developer experience.
## Overview
- **Existing JavaScript files (.js, .vue)** continue to work without any modifications
- **New files** can be written in TypeScript (.ts) or Vue with TypeScript (`<script lang="ts">`)
- Type checking is integrated into the build process
## Getting Started
### Writing TypeScript Files
#### TypeScript Modules (.ts)
Create `.ts` files in the `src/` directory:
```typescript
// src/utils/example.ts
export interface User {
id: number
name: string
email?: string
}
export function greetUser(user: User): string {
return `Hello, ${user.name}!`
}
```
#### Vue Components with TypeScript
Use `<script lang="ts">` in your Vue components:
```vue
<template>
<div>{{ message }}</div>
</template>
<script lang="ts">
import { defineComponent, ref } from 'vue'
export default defineComponent({
name: 'MyComponent',
setup() {
const message = ref<string>('Hello TypeScript!')
return { message }
}
})
</script>
```
Or use the Composition API with `<script setup lang="ts">`:
```vue
<template>
<div>{{ message }}</div>
</template>
<script setup lang="ts">
import { ref } from 'vue'
const message = ref<string>('Hello TypeScript!')
</script>
```
### Type Checking
Run type checking manually:
```bash
npm run type-check
```
The build process (`npm run build`) now includes type checking automatically.
### Linting
TypeScript files are configured to work with ESLint:
```bash
npm run lint
```
Note: The project uses ESLint 9 which requires migration from `.eslintrc.cjs` to `eslint.config.js`. The current ESLint configuration may need updates for full functionality.
### IDE Support
TypeScript configuration is provided via `tsconfig.json`, which enables:
- IntelliSense and autocompletion
- Type checking in your IDE
- Better refactoring support
- Import path resolution for `@/` alias
## Configuration Files
- `tsconfig.json` - Root configuration with project references
- `tsconfig.app.json` - Configuration for application code
- `tsconfig.node.json` - Configuration for Node.js build tools (Vite, Vitest)
- `tsconfig.vitest.json` - Configuration for test files
- `src/env.d.ts` - Vite and global type declarations
## Migration Strategy
TypeScript is **optional** and migration can be done incrementally:
1. Start with new features - write new components/utilities in TypeScript
2. Gradually migrate existing files when making significant changes
3. No immediate action required for existing JavaScript files
## Practical Examples
### Migrating a JavaScript Utility to TypeScript
Before (JavaScript):
```javascript
// src/utils/example.js
export function calculateDistance(lat1, lon1, lat2, lon2) {
// ... implementation
return distance
}
```
After (TypeScript):
```typescript
// src/utils/example.ts
export function calculateDistance(
lat1: number,
lon1: number,
lat2: number,
lon2: number
): number {
// ... implementation
return distance
}
```
### Using Existing JavaScript Files from TypeScript
TypeScript files can import and use existing JavaScript modules:
```typescript
// Import from existing JS service
import { fetchUserProfile } from '@/services/profileService'
// TypeScript provides type safety for your new code
const profile = await fetchUserProfile(userId)
```
### Defining Types for API Responses
```typescript
// src/types/api.ts
export interface Activity {
id: number
name: string
distance: number
duration: number
date: string
}
export interface ApiResponse<T> {
data: T
status: number
message?: string
}
```
## Important Notes
- `allowJs: true` is enabled, so JavaScript and TypeScript can coexist
- Existing JavaScript files will not show type errors
- Type checking is strict for TypeScript files but permissive for JavaScript
- The `@/` path alias works in both JavaScript and TypeScript files