🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more →
Socket
Sign inDemoInstall
Socket
Sign inDemoInstall

api_doc

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

api_doc - npm Package Compare versions

Comparing version

2017.3.9
to
2017.3.10

68

package.json

@@ -1,1 +0,67 @@

{"author":"kai zhu <kaizhu256@gmail.com>","bin":{"apidoc-lite":"lib.apidoc.js"},"description":"this zero-dependency package will auto-generate documentation for your npm-package with zero-config","devDependencies":{"electron-lite":"kaizhu256/node-electron-lite#alpha","utility2":"kaizhu256/node-utility2#alpha"},"engines":{"node":">=4.0"},"homepage":"https://github.com/kaizhu256/node-apidoc-lite","keywords":["api-doc","apidoc","doc","documentation","doxygen","javadoc"],"license":"MIT","main":"lib.apidoc.js","name":"api_doc","nameAlias":"apidoc","nameOriginal":"apidoc-lite","os":["darwin","linux"],"readmeParse":"1","repository":{"type":"git","url":"https://github.com/kaizhu256/node-apidoc-lite.git"},"scripts":{"build-ci":"utility2 shReadmeTest build_ci.sh","env":"env","heroku-postbuild":"npm install 'kaizhu256/node-utility2#alpha' && utility2 shDeployHeroku","postinstall":"if [ -f lib.apidoc.npm_scripts.sh ]; then ./lib.apidoc.npm_scripts.sh postinstall; fi","publish-alias":"VERSION=$(npm info $npm_package_name version); for ALIAS in api_doc apidocs api-doctor doctor-api npm-doc npmdoc; do utility2 shNpmPublishAs . $ALIAS $VERSION; utility2 shNpmTestPublished $ALIAS || exit $?; done","start":"export PORT=${PORT:-8080} && export npm_config_mode_auto_restart=1 && utility2 start","test":"export PORT=$(utility2 shServerPortRandom) && utility2 test test.js"},"version":"2017.3.9"}
{
"author": {
"name": "kai zhu",
"email": "kaizhu256@gmail.com"
},
"bin": {
"apidoc-lite": "lib.apidoc.js"
},
"bugs": {
"url": "https://github.com/kaizhu256/node-apidoc-lite/issues"
},
"dependencies": {},
"description": "this package is deprecated and superseded by [apidoc-lite](https://www.npmjs.com/package/apidoc-lite)",
"devDependencies": {
"electron-lite": "github:kaizhu256/node-electron-lite#alpha",
"utility2": "github:kaizhu256/node-utility2#alpha"
},
"directories": {},
"dist": {
"shasum": "2b39e0e0e2e421e7a7a24d7af0ceab1b7d3e491b",
"tarball": "https://registry.npmjs.org/api_doc/-/api_doc-2017.3.9.tgz"
},
"engines": {
"node": ">=4.0"
},
"homepage": "https://github.com/kaizhu256/node-apidoc-lite",
"keywords": [
"api-doc",
"apidoc",
"doc",
"documentation",
"doxygen",
"javadoc"
],
"license": "MIT",
"main": "lib.apidoc.js",
"maintainers": [
{
"name": "kaizhu",
"email": "kaizhu256@gmail.com"
}
],
"name": "api_doc",
"nameAlias": "apidoc",
"nameOriginal": "apidoc-lite",
"optionalDependencies": {},
"os": [
"darwin",
"linux"
],
"readme": "ERROR: No README data found!",
"readmeParse": "1",
"repository": {
"type": "git",
"url": "git+https://github.com/kaizhu256/node-apidoc-lite.git"
},
"scripts": {
"build-ci": "utility2 shReadmeTest build_ci.sh",
"env": "env",
"heroku-postbuild": "npm install 'kaizhu256/node-utility2#alpha' && utility2 shDeployHeroku",
"postinstall": "if [ -f lib.apidoc.npm_scripts.sh ]; then ./lib.apidoc.npm_scripts.sh postinstall; fi",
"publish-alias": "VERSION=$(npm info $npm_package_name version); for ALIAS in api_doc apidocs api-doctor doctor-api npm-doc npmdoc; do utility2 shNpmPublishAs . $ALIAS $VERSION; utility2 shNpmTestPublished $ALIAS || exit $?; done",
"start": "export PORT=${PORT:-8080} && export npm_config_mode_auto_restart=1 && utility2 start",
"test": "export PORT=$(utility2 shServerPortRandom) && utility2 test test.js"
},
"version": "2017.3.10"
}

185

README.md

@@ -1,184 +0,1 @@

apidoc-lite
===========
this zero-dependency package will auto-generate documentation for your npm-package with zero-config
[![travis-ci.org build-status](https://api.travis-ci.org/kaizhu256/node-apidoc-lite.svg)](https://travis-ci.org/kaizhu256/node-apidoc-lite) [![istanbul-coverage](https://kaizhu256.github.io/node-apidoc-lite/build/coverage.badge.svg)](https://kaizhu256.github.io/node-apidoc-lite/build/coverage.html/index.html)
[![NPM](https://nodei.co/npm/apidoc-lite.png?downloads=true)](https://www.npmjs.com/package/apidoc-lite)
[![package-listing](https://kaizhu256.github.io/node-apidoc-lite/build/screen-capture.gitLsTree.svg)](https://github.com/kaizhu256/node-apidoc-lite)
# documentation
#### apidoc
- [https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/apidoc.html](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/apidoc.html)
[![apidoc](https://kaizhu256.github.io/node-apidoc-lite/build/screen-capture.buildApidoc.browser._2Fhome_2Ftravis_2Fbuild_2Fkaizhu256_2Fnode-apidoc-lite_2Ftmp_2Fbuild_2Fapidoc.html.png)](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/apidoc.html)
#### todo
- none
#### change since dfed6414
- npm publish 2017.3.9
- add ability to create markdown documentation
- auto-document dir ./lib/
- increase auto-coverage of examples
- none
#### this package requires
- darwin or linux os
# build status [![travis-ci.org build-status](https://api.travis-ci.org/kaizhu256/node-apidoc-lite.svg)](https://travis-ci.org/kaizhu256/node-apidoc-lite)
[![build commit status](https://kaizhu256.github.io/node-apidoc-lite/build/build.badge.svg)](https://travis-ci.org/kaizhu256/node-apidoc-lite)
| git-branch : | [master](https://github.com/kaizhu256/node-apidoc-lite/tree/master) | [beta](https://github.com/kaizhu256/node-apidoc-lite/tree/beta) | [alpha](https://github.com/kaizhu256/node-apidoc-lite/tree/alpha)|
|--:|:--|:--|:--|
| test-report : | [![test-report](https://kaizhu256.github.io/node-apidoc-lite/build..master..travis-ci.org/test-report.badge.svg)](https://kaizhu256.github.io/node-apidoc-lite/build..master..travis-ci.org/test-report.html) | [![test-report](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/test-report.badge.svg)](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/test-report.html) | [![test-report](https://kaizhu256.github.io/node-apidoc-lite/build..alpha..travis-ci.org/test-report.badge.svg)](https://kaizhu256.github.io/node-apidoc-lite/build..alpha..travis-ci.org/test-report.html)|
| coverage : | [![istanbul-coverage](https://kaizhu256.github.io/node-apidoc-lite/build..master..travis-ci.org/coverage.badge.svg)](https://kaizhu256.github.io/node-apidoc-lite/build..master..travis-ci.org/coverage.html/index.html) | [![istanbul-coverage](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/coverage.badge.svg)](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/coverage.html/index.html) | [![istanbul-coverage](https://kaizhu256.github.io/node-apidoc-lite/build..alpha..travis-ci.org/coverage.badge.svg)](https://kaizhu256.github.io/node-apidoc-lite/build..alpha..travis-ci.org/coverage.html/index.html)|
| build-artifacts : | [![build-artifacts](https://kaizhu256.github.io/node-apidoc-lite/glyphicons_144_folder_open.png)](https://github.com/kaizhu256/node-apidoc-lite/tree/gh-pages/build..master..travis-ci.org) | [![build-artifacts](https://kaizhu256.github.io/node-apidoc-lite/glyphicons_144_folder_open.png)](https://github.com/kaizhu256/node-apidoc-lite/tree/gh-pages/build..beta..travis-ci.org) | [![build-artifacts](https://kaizhu256.github.io/node-apidoc-lite/glyphicons_144_folder_open.png)](https://github.com/kaizhu256/node-apidoc-lite/tree/gh-pages/build..alpha..travis-ci.org)|
#### master branch
- stable branch
- HEAD should be tagged, npm-published package
#### beta branch
- semi-stable branch
- HEAD should be latest, npm-published package
#### alpha branch
- unstable branch
- HEAD is arbitrary
- commit history may be rewritten
# quickstart shell example
#### to run this example, follow the instruction in the script below
- [example.sh](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/example.sh)
```shell
# example.sh
# this shell script will auto-generate documentation for the mysql npm-package with zero-config
# instruction
# 1. copy and paste this entire shell script into a console and press enter
# 2. open /tmp/apidoc.html to view the auto-generated documentation
shExampleSh() {(set -e
# npm install apidoc-lite
npm install apidoc-lite
# npm install mysql
npm install mysql
# auto-generate documentation for the mysql npm-package with zero-config
node_modules/.bin/apidoc-lite mysql > /tmp/apidoc.html
)}
shExampleSh
```
#### output from browser
[![screen-capture](https://kaizhu256.github.io/node-apidoc-lite/build/screen-capture.testExampleSh.browser._2Ftmp_2Fapidoc.html.png)](https://kaizhu256.github.io/node-apidoc-lite/build..beta..travis-ci.org/apidoc.example.html)
#### output from shell
![screen-capture](https://kaizhu256.github.io/node-apidoc-lite/build/screen-capture.testExampleSh.svg)
# package.json
```json
{
"author": "kai zhu <kaizhu256@gmail.com>",
"bin": {
"apidoc-lite": "lib.apidoc.js"
},
"description": "this zero-dependency package will auto-generate documentation for your npm-package with zero-config",
"devDependencies": {
"electron-lite": "kaizhu256/node-electron-lite#alpha",
"utility2": "kaizhu256/node-utility2#alpha"
},
"engines": {
"node": ">=4.0"
},
"homepage": "https://github.com/kaizhu256/node-apidoc-lite",
"keywords": [
"api-doc",
"apidoc",
"doc",
"documentation",
"doxygen",
"javadoc"
],
"license": "MIT",
"main": "lib.apidoc.js",
"name": "apidoc-lite",
"nameAlias": "apidoc",
"nameOriginal": "apidoc-lite",
"os": [
"darwin",
"linux"
],
"readmeParse": "1",
"repository": {
"type": "git",
"url": "https://github.com/kaizhu256/node-apidoc-lite.git"
},
"scripts": {
"build-ci": "utility2 shReadmeTest build_ci.sh",
"env": "env",
"heroku-postbuild": "npm install 'kaizhu256/node-utility2#alpha' && utility2 shDeployHeroku",
"postinstall": "if [ -f lib.apidoc.npm_scripts.sh ]; then ./lib.apidoc.npm_scripts.sh postinstall; fi",
"publish-alias": "VERSION=$(npm info $npm_package_name version); for ALIAS in api_doc apidocs api-doctor doctor-api npm-doc npmdoc; do utility2 shNpmPublishAs . $ALIAS $VERSION; utility2 shNpmTestPublished $ALIAS || exit $?; done",
"start": "export PORT=${PORT:-8080} && export npm_config_mode_auto_restart=1 && utility2 start",
"test": "export PORT=$(utility2 shServerPortRandom) && utility2 test test.js"
},
"version": "2017.3.9"
}
```
# changelog of last 50 commits
[![screen-capture](https://kaizhu256.github.io/node-apidoc-lite/build/screen-capture.gitLog.svg)](https://github.com/kaizhu256/node-apidoc-lite/commits)
# internal build-script
- build_ci.sh
```shell
# build_ci.sh
# this shell script will run the build for this package
shBuildCiInternalPost() {(set -e
shReadmeBuildLinkVerify
)}
shBuildCiInternalPre() {(set -e
shReadmeTest example.js
shReadmeTest example.sh
# save screen-capture
(export MODE_BUILD=testExampleSh &&
export url=/tmp/apidoc.html &&
utility2 shBrowserTest &&
cp /tmp/apidoc.html "$npm_config_dir_build/apidoc.example.html") || return $?
shNpmTestPublished
)}
shBuildCiPost() {(set -e
return
)}
shBuildCiPre() {(set -e
return
)}
# init env
eval $(utility2 source) && shBuildCi
```
# misc
- this package was created with [utility2](https://github.com/kaizhu256/node-utility2)
this package is deprecated and superseded by [apidoc-lite](https://www.npmjs.com/package/apidoc-lite)