Local Development

Local development is handled with VuePress (opens new window), which generates a static site based on the markdown and configuration defined in /docs.

Getting Setup

This repo uses pre-commit for pre-commit checks. Install here (opens new window). Note: If developing on Windows, first make sure that Python is installed. Instructions here (opens new window)

After you have pre-commit installed, run the following from the root of the repo:

$ pre-commit install
$ pre-commit install --hook-type commit-msg

Setup VsCode

• install ESLint
• install Vetur
• install TypeScript hero

Linting

This repo uses eslint to lint ts, js and vue files. Linting will need to pass for commits to be pushed and for PR's to build successfully.

You can set up your VsCode editor to auto fix linting errors on save. Edit your settings by going to VsCode > Preferences > Settings > Extensions > JSON > Edit in settings.json. Then add the following to your config:

{
  ...
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  },
  "eslint.validate": ["css", "vue", "html", "javascript", "typescript"],
  ...
}

If you want to lint manually you can run npm run lint to get all the linting errors or npm run lint -- --fix to auto fix them.

Setup Node Packages

Follow install instructions in Local Development Environment Setup (opens new window).

# install dependencies
$ nvm use
$ npm i

If running into problems with nvm use, you may need to install the package manually. Check the version in the .nvmrc (opens new window) file.

# windows - as administrator
$ nvm install 14.16.1 # you only need to do this once
$ nvm use 14.16.1

Build Components

Build the component library. Since there is no hot reloading yet, you must build each time to see your changes.

$ npm run build

Serve VuePress

Serve the VuePress docs locally with hot reload at localhost:3000.

$ npm start

Git hook

The project runs npm test, npm run build, and npm run docs:build on pre-push so that if any of the commands failed the push won't happen. It can be overridden with git push --no-verify.