Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 3.25 KB

developer.md

File metadata and controls

84 lines (55 loc) · 3.25 KB

Developer documentation

This project is created using the Vite project template for Vue 3 and TypeScript in Vite. The template uses Vue 3 <script setup> SFCs, check out the script setup docs to learn more.

Recommended IDE Setup

Type Support For .vue Imports in TS

TypeScript cannot handle type information for .vue imports by default, so we replace the tsc CLI with vue-tsc for type checking. In editors, we need TypeScript Vue Plugin (Volar) to make the TypeScript language service aware of .vue types.

If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a Take Over Mode that is more performant. You can enable it by the following steps:

  1. Disable the built-in TypeScript Extension
    1. Run Extensions: Show Built-in Extensions from VSCode's command palette
    2. Find TypeScript and JavaScript Language Features, right click and select Disable (Workspace)
  2. Reload the VSCode window by running Developer: Reload Window from the command palette.

E2E testing

For end-to-end testing we use Playwright.

To run end-to-end tests, you have two options:

Option 1: Build and test with preview server (default)

npm run build:e2e
npm run test:e2e

npm run test:e2e will automatically start a preview server, or reuse an existing preview or dev server if one is already running.

Option 2: Use the dev server

npm run dev:e2e
npm run test:e2e

If the dev server is running, npm run test:e2e will reuse it automatically.

Warning

The dev server might time out for certain tests.

Creating a release

Before creating a release make sure that all changes are merged to the main branch.

  1. Update the version number to X.Y.Z

npm:

git checkout main
git pull
npm version X.Y.Z

The last command updates the version in package.json and package-lock.json and creates a git tag vX.Y.Z

lerna:

git checkout main
git pull
lerna version prerelease
    or
lerna version release

The last command updates all packages with the version in package.json and package-lock.json and creates a git tag vX.Y.Z

  1. Push the changes to GitHub
git push
git push origin vX.Y.Z
  1. Create a release on GitHub

Creating a release on GitHub is a manual step. For more information see: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository Create the release from the existing tag we just created. For the title of the release use vX.Y.Z. Use the Generate releasenotes button to list all pull request that are included in this release. When the release is created the Github workflow '.github/workflows/npm-publish' will run automatically to deploy the new version to https://www.npmjs.com/package/@deltares/fews-....