Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
esdoc-plugin-dependency-graphs
Advanced tools
Changelog
0.1.0 (2016-06-01)
0.2.0
.Readme
A plugin for ESDoc that adds D3 interactive dependency graphs for packages and source code managed by JSPM / SystemJS and soon NPM. A context menu is available that opens associated Github / NPM links.
Please note that this plugin is in heavy development and currently only JSPM package dependency graphs are available. You must use esdoc-plugin-jspm version 0.6.6 or higher for this plugin to work.
Installation steps:
esdoc
in devDependencies
in package.json
.esdoc-plugin-dependency-graphs
in devDependencies
in package.json
.devDependencies
in package.json
..esdocrc
or esdoc.json
configuration file adding the plugin..esdocrc
or esdoc.json
configuration file in all JSPM managed packages to link.For more information view the ESDoc tutorial and ESDoc Config documentation.
It should be noted that all TyphonJS repos now are standardizing on .esdocrc
for the ESDoc configuration file. Both .esdocrc
and esdoc.json
are supported by the esdoc-plugin-jspm
and forthcoming esdoc-plugin-npm
plugin.
As an alternate and the preferred all inclusive installation process please see typhonjs-npm-build-test for a NPM package which contains several dependencies for building / testing ES6 NPM modules including ESDoc generation with the following plugins including esdoc-plugin-jspm, esdoc-plugin-extends-replace.
Please note that the next release of typhonjs-npm-build-test
will include esdoc-plugin-dependency-graphs
and presently it is not included. When esdoc-plugin-dependency-graphs
reaches 0.1.0
it will be included in typhonjs-npm-build-test
version 0.2.0
.
Additionally typhonjs-core-gulptasks provides a NPM package which contains several pre-defined Gulp tasks for working with JSPM / SystemJS, ESLint and ESDoc generation.
For the latest significant changes please see the CHANGELOG.
If installing and working directly with esdoc-plugin-dependency-graphs
the following is an example integration including JSPM support via esdoc-plugin-jspm
for package.json
:
{
...
"devDependencies": {
"esdoc": "^0.4.0",
"esdoc-plugin-dependency-graphs": "^0.0.3",
"esdoc-plugin-jspm": "^0.6.0",
"jspm": "^0.16.0"
},
"scripts": {
"esdoc": "esdoc -c .esdocrc"
},
"jspm": {
"main": "<main entry point>",
"dependencies": {
...
},
"devDependencies": {
...
}
}
}
And the .esdocrc
or esdoc.json
configuration file:
{
"title": "<title>",
"source": "src",
"destination": "docs",
"plugins":
[
{ "name": "esdoc-plugin-jspm" },
{ "name": "esdoc-plugin-dependency-graphs" }
]
}
Given the NPM script defined in package.json
then simply run npm run esdoc
.
Below is a demo image of the JSPM dependency graph generated for the backbone-parse-es6
Github package loaded via JSPM. While not pictured a context click on graph nodes opens a context menu which will provide links to Github or NPM depending on the code being managed. For the context menu links to work for NPM packages you must include the repository field in package.json
. JSPM currently supports packages from Github and NPM; Github packages are colored orange and NPM packages are colored light red. Aliased JSPM packages where the assigned name does not match the package name the package / folder is red. In the overflow menu options you may show a table view of all packages and show / hide aliased packages names.
FAQs
A plugin for ESDoc that adds interactive D3 powered dependency graphs for source code including linking JSPM / NPM managed code and packages.
The npm package esdoc-plugin-dependency-graphs receives a total of 5 weekly downloads. As such, esdoc-plugin-dependency-graphs popularity was classified as not popular.
We found that esdoc-plugin-dependency-graphs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.