Monorepo-struktur og -oppsett

Velkommen! I et monorepo ligger mange prosjekter samlet på ett sted. En tydelig og gjennomtenkt struktur er svært viktig for å holde orden.

Den gjør det enklere for utviklere å finne det de trenger raskt, fremmer gjenbruk av kode og gjør det mye enklere å administrere hele kodebasen etter hvert som den vokser.

På øverste nivå i monorepoet, i rotkatalogen, finner du filer som gjelder hele repositoriet. Tenk på dem som globale innstillinger.

• .git/: Gits interne filer for sporing.
• .gitignore: Forteller Git hvilke filer som skal ignoreres.
• README.md: Hovedbeskrivelsen av monorepoet.
• package.json: (Hvis du bruker Node.js) Skript eller avhengigheter på monorepo-nivå.
• tools/: Globale hjelpeskript.

For å holde orden grupperes prosjekter vanligvis i kataloger på øverste nivå basert på type eller formål. De vanligste er apps/ og packages/ (noen ganger libs/).

• apps/: For applikasjoner som kan distribueres, for eksempel webapper, mobilapper eller API-tjenester.
• packages/ (eller libs/): For gjenbrukbare biblioteker, komponenter eller delte hjelpefunksjoner som flere apper kan bruke.

Denne tydelige inndelingen gjør det enkelt å forstå hvilken rolle et prosjekt har.

Hver mappe i apps/ representerer en separat, selvstendig applikasjon. De har vanligvis sin egen kildekode, konfigurasjon og egne avhengigheter.

monorepo/
├── apps/
│   ├── web-app/         # Your frontend application
│   │   ├── src/
│   │   └── package.json
│   ├── api-service/     # Your backend API
│   │   ├── src/
│   │   └── Dockerfile
│   └── mobile-app/      # Your mobile application
│       ├── src/
│       └── ...
└── ...

Denne strukturen holder hver applikasjon isolert, samtidig som den er en del av det større monorepoet.

I katalogen packages/ (eller libs/) plasserer du all den gjenbrukbare koden. Dette er ofte mindre, fokuserte biblioteker eller UI-komponenter som kan deles mellom flere applikasjoner.

monorepo/
├── packages/
│   ├── ui-components/   # Reusable UI library
│   │   ├── src/
│   │   └── package.json
│   ├── shared-utils/    # Common utility functions
│   │   └── src/
│   └── auth-lib/        # Authentication logic
│       └── src/
└── ...

Dette fremmer gjenbruk av kode og konsistens på tvers av prosjektene.

For å sikre konsistens samler mange monorepoer konfigurasjonsfiler for verktøy som lintere (for kodestil), formatterere (for kodeoppsett) og byggesystemer.

monorepo/
├── .eslintrc.js       # Linter configuration
├── prettier.config.js # Code formatter configuration
├── jest.config.js     # Test runner configuration
├── tsconfig.base.json # Base TypeScript config
└── ...

Disse filene ligger ofte i roten eller i en egen config/-mappe, slik at reglene brukes konsekvent i alle prosjekter.

En veldefinert monorepo-struktur gir betydelige fordeler:

• Gjenfinnbarhet: Nye teammedlemmer kan raskt forstå hvor alt befinner seg.
• Konsistens: Sørger enkelt for ensartede prosjektoppsett og kodestandarder.
• Vedlikeholdbarhet: Gjør refaktorering og håndtering av avhengigheter mye enklere.
• Verktøystøtte: Forenkler oppsettet av bygg- og utviklingsverktøy som støtter monorepoer.

Det er en investering som gir avkastning på lang sikt!

Monorepo-struktur handler om å organisere filer og mapper, men her er et enkelt Java-program som viser hvordan kjørbar kode vises i CoddyKit. Dette hjelper deg med å bli fortrolig med redigeringsverktøyet!

tydelige og konsekvente navn er avgjørende i et monorepo. Det bidrar til å unngå forvirring og gjør kodebasen lettere å lese.

• Kebab-case: Bruk kebab-case for prosjekt- og mappenavn (for eksempel web-app, shared-utils).
• Spesifikke navn: Unngå generiske navn som utils; vær mer spesifikk (for eksempel date-utils, api-client).
• Prefikser: I større organisasjoner kan du vurdere å sette prefiks på delte pakker (for eksempel @myorg/ui-components).

Fantastisk arbeid! I dag har vi lært hvor viktig det er å strukturere et monorepo. Vi har sett på hvordan applikasjoner organiseres i apps/, delte biblioteker i packages/ (eller libs/), og hvordan globale konfigurasjoner sentraliseres.

Et veldefinert oppsett gjør monorepoet enklere å navigere i, mer konsistent og lettere å vedlikeholde. Neste gang skal vi se nærmere på spesifikke verktøy som hjelper med å håndtere disse komplekse strukturene!