sprotty-vscode-webview

v1.0.0

Integration of Sprotty in a VS Code extensions (WebView part) For more information about how to use this package see README

Latest version published 1 year ago

License: EPL-2.0

NPM

GitHub

Package Health Score

68 / 100

security
No known security issues
popularity
Limited
maintenance
Sustainable
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
1.0.0	\|	11/2023	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.5.0	\|	12/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.4.0	\|	11/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.3.1	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.0	\|	12/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

EPL-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (156)

GitHub Stars: 58
Forks: 24
Contributors: 10

Direct Usage Popularity

The npm package sprotty-vscode-webview receives a total of 156 downloads a week. As such, we scored sprotty-vscode-webview popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package sprotty-vscode-webview, we found that it has been starred 58 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 10
Funding: No

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 2
Open PR: 1
Last Release: 1 year ago
Last Commit: 1 month ago

Further analysis of the maintenance status of sprotty-vscode-webview based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

An important project maintenance signal to consider for sprotty-vscode-webview is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 4 Direct
Versions: 30
Install Size: 169 kB
Dist-tags: 3
# of Files: 84
Maintainers: 5
TS Typings: Yes

sprotty-vscode-webview has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Sprotty Diagrams in VS Code Webviews

This library helps you to implement a VS Code webview that displays a Sprotty diagram. You can use sprotty-vscode to integrate such a webview in a VS Code extension.

Getting Started

The diagram itself is implemented with the Sprotty API. See the Sprotty Wiki, the states example and the Sprotty examples for reference.

The next step is to implement a subclass of SprottyStarter and instantiate it in your entry module as shown below.

export class ExampleSprottyStarter extends SprottyStarter {
    createContainer(diagramIdentifier: SprottyDiagramIdentifier) {
        return createExampleDiagramContainer(diagramIdentifier.clientId);
    }
}

new ExampleSprottyStarter().start();

Don't forget to call the start method, which initiates the communication to the host extension.

The function createExampleDiagramContainer should create an InversifyJS container with all necessary Sprotty configuration. The passed clientId should be used in the baseDiv and hiddenDiv ids in Sprotty's ViewerOptions.

In case you are connecting your diagram with a language server, e.g. using Langium, you should use SprottyLspEditStarter as superclass.

sprotty-vscode-webview dependencies

sprotty sprotty-vscode-protocol vscode-messenger-webview vscode-uri

FAQs

What is sprotty-vscode-webview?

Integration of Sprotty in a VS Code extensions (WebView part). Visit Snyk Advisor to see a full health score report for sprotty-vscode-webview, including popularity, security, maintenance & community analysis.

Is sprotty-vscode-webview popular?

The npm package sprotty-vscode-webview receives a total of 156 weekly downloads. As such, sprotty-vscode-webview popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is sprotty-vscode-webview well maintained?

We found indications that sprotty-vscode-webview maintenance is sustainable demonstrating some project activity. We saw a total of 10 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is sprotty-vscode-webview safe to use?

The npm package sprotty-vscode-webview was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 17 December-2024, at 19:33 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP