@stepsize/shared-types

Important notices 🔔

• You need an npm account: https://www.npmjs.com/, and you need to be invited to the Stepsize organisation: https://www.npmjs.com/settings/stepsize/members

• Using enums exported from the shared-types is currently not supported. Instead, we duplicate enums in various places: shared-types/internal-enums -- to be used inside the shared package, in tyrion/types.ts to be used inside of tyrion and podrick/webview/shared/types.ts to be used inside of podrick.

How to dev (to be improved):

If testing in tyrion:

• edit files in shared-packages folder and import them using import { IncidentAttributes } from '@stepsize/shared-types/entities/Incident'

If testing in a different repo:

• make changes, run yarn build in shared-types directory, or yarn shared-types:build in tyrion

• in another project run yarn add /Users/kamil/tyrion/shared-types (with your local shared-types path) or create a proper symlink to avoid this weird link

• you can now import things from shared-types: import { IncidentAttributes } from '@stepsize/shared-types/entities/Incident'

How to publish:

• update the version in package.json

• commit, push and make a GitHub release (ideally add a few words to the release description)

• run npm publish --access public