@oslokommune/punkt-cli

Bruk av punkt-cli

OBS! Denne pakken er veldig utdatert og det er ingen situasjoner hvor du skulle trenge å bruke den.

Punkt har fått et kommandolinjeverktøy; punkt 🥳 for bruk i
terminalen eller scripts.

OBS: Denne pakken er utdatert og vi anbefaler å heller bruke manuelle prosesser og CDN som beskrevet på våre nettsider.

📝 Forutsetninger

Node >= 20.19.1 installert

Installasjon

``sh
npm install -g @oslokommune/punkt-cli
`

Tilgjengelige kommandoer

- punkt gir deg en oversikt over kommandoene og options.
- punkt init initierer designsystemet for bruk i din applikasjon.
Lager også en pkt.config.json fil basert på valg som tas i oppsettet.
- punkt svg sprite generer svg sprites basert på punkt.config.json.

$3

Denne kommandoen initierer designsystemet.

Fordeler

- Oppretter konfig-filen for deg.
- Gir deg muligheten til å installere andre pakker i designsystemet.
- Legger til grunnleggende SVG-ikoner i appen din, om du ønsker.
- Gir deg personaliserte tips basert på dine svar og package.json i applikasjonen
din.

punkt.config.json kan eksempelvis se slik ut:

`json
{
"svgsprite": {
"files": [
/ SVG-filer i svgsprite / "../assets/src/icons/check.svg",
"../assets/src/icons/24h.svg",
"../assets/src/icons/share.svg"
],
"output": {
"fileType": "html" / html|svg /,
"filePath": "./index.html" / sti til destinasjonsfilen /
}
}
}
`

$3

Komponentbibliotekene i Punkt designsystem forutsetter at en såkalt SVG Sprite eller
SVG Symbols er tilgjengelig på siden. Det kan du lese mer om her:
Multi-Colored SVG Symbol Icons with CSS Variables.

Denne kommandoen genererer en slik svgsprite for deg. Den trenger at
designsystemet er initiert.

Kommandoen er avhengig av følgende verdier i konfig:

- svgsprite.files --> Array med stier til SVG ikoner.
- svgsprite.output.fileType --> Streng bestående av en av disse verdiene:
- html - svgsprite inlines i et element i en html-fil (se under).
- svg - svgsprite skrives i en SVG-fil.
- svgsprite.output.filePath --> Streng bestående av sti til output-filen.

MERK! Om du velger å inline i en HTML-fil skal du legge til dette elementet«:

`html


`html


Punkt` er distribuert under MIT-lisens for åpen kildekode.

!NPM License