jsdoc-plugin-npm

Overview

Generate jsdoc @link inline tags from @npm inline tags.

e.g., {@npm jsdoc-plugin-npm} => {@link https://www.npmjs.com/package/jsdoc-plugin-npm|jsdoc-plugin-npm}

If you'd like to predefine links in a configuration file to make them referenceable see the url JSDoc plugin .

Usage

Given the following example:

// example npm package (not real...yet)
const voightKampffMachine = require('voight-kampff-machine');
/**
 * Takes an array of questions and returns a Promise that resolves to a `string` response to those questions.
 * Depends on the {@npm voight-kampff-machine} package.
 * 
 * @function voightKampff
 * @since 1.0.0
 * @param {string[]} questions 
 * @returns {Promise<string>} 
 */
const voightKampff = questions => {
    return voightKampffMachine.handleQuestions(questions)
        .then(response => {
          if (!response) {
            return 'They\'re only questions Leon';
          }
          return response;
        });
};

jsdoc-plugin-npm will generate:

/**
 * Takes an array of questions and returns a Promise that resolves to a response to those questions.
 * Depends on the {@link https://www.npmjs.com/package/voight-kampff-machine|voight-kampff-machine} package.
 * 
 * ...
 */

Installation

Install as a devDependency:

npm i -D jsdoc-plugin-npm

Setup

In your JSDoc config in the plugins array include:

{
  "plugins": ["jsdoc-plugin-npm"]
}

That's it!

License

A copy of the license is included in this repository.

Copyright 2019 Justin Beaudry

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.