1.0.0 • Published 4 years ago

ci-common-ui v1.0.0

Weekly downloads
-
License
-
Repository
-
Last release
4 years ago

#Introduction

#Start

  • npm i
  • npm start (work against dev2)
  • OR
  • npm run dev-mock (work against mock server)
  • OR
  • npm run storybook (work with storybook UI library)

#Test

  • Run tests: npm test
  • Run specific test: npm test someFileName.js (regex)
  • Update snapshot test: npm test -- -u someFileName.js (regex)

#General Conventions

  • Mocks: only mock.json (No *.ts) files as a sibling to the test/logic files
  • Test files: should be the same as it's sibling file-name.js -> file-name.test.js
  • Exports: from file itself (No index.ts which exports *)
  • Constants: /constants folder with files divided by categories
  • Utils: /utils folder with files divided by categories

#Naming Conventions

  • Folder names: kebab-case
  • File names: kebab-case
  • Vars/Functions/etc: camelCase
  • Of course there are exceptions which should be decided (e.g: class file should be CapitalCase)