Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.57 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.57 KB
Raw

Monaco JSON Editor

A JSON editor using the Monaco editor.

Provides a JSONEditor component wrapping the Monaco editor with sane defaults.

Run CI build and tests NPM Version

Contributing

Contributions that do not provide a direct benefit to the Open Forms project will unfortunately be rejected, as we do not have the ambition nor resources to maintain these.

For (code) contributions that do fit the goals of this library, please follow these guidelines:

  • Create an issue with a description of the problem or required feature
  • Reference the issue ID in commit messages and pull requests
  • Functionality must be documented in Storybook
  • Functionality must be covered by tests - Jest (unit/integration) tests and/or Storybook interaction tests

Getting started

  1. Clone the repository and then ensure you use the correct node version:
nvm use
  1. Start Storybook in dev mode for component development:
npm start

  1. Make code changes, check in Storybook, add tests... etc.

  2. Run the tests (Storybook needs to be running still!)

npm test
  1. Check that the (Typescript) build compiles cleanly:
npm run build:esm

Additional NPM scripts can be found in package.json.