Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Oppdater README for multi-root workspace og oppdatere imports i portalen #4246

Merged
merged 7 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,37 @@ Jøkul er distribuert under [MIT-lisensen](./LICENSE) for åpen kildekode.

Takk for bidrag fra disse flotte menneskene ([emoji-oversikt](https://allcontributors.org/docs/en/emoji-key)):

## Særtilfeller og kjente problemer

### Multi-root workspaces for Jøkul

Prosjektet bruker [Multi-root Workspaces](https://code.visualstudio.com/docs/editor/workspaces#_multiroot-workspaces) i Visual Studio Code for å håndtere unike innstillinger for flere mapper i samme arbeidsområde. Ved å sette opp multi-root workspaces kan vi spesifisere konfigurasjoner som er tilpasset hver enkelt mappes krav, som spesifikke TypeScript-versjoner.

### Formål

I prosjektet fungerer `portalen`-mappen som et eget PNPM-workspace og krever **TypeScript versjon 5.4.5** for å være kompatibel med **Payload CMS v2**. Dette oppsettet sikrer korrekt IntelliSense-støtte og konsekvent funksjonalitet spesielt for `portalen`, uten å påvirke TypeScript-versjonen i hovedarbeidsområdet. Mer om dette behovet kan leses i denne [GitHub-saken](https://github.com/payloadcms/payload/issues/6799#issuecomment-2224211446).

### Konfigurasjon

Multi-root workspaces er lagret i en JSON-fil (`jokul.code-workspace`) med følgende relevante innstillinger:

- **Mapper**:
- `.` (hovedprosjektkatalogen - jokul)
- `portalen` (selvstendig arbeidsområde innenfor prosjektet)
- **TypeScript-versjon**:
- `portalen`-mappen har en spesifikk TypeScript-versjonsbane: `"typescript.tsdk": "portalen/node_modules/typescript/lib"`. Dette peker Visual Studio Code til TypeScript 5.4.5 innenfor `portalen`, mens hovedarbeidsområdet kan operere uavhengig.

### Bruksanvisning

For å åpne multi-root workspaces og sikre riktig TypeScript-konfigurasjon:

1. Åpne terminalen.
2. Kjør følgende kommando i jokul: `code jokul.code-workspace`

**Merk:** Multi-root workspaces fungerer for øyeblikket kun i Visual Studio Code.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Det hørtes litt ut fra den tråden som om selve problemet som løses også er unikt for VSCode, i så fall kunne vi jo nevnt det også.


## Bidragsytere

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
Expand Down
13 changes: 13 additions & 0 deletions jokul.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"folders": [
{
"path": "."
},
{
"path": "portalen"
}
],
"settings": {
"typescript.tsdk": "portalen/node_modules/typescript/lib"
}
}
Loading
Loading