mirror of
https://github.com/CompassConnections/Compass.git
synced 2026-05-13 01:24:26 -04:00
Add translation guidelines and coding tips to documentation
This commit is contained in:
42
.windsurf/rules/next.md
Normal file
42
.windsurf/rules/next.md
Normal file
@@ -0,0 +1,42 @@
|
||||
---
|
||||
trigger: manual
|
||||
description:
|
||||
globs:
|
||||
---
|
||||
|
||||
### Translations
|
||||
|
||||
```typescript
|
||||
import {useT} from "web/lib/locale";
|
||||
|
||||
const t = useT()
|
||||
t("common.key", "English translations")
|
||||
```
|
||||
|
||||
Translations should go to the JSON files in `web/messages` (`de.json` and `fr.json`, as of now).
|
||||
|
||||
### Misc coding tips
|
||||
|
||||
We have many useful hooks that should be reused rather than rewriting them again.
|
||||
|
||||
---
|
||||
|
||||
We prefer using lodash functions instead of reimplementing them with for loops:
|
||||
|
||||
```ts
|
||||
import {keyBy, uniq} from 'lodash'
|
||||
|
||||
const betsByUserId = keyBy(bets, 'userId')
|
||||
const betIds = uniq(bets, (b) => b.id)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Instead of Sets, consider using lodash's uniq function:
|
||||
|
||||
```ts
|
||||
const betIds = uniq([])
|
||||
for (const id of betIds) {
|
||||
...
|
||||
}
|
||||
```
|
||||
@@ -424,6 +424,17 @@ const res = await pg.manyOrNone(query)
|
||||
|
||||
Use these functions instead of string concatenation.
|
||||
|
||||
### Translations
|
||||
|
||||
```typescript
|
||||
import {useT} from "web/lib/locale";
|
||||
|
||||
const t = useT()
|
||||
t("common.key", "English translations")
|
||||
```
|
||||
|
||||
Translations should go to the JSON files in `web/messages` (`de.json` and `fr.json`, as of now).
|
||||
|
||||
### Misc coding tips
|
||||
|
||||
We have many useful hooks that should be reused rather than rewriting them again.
|
||||
|
||||
Reference in New Issue
Block a user