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-enhanced-navigation
Advanced tools
Readme
A plugin for ESDoc that replaces the left-hand navigation / class browser with an enhanced version which includes a folder accordion, a context menu that opens associated Github / NPM links and support for grouping managed packages via JSPM (and soon NPM) in separate sections from the local source.
Installation steps:
esdoc
in devDependencies
in package.json
.esdoc-plugin-enhanced-navigation
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 toolchain please see typhonjs-npm-build-test for a NPM package which contains several dependencies for building / testing ES6 NPM modules including all TyphonJS ESDoc plugins. A separate package only containing the TyphonJS ESDoc plugins is also available: typhonjs-node-esdoc
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-enhanced-navigation
the following is an example integration including JSPM support via esdoc-plugin-jspm
for package.json
:
{
...
"devDependencies": {
"esdoc": "^0.4.0",
"esdoc-plugin-enhanced-navigation": "^0.1.0",
"esdoc-plugin-jspm": "^0.6.0", // Optional if using JSPM
"jspm": "^0.16.0" // Optional if using JSPM
},
"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" }, // Optional if using JSPM
{
"name": "esdoc-plugin-enhanced-navigation",
"option:
{
"showAllFiles": "true" // (Optional) If set to true then all doc tags will show the associated file name; default is false.
}
}
]
}
esdoc-plugin-enhanced-navigation
accepts the following configuration option:
By default for folders where all files export a single default or named export which matches the file name then the file name for this single export is hidden. This is useful for efforts like TyphonJS which has a strict naming policy where each file only has a default export which matches the file name.
Given the NPM script defined in package.json
then simply run npm run esdoc
.
Below is a demo image of the replaced left-hand navigation. A few of the pertinent details include that the local source is grouped at the top section with any JSPM / NPM managed source code grouped in follow up sections. For folders where all files export a single default or named export which matches the file name the file name is omitted. While not pictured a context click on folders and source code 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 uses italic styling with the aliased name followed by the actual package name in parentheses.
FAQs
Replaces the standard ESDoc left-hand source navigation with an enhanced version.
The npm package esdoc-plugin-enhanced-navigation receives a total of 31 weekly downloads. As such, esdoc-plugin-enhanced-navigation popularity was classified as not popular.
We found that esdoc-plugin-enhanced-navigation 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.