Skip to content
forked from navikt/nav-faker

nav-faker er et bibliotek som lar deg generere opp norske testdata.

License

Notifications You must be signed in to change notification settings

Quist/norsk-faker

 
 

Repository files navigation

nav-faker npm version Build Status Maintainability Test Coverage

nav-faker er et lite bibliotek som lar deg generere opp norske testdata. Biblioteket er under utvikling.

Planen er å implementere støtte for generering av tilfeldige:

  • Fødselsnummere / d-nummere
  • Adresser
  • Navn
  • Tall og datoer

Install

npm

npm install --save nav-faker

yarn

yarn add nav-faker

Usage

React / Javascript

import navfaker from 'nav-faker/dist/index';

navfaker.personIdentifikator.fødselsnummer(); // => 10108000398

Test det ut

https://repl.it/@Quist/nav-faker-demo

API

Summary

nav-faker har følgende moduler:

  • dato
  • personIdentifikator
  • random
  • person
  • telefon

Dato

    mellom(fra: Date, til: Date): Date;
    forÅrSiden(årSiden: number): Date;

PersonIdentifikator

    fødselsnummer(fødselsdato?: Date, kjønn?: number): string;
    dnummer(fødselsdato?: Date, kjønn?: number): string;
    myndigFødselsnummer(kjønn?: number): string;
    getFødselsdato(fødselsnummer: string): Date;

Person

    kjønn(): number;
    antallBarn(fødselsdato: Date): number;

Random

    number(max?: number, min?: number): number;
    vektetSjanse(vekt: number): boolean;

Telefon

    mobil(): string;
    jobb(): string;

Bidra?

Kom gjerne med innspill, ønsker og pull-requester!

nav-faker er skrevet i typescript og kompileres ned til javascript. Dette kan da dras inn som en avhengighet av andre applikasjoner. nav-faker er satt opp med et CI bygg på travis.

Oppsett

Installer dependencies: yarn

Bygg og linting med: yarn build

Test

yarn test

Committe

Vi bruker verktøyet semantic-release for å bestemme når og hvilken versjon som skal publiseres til NPM. Verktøyet analysere commit-meldinger for å bestemme om patch, minor eller major versjon skal publiseres.

Du bør derfor følgende gjeldene commit-message convention. For enkelhetskyld kan du installere commitizen som interaktivt hjelper deg å skrive commit-meldinger: yarn global add commitizen

Når du ønsker å commite: yarn commit

Publisering til NPM

Når kode merges inn i master, analyseres semantic-release commit-meldingene siden forrige publish til NPM. Basert på innholdet i meldingene, bestemmes om og isåfall hvordan versjon som skal publiseres.

Filosofi

nav-faker baserer seg på marak/faker. Mockingen deles inn i moduler, .f.eks fødselsnummer, dato og person. I utgangspunktet er planen å kun støtte å generere mock-data, ikke et util bibliotek.

Henvendelser

Spørsmål knyttet til koden eller prosjektet kan rettes mot:

For NAV-ansatte

Interne henvendelser kan sendes via Slack i kanalen #team-oppfølging.

About

nav-faker er et bibliotek som lar deg generere opp norske testdata.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 98.2%
  • JavaScript 1.8%