Research
Security News
Quasar RAT Disguised as an npm Package for Detecting Vulnerabilities in Ethereum Smart Contracts
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
overview-tools
Advanced tools
High level overviews are awesome; they make projects friendly in an instant. Explaining and displaying your project your project makes it easy for users & contributors to understand your project.
overview-tools
is a simple npm
-available module written in ES6
that makes it downright, super-darn, i-dare-say, quite easy to build a
friendly overview for your project.
Add an OVERVIEW
file to your project — alongside your
README
, CONTRIBUTING
, LICENSE
, etc
overview-tools/
this is an example comment
it's indented 4 spaces under it's parent
comment away!
overview-tools/bin/
overview-tools/bin/overview-tools
overview-tools/src/
overview-tools/src/converters/
overview-tools/src/converters/json-to-html.js
...cut for brevity...
this file is readable, maintainable, and straightforward as plain-text, but it gets better:
add one line to your package.json
...
"scripts": {
"overview": "./node_modules/.bin/overview-tools ./OVERVIEW --to tree"
},
...
now new users can npm run overview
there's a cli and js modules so you can use/extend it to your taste.
building a boilerplate for your project (from a directory)
overview-tools ./project-path/
fancy outputs (from a file)
overview-tools ./project-path/OVERVIEW --to tree # a clean utf8 tree
tree.whitespace # just plain ol indents
tree.basic # instead of utf8 fanciness, just use ascii
html # html with a bunch of classes and ids
overview # the overview format
markdown # mmmmmm, mmmmarkdown
json # used internally, maybe kinda useful?
for functional fans
import overviewFunctions as oFun from 'overview-tools';
// going to json
oFun.dirTreeToJSON(pathToDirectory)
oFun.fileToJSON(pathToOverviewFile)
oFun.overviewToJSON(overviewSourceText)
// different output formats
oFun.JSONToHTML(jsonDirectoryTree)
oFun.JSONToOverview(jsonDirectoryTree)
oFun.JSONToMarkdown(jsonDirectoryTree)
oFun.JSONToTree(jsonDirectoryTree)
and for the OOP crowd
import {Overview} from 'overview-tools';
let myProj = new Overview(pathToOverviewFile);
myProj.toOverview()
myProj.toMarkdown()
myProj.toHTML()
myProj.toTree()
myProj.toJSON()
FAQs
tools for intuitive, clear project structure documentation
The npm package overview-tools receives a total of 1 weekly downloads. As such, overview-tools popularity was classified as not popular.
We found that overview-tools 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.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.
Security News
Research
A supply chain attack on Rspack's npm packages injected cryptomining malware, potentially impacting thousands of developers.
Research
Security News
Socket researchers discovered a malware campaign on npm delivering the Skuld infostealer via typosquatted packages, exposing sensitive data.