Installations
npm install @jsonforms/examples
Score
79.4
Supply Chain
83.3
Quality
91.7
Maintenance
100
Vulnerability
99.6
License
Developer
Developer Guide
Module System
CommonJS
Min. Node Version
Typescript Support
No
Node Version
18.20.4
NPM Version
10.7.0
Statistics
2,224 Stars
1,516 Commits
373 Forks
34 Watching
9 Branches
111 Contributors
Updated on 26 Nov 2024
Bundle Size
233.65 kB
Minified
55.26 kB
Minified + Gzipped
Languages
TypeScript (86.33%)
Vue (11.25%)
JavaScript (1.47%)
CSS (0.55%)
HTML (0.22%)
Shell (0.14%)
Dockerfile (0.04%)
Total Downloads
Cumulative downloads
Total Downloads
226,165
Last day
-35.7%
258
Compared to previous day
Last week
-8.3%
1,802
Compared to previous week
Last month
10.9%
8,839
Compared to previous month
Last year
44.6%
87,042
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Peer Dependencies
1
JSON Forms - More Forms. Less Code
Complex forms in the blink of an eye
Documentation
Please see the official JSON Forms website, jsonforms.io, for documentation, examples and API references.
Getting started
- Clone the seed app with
git clone https://github.com/eclipsesource/jsonforms-react-seed.git
- Install dependencies with
npm ci
- Run the app with
npm run start
For more info about the seed app, please see the corresponding README file of the seed repo. For a more detailed tutorial about the usage of JSON Forms, please see this tutorial.
Feedback, Help and Support
If you encounter any problems feel free to open an issue on the repo. For questions and discussions please use the JSON Forms board. You can also reach us via email. In addition, EclipseSource also offers professional support for JSON Forms.
Migration
See our migration guide when updating JSON Forms.
Roadmap & Milestones
The project roadmap can be found in ROADMAP.md.
Issues are sorted in one the following milestones that indicate when their implementation is planned. Independently of the assigned milestone, contributions are always accepted and appreciated.
- A milestone for the next minor version. Issues planned to be implemented for the next release.
- A milestone for the next major version. Issues planned to be implemented for the next major release.
- A
.x
milestone. Issues which are concrete candidates for one of the next versions. - next: Issues which we would like to tackle soonish in one of the upcoming versions. However, they are not yet planned for a specific version.
- Backlog: Issues which are interesting in some form but we don't plan to do ourselves in the foreseeable future. Still these might become part of JSON Forms via a community contribution or by prioritization of a paying customer.
Developers Documentation
First time setup
- Install node.js (only Node v18.19+ < 19 is currently supported)
- Install pnpm: https://pnpm.io/installation (use pnpm 8.6.2+)
- Clone this repository
- Install dependencies:
pnpm i --frozen-lockfile
VS Code dev container
As an alternative to the first time setup, you can use the provided VS Code dev container configured in devcontainer.json.
- Execute command:
Remote Containers: Reopen in container
- Wait until the container is built and loaded
- First time setup and an initial build of all packages has been executed in the container
Note: If you have installed dependencies before opening the remote container, its initialization might fail.
In this case, you can try to clean the repository with git clean -dfx
. Beware that this removes all untracked files!
Build & Testing
- Build (all packages):
pnpm run build
- Test (all packages):
pnpm run test
- Clean (delete
dist
folder of all packages):pnpm run clean
- Run React Vanilla examples:
cd packages/vanilla-renderers && pnpm run dev
- Run React Material examples:
cd packages/material-renderers && pnpm run dev
- Run Angular Material examples:
cd packages/angular-material && pnpm run dev
- Run Vue Vanilla dev setup:
cd packages/vue-vanilla && pnpm run serve
- Run Vue Vuetify dev setup:
cd packages/vue-vuetify && pnpm run dev
Dependency & Release management
For more info about how we handle dependencies and releases in the JSON Forms project, please see our Developer Documentation wiki page.
Continuous Integration
The JSON Forms project is built and tested via Github actions on Linux, Mac and Windows. Coverage is documented by Coveralls.
Contributions
We welcome community participation! Whether you're reporting bugs, proposing features, participating in discussions, or making direct contributions, your involvement is highly valued. See here for the contribution guidelines.
License
The JSON Forms project is licensed under the MIT License. See the LICENSE file for more information.
No vulnerabilities found.
Reason
12 commit(s) and 7 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yaml:24
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
Found 18/27 approved changesets -- score normalized to 6
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: jobLevel 'contents' permission set to 'write': .github/workflows/publish.yaml:26
- Warn: no topLevel permission defined: .github/workflows/ci.yaml:1
- Warn: no topLevel permission defined: .github/workflows/publish.yaml:1
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/eclipsesource/jsonforms/ci.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yaml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/eclipsesource/jsonforms/ci.yaml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/eclipsesource/jsonforms/ci.yaml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yaml:65: update your workflow using https://app.stepsecurity.io/secureworkflow/eclipsesource/jsonforms/ci.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yaml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/eclipsesource/jsonforms/publish.yaml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yaml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/eclipsesource/jsonforms/publish.yaml/master?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/publish.yaml:45: update your workflow using https://app.stepsecurity.io/secureworkflow/eclipsesource/jsonforms/publish.yaml/master?enable=pin
- Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:5
- Info: 0 out of 4 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 3 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 containerImage dependencies pinned
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 22 are checked with a SAST tool
Reason
23 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-8hc4-vh64-cxmj
- Warn: Project is vulnerable to: GHSA-qwcr-r2fm-qrc7
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-pxg6-pf52-xh8x
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747
- Warn: Project is vulnerable to: GHSA-qw6h-vgh9-j6wx
- Warn: Project is vulnerable to: GHSA-pfq8-rq6v-vf5m
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3
- Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2
- Warn: Project is vulnerable to: GHSA-9wv6-86v2-598j
- Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg
- Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
- Warn: Project is vulnerable to: GHSA-g3ch-rx76-35fx
- Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q
- Warn: Project is vulnerable to: GHSA-776f-qx25-q3cc
Score
4.7
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More