Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
98 lines (66 loc) · 2.39 KB

DEVELOPMENT.md

File metadata and controls

98 lines (66 loc) · 2.39 KB

Developing @ory/elements-react

Ory Elements is built inside this monorepo and hooked up to the other packages via nx and npm workspaces.

To start a hot reloading development mode:

npx nx dev @ory/elements-react

API Extractor

To make sure there are no unintended changes to the API contract, we use API Extractor to generate API reports, that are checked into the repository. The CI of each PR includes a check that this API report would not change after merging the PR.

If the report would change, the CI fails. If that happens, you can re-generate all reports by running

npx nx api-extractor-refresh @ory/elements-react

Inspect the resulting changes carefully, and make sure it is in line with what you expected. Add the changes to your PR.

Tests

Unit tests use Jest and react-testing-library. To run the tests locally, execute:

npx nx build @ory/elements-react

Test selectors

To select DOM elements use a data-testid selector. Nomenclature mandates / as separators and a prefix of ory/:

  • ory/form/ is the prefix for form elements;
  • ory/screen/ is the prefix for elements on specific screens;
  • ory/screen/ is the prefix for translatable messages (e.g. validation errors).

Stories

Each flow has its own story in the packages/elements-react-stories package. To run the storybook development environment, execute:

npx nx storybook @ory/elements-react

You can also build the Storybook using:

npx nx build @ory/elements-react

The stories use stub responses

Releasing

@ory/elements-react and @ory/nextjs are released using nx releases.

Preparation:

Check https://www.npmjs.com/package/@ory/elements-react for the latest released version and determine what kind of version you want to release.

This is necessary, because of Ory's monorepo setup, and nx needing to push the resulting change of package.json to master to automatically determine which version to release!

:::note

Ory Internal only: Run these command in a local clone of @ory/elements!

:::

npx nx build @ory/elements-react
npx nx release -g elements 1.0.1-rc.0 --dry-run
# if okay:
npx nx release -g elements 1.0.1-rc.0

# or

npx nx build @ory/nextjs
npx nx release -g nextjs 1.0.1-rc.0 --dry-run
# if okay:
npx nx release -g nextjs 1.0.1-rc.0

Don't commit any of the results and just re-set git to the previous commit.