wicked

v0.3.1

Generates github wiki compatible API documentation from your project's jsdocs and adds them to your wiki. For more information about how to use this package see README

Latest version published 11 years ago

License: MIT

Package Health Score

39 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

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

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.3.1	\|	04/2014	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.1	\|	03/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.4	\|	01/2014		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.6	\|	12/2013		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

No

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 (1)

GitHub Stars: 51
Forks: 10
Contributors: 1

Direct Usage Popularity

The npm package wicked receives a total of 1 downloads a week. As such, we scored wicked popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package wicked, we found that it has been starred 51 times.

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

Community

Limited

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

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like wicked is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

No Recent Commits

Open Issues: 11
Open PR: 1
Last Release: 11 years ago
Last Commit: 11 years ago

Further analysis of the maintenance status of wicked based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for wicked 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.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

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: 11 years
Dependencies: 16 Direct
Versions: 16
Install Size: 0 B
Dist-tags: 1
# of Files: 0
Maintainers: 1
TS Typings: No

wicked 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

wicked

A tool that generates github wiki compatible API documentation from your project's jsdocs and adds them to your wiki.

wicked.wiki

That is wicked!

Installation

npm install -g wicked

Usage

Steps

Create wiki by checking wiki in your project Features settings
Initialize wiki by accessing the wiki (the book icon in the navbar) which links to https://github.com/yourname/yourproject/wiki
Install wicked npm install -g wicked
Go to the root of your github project on your machine
Run wicked

Steps 4 - 5 can be repeated everytime you want to re-generate API docs for your project.

wicked does not overwrite other pages you created in your wiki so keep running wicked all you need.

More specifically wicked only removes old *.API.md files from your wiki and updates the links _Sidebar.md without affecting any other links in the sidebar.

See an example of API docs added by wicked in its own wiki.

Command Line Options

usage: wicked  -- 

  Generates wiki API docs for the gihub project in the current directory.

  Both options are optional, jsdoc-options get passed to [jsdoc](https://usejsdoc.org/about-commandline.html).

  Note: overriding the jsdoc destination (-d, --destination) is not possible since wicked will write files to a temp dir

OPTIONS:

  --noclean       don't remove the temp directory into which wiki is checked out when finished

  --nocommit      don't commit the updated wiki automatically nor remove the temp directory

  -t, --toc       causes wicked to generate a table of contents on top of each wiki page

  -l, --loglevel  level at which to log: silly|verbose|info|warn|error|silent -- default: info
  
  -h, --help      Print this help message.


EXAMPLES:
  
  Generate with default options:
    
    wicked

  Generate and include table of contents:
    
    wicked --toc

  Override [jsdocconf.json](https://usejsdoc.org/about-configuring-jsdoc.html):

    wicked -- --configure ./myconf.json

  Override loglevel and jsoc configuration and don't remove temp directory:

    wicked  --loglevel silly --noclean -- --configure ./myconf.json

Helpful links and techniques

Since wicked is using jsdoc under the hood, it is helpful to review its documentation. I highly recommend this page explaining how to specify @param types among other useful specs.

In order to avoid all functions being attached to the global namespace resulting in one API page per function, I namespaced functions in wicked with @namespace and @memberof working together. As an example the Internal namespace is defined here and used by all the lib functions like this one.

Feel free to study the commenting style used in wicked itself and compare with the wiki pages it produced.

In order to make your wicked API pages appear properly styled, please install the chrome extension or bookmarklet.

API

Public wicked API

Source:

index.js , lineno 25

<static> wicked(args, jsdocargs, cb)

Generates jsdoc wiki pages for project of current working directory and updates github wiki with them.

Note

It is assumed that this is run from the root of the project whose wiki should be generated. Additionally the currently checked out branch will be used when generating blob urls to link source examples.

However the github remote and branch can also be set via environment vars as explained in the documentation of jsdoc-githubify which is used by wicked under the hood.

Parameters:

Name Type Description

args

Object

consumed by wicked

Properties

Name	Type	Argument	Description
`noclean`	Boolean	<optional>	(false) if true, the temp directory into which wiki is checked out will not be removed when done
`nocommit`	Boolean	<optional>	(false) if true, the updated wiki will not be committed automatically
`toc`	Boolean	<optional>	(false) if true, a table of contents is added to each generated wiki
`loglevel`	String	<optional>	(info) level at which to log: silly\|verbose\|info\|warn\|error\|silent

jsdocargs

Array.<String>

consumed by jsdoc

cb

function

called back when wicked finished generating the wiki page

Source:

index.js , lineno 29

generated with docme

License

MIT

wicked dependencies

asyncreduce doctoc find-parent-dir jsdoc jsdoc-githubify minimist mkdirp mutiny npmlog readdirp require-module resolve-git-remote rimraf runnel through2 update-section

wicked development dependencies

nave ncp rimraf tap

FAQs

What is wicked?

Generates github wiki compatible API documentation from your project's jsdocs and adds them to your wiki. Visit Snyk Advisor to see a full health score report for wicked, including popularity, security, maintenance & community analysis.

Is wicked popular?

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

Is wicked well maintained?

We found indications that wicked is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is wicked safe to use?

While scanning the latest version of wicked, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 10 November-2024, at 20:40 (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

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

Monitor for new issues

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