Ft.Datafangst.Tool 2.1.16

FT-Tool 🔧

Er et CLI verktøy for med ulike kommadoer som gjør det lettere og mer effektivt å jobbe med Altinn repoer lokalt.

Installering

For å installere ft-tools må man kjøre følgende:

dotnet tool install --global Ft.Datafangst.Tool

Denne laster ned ft-tools globalt, som gjør at den vil være tilgjengelig i alle repoer du har.

Oppdateringer kommer relativt ofte så derfor er det anbefalt å kjøre

dotnet tool update --global Ft.Datafangst.Tool

for å få med seg siste versjon av tools.

Hvordan bruke FT-Tool

Noen av verktøyene under krever at du kjører cd .\App\ fra root før du kjører kommandoene.

Alle verktøy skal ha støtte for både v3 og v4 av frontend.

Snippets

Snippets brukes for å fylle inn kode fra predefinerte maler.

For å bruke snippets kan du enten konfigurere disse selv eller kjøre:

ft-tool snippets

Denne henter og legger til snippets (foreløpig kun for VSCode). Snippets som er brukt er definert her, og kan endres på lokalt dersom man ønsker.

Summary

For å få ferdigskrevet oppsummeringsside for appen din kan du kjøre:

ft-tool summary

Denne vil generere en Summary.json med alle feltene som er i din layout-mappe. Den inkluderer ikke Alert komponenter, men alle titler og paragrafer vil inkluderes.

Grid

Dersom man ønsker å stille komponentene på følgende måte med spørsmål og svarboks på samme linje kan man bruke grid.

Ved å kjøre:

ft-tool grid

legges det på grid-styling med følgende konfigurasjon

{
  "grid": {
    "labelGrid": {
      "sm": 5
    },
    "innerGrid": {
      "sm": 7
    }
  }
}

i alle layout-filer for Input- og Dropdown-komponentene.

Nynorsk

For å oversette appen fra bokmål til nynorsk kan du kjøre:

ft-tool nynorsk

Dette vil generere en ny ressursfil, resource.nn.json, som inneholder alle tekstressursene i resource.nb.json oversatt til nynorsk.

Verktøyet benytter Apertium, et oversettingsprogram, til å oversette alt av tekster. Denne er ikke alltid perfekt, så det anbefales å dobbelsjekke resultatet fra oversettingen manuelt.

Dersom du trenger at en spesifik tekst ikke blir oversatt, opprett en fil som heter ignore.nn.json i samme mappe som språkfilene. Denne må inneholde en liste over de tekstene som ikke skal bli oversatt. Eksempel:

[
  "1-2-Input.title",
  "1-4-Input.title"
]

TekstRens

Dersom man ønsker å fjerne ubrukte tekstressurser fra språkfilene, kan man bruke tekstrens. Dette holder filen litt mer ryddig.

ft-tool tekstrens

NB: Tekstressurser som brukes i logikk-mappene vil også fjernes. Tekster som er lagt til programatisk, som f. eks i dynamiske uttrykk vil også fjernes. Men vi ser på støtte for dette.

Schema Injector

Alle layoutfiler følger et statisk $schema som angir reglene for hvordan komponenter skal legges til, hva som er obligatorisk å ha med, riktig verdier å bruke for ulike parametere og liknende. De som brukes per i dag, mangler derimot regler for feltet datamodelBindings, nemlig fordi den er dynamisk og endres fra skjema til skjema. Ved å bruke:

ft-tool schemaInjector

vil det bli laget et midlertidig $schema. Dette muliggjør IntelliSense/auto-complete for verdier i datamodelBindings, som baserer seg på datamodellen sin struktur i model.cs filen. Dermed får man også advarsel dersom man bruker noe som ikke er tillatt i datamodelBindings.

NB: Skal kun brukes under utvikling. Når man er ferdig med utvikling må man kjøre

ft-tool schemaInjector --revert

for å tilbakestille til opprinnelig schema (fra Altinn CDN) og slette midlertidig schema-fil.

Text Resource Generator

Dersom man ønsker å ha flere filer til å ha tekstressursene i, så kan man bruke:

ft-tool textGenerator

Denne genererer en språkfil fra flere delfiler. Dette betyr at du kan jobbe med mindre filer og kombinere dem sammen med dette værktøyet. Du trenger en ny mappe i text mappen med navn "nb". Pathen til denne blir da App/config/texts/nb. Inne i denne kan du skrive så mange språkfiler som du vil så lenge de har strukturen til en standard språkfil. dvs.

{
  "resources": [
    {
      "id": "appName",
      "value": "KRT-1116 Søknad om vedtektsendring for finansforetak og finansstiftelser"
    }
  ]
}

Det er også mulig å legge på "kommentarer" ved å legge på ekstra json attributter for hver språk komponent.

{
  "resources": [
    {
      "id": "1-Header.title",
      "value": "**1. Generelle opplysninger**",
      "comment": "here is a comment"
    }
  ]
}

Man kan også sette "ignore" på språk komponentene som betyr at neste gang man kjører oversetteren vil de komponentene bli ignorert dersom det allerede finnes en oversatt versjon av komponenten på det oversatte språket.

{
  "resources": [
    {
      "id": "1-Header.title",
      "value": "**1. Generelle opplysninger**",
      "ignore": ["nn"]
    }
  ]
}

Validate

Validerer appen

ft-tool validate

Ikke støtte for ennå.

Lag nuget release

Nuget releaser er basert på git tags, og det er satt opp en workflow som bygger og pusher en ny release til nuget hver gang det kommer en ny tag til github. En ny tag kan enten lages med git lokalt og pushes opp til repo, eller man kan lage en ny release i github gui og i prosessen opprette en ny tag basert på master. Nuget versjonsnummer hentes fra tag, så det er viktig at man bruker rett format. Tag navn skal starte med v og fortsette med [major].[minor].[patch] Typiske eksempler vil da være v1.0.2 og v1.23.3. For at workflow deploy skal virke må det være konfigurert en secret NUGET_API_KEY som inneholder en api nøkkel til finanstilsynets nuget bruker.