cvs-type-definitions
/
1.0.5
cvs-type-definitions 1.0.5
Install from the command line:
Learn more about npm packages
$ npm install @dvsa/cvs-type-definitions@1.0.5
Install via package.json:
"@dvsa/cvs-type-definitions": "1.0.5"
About this version
json schema and .ts type definitions for cvs vta application
- Ensure consuming repo is set up to install private DVSA packages by adding the following to the
.npmrc
file:@dvsa:registry=https://npm.pkg.github.com
- install GitHub package:
npm install @dvsa/cvs-type-definitions@latest
import { CommercialVehicleTestSchema } from @dvsa/cvs-type-definitions/types/test
Edits should only be made to json
schema definitions within json-definitions
directory. TypeScript interfaces will be generated from these files
- Navigate into the relevant schema (ie. mes-test-schema)
- Edit file
- Generate the new TypeScript definitions using
npm run generate
- Bump the version of the package using
npm version {major|minor|patch}
- Publish updates
- Create a new subdirectory with an appropriate name within the
json-defininitions
directory (e.g.my-new-schema
) - Add an
index.json
file to the new directory with appropriate json schema definitions - Add the new schema name to the
schemas
constant array in./schemas.ts
NOTE: this MUST match the directory name created at step 1 (my-new-schema
in the example here) - Generate the new TypeScript definitions using
npm run generate
- Bump the version of the package using
npm version {major|minor|patch}
- Publish updates
- Raise a Pull Request on Github and await approvals
- Once merged, publish the new package from the latest
develop
branch to GitHub packages usingnpm publish
- _You must be logged in and have the correct permissions to publish to the package