LitElement custom element that wraps http://github.com/josdejong/jsoneditor based on https://github.com/Juicy/juicy-jsoneditor
npm install fleshy-jsoneditor
LitElement custom element that wraps josdejong/jsoneditor.
It is an updated version of juicy-jsoneditor
This webcomponent follows the open-wc recommendation.
``bash`
npm i fleshy-jsoneditor
`html
`
It uses josdejong/jsoneditor as devDependency, as jsoneditor does not export a ES module. So, for build, it is necessary primary to use rollup and generate jsoneditor files with ES module exports. It also copy some style and svg files, as it needs them to render the editor.
To update the files (located in /lib folder), run
`bash`
npm run build-deps
To scan the project for linting errors, run
`bash`
npm run lint
You can lint with ESLint and Prettier individually as well
`bash`
npm run lint:eslint
`bash`
npm run lint:prettier
To automatically fix many linting errors, run
`bash`
npm run format
You can format using ESLint and Prettier individually as well
`bash`
npm run format:eslint
`bash`
npm run format:prettier
To run the suite of karma tests, run
`bash`
npm run test
To run the tests in watch mode (for TDD, for example), run
`bash`
npm run test:watch
To run a local instance of Storybook for your component, run
`bash`
npm run storybook
To build a production version of Storybook, run
`bash`
npm run storybook:build
`bash`
npm start
To run a local development server that serves the basic demo located in demo/index.html
To release a new version, once all PRs were merged into master, it is just necessary to execute:
`bash`
npm run release
This script will generate new tag, update version in package.json and update changelog file with latest changes.
Once finish, it is just necessary to push the new commit to master. You can do it manually (but remember to push the tags also)
or use the script
`bash``
npm run push
Once the origin master branch is updated, a GitHubAction will take care of it. It will deploy the storybook in Netlify and publish the package in NPM.