Skip to content

Latest commit

 

History

History
970 lines (685 loc) · 14.2 KB

README.md

File metadata and controls

970 lines (685 loc) · 14.2 KB
Raw

jscs-jsdoc

Gitter Build Status Dependency Status Coverage

NPM version NPM downloads MIT License

jsdoc plugin for jscs. Twitter | Mailing List

Table of Contents

Plugin installation

NB Since jscs v2.0 the plugin jscs-jsdoc is bundled into it.

jscs-jsdoc can be installed using NPM and requires jscs.

Install it globally if you are using globally installed jscs

npm -g install jscs-jsdoc

But better install it into your project

npm install jscs-jsdoc --save-dev

Versioning & Semver

We recommend installing jscs-jsdoc via NPM using ^, or ~ if you want more stable releases.

Semver (http://semver.org/) dictates that breaking changes be major version bumps. In the context of a linting tool, a bug fix that causes more errors to be reported can be interpreted as a breaking change. However, that would require major version bumps to occur more often than can be desirable. Therefore, as a compromise, we will only release bug fixes that cause more errors to be reported in minor versions.

Below you will find our versioning strategy, and what you can expect to come out of a new jscs-jsdoc release.

  • Patch release:
    • A bug fix in a rule that causes jscs-jsdoc to report less errors;
    • Docs, refactoring and other "invisible" changes for user;
  • Minor release:
    • Any preset changes;
    • A bug fix in a rule that causes jscs-jsdoc to report more errors;
    • New rules or new options for existing rules that don't change existing behavior;
    • Modifying rules so they report less errors, and don't cause build failures;
  • Major release:
    • Purposefully modifying existing rules so that they report more errors or change the meaning of a rule;
    • Any architectural changes that could cause builds to fail.

Usage

To use plugin you should add these lines to configuration file .jscsrc:

{
    "plugins": [
        "jscs-jsdoc"
    ],
    "jsDoc": {
        "checkAnnotations": "closurecompiler",
        "checkTypes": "strictNativeCase",
        "enforceExistence": {
            "allExcept": ["exports"]
        }
    }
}

Rules

checkAnnotations

Checks tag names are valid.

There are 3 presets for Closure Compiler, JSDoc3 and JSDuck5.

By default it allows any tag from any preset. You can pass Object to select preset with preset field and add custom tags with extra field.

Type: Boolean or String or {"preset": String, "extra": Object} (see tag values).

Values: true, "closurecompiler", "jsdoc3", "jsduck5", Object

Context: file

Tags: *

Tag values

extra field should contains tags in keys and there are options for values:

  • false means tag available with no value
  • true means tag available with any value
  • "some" means tag available and requires some value

See also tag presets.

Example

"checkAnnotations": true
Valid
/**
 * @chainable
 * @param {string} message
 * @return {string}
 */
function _f() {}
Invalid
/**
 * @pororo
 * @lalala
 */
function _f() {}

Example 2

"checkAnnotations": {
    "preset": "jsdoc3",
    "extra": {
        "boomer": false
    }
}
Valid
/**
 * @boomer
 * @argument {String}
 */
function _f() {}
Invalid
/** @still-invalid */

checkParamExistence

Checks all parameters are documented.

Type: Boolean

Values: true

Example

"checkParamExistence": true
Valid
/**
 * @param {string} message
 * @return {string}
 */
function _f ( message ) {
  return true;
}

/**
 * @inheritdoc
 */
function _f ( message ) {
  return true;
}
Invalid
/**
 * @return {string}
 */
function _f ( message ) {
  return true;
}

checkParamNames

Checks param names in jsdoc and in function declaration are equal.

Type: Boolean

Values: true

Context: functions

Tags: param, arg, argument

Example

"checkParamNames": true
Valid
/**
 * @param {String} message
 * @param {Number|Object} [line]
 */
function method(message, line) {}
Invalid
/**
 * @param {String} msg
 * @param {Number|Object} [line]
 */
function method(message) {}

requireParamTypes

Checks params in jsdoc contains type.

Type: Boolean

Values: true

Context: functions

Tags: param, arg, argument

Example

"requireParamTypes": true
Valid
/**
 * @param {String} message
 */
function method() {}
Invalid
/**
 * @param message
 */
function method() {}

checkRedundantParams

Reports redundant params in jsdoc.

Type: Boolean

Values: true

Context: functions

Tags: param, arg, argument

Example

"checkRedundantParams": true
Valid
/**
 * @param {String} message
 */
function method(message) {}
Invalid
/**
 * @param {String} message
 */
function method() {}

checkReturnTypes

Checks for differences between the jsdoc and actual return types if both exist.

Type: Boolean

Values: true

Context: functions

Tags: return, returns

Example

"checkReturnTypes": true
Valid
/**
 * @returns {String}
 */
function method() {
    return 'foo';
}
Invalid
/**
 * @returns {String}
 */
function method(f) {
    if (f) {
        return true;
    }
    return 1;
}

checkRedundantReturns

Report statements for functions without return.

Type: Boolean

Values: true

Context: functions

Tags: return, returns

Example

"checkRedundantReturns": true
Valid
/**
 * @returns {string}
 */
function f() {
    return 'yes';
}
Invalid
/**
 * @returns {string}
 */
function f() {
    // no return here
}

requireReturnTypes

Checks returns in jsdoc contains type

Type: Boolean

Values: true

Context: functions

Tags: return, returns

Example

"requireReturnTypes": true
Valid
/**
 * @returns {String}
 */
function method() {}

/**
 * no @return
 */
function method() {}
Invalid
/**
 * @returns
 */
function method() {}

checkTypes

Reports invalid types for bunch of tags.

The strictNativeCase mode checks that case of natives is the same as in this list: boolean, number, string, Object, Array, Date, RegExp.

The capitalizedNativeCase mode checks that the first letter in all native types and primitives is uppercased except the case with function in google closure format: {function(...)}

Type: Boolean or String

Values: true or "strictNativeCase" or "capitalizedNativeCase"

Context: *

Tags: typedef, type, param, return, returns, enum, var, prop, property, arg, argument, cfg, lends, extends, implements, define

Example

"checkTypes": true
Valid
/**
 * @typedef {Object} ObjectLike
 * @property {boolean} hasFlag
 * @property {string} name
 */

/** @type {number} */
var bar = 1;

/** @const {number} */
var FOO = 2;

/**
 * @const
 * @type {number}
 */
var BAZ = 3;

/**
 * @param {SomeX} x
 * @returns {string}
 */
function method(x) {}
Invalid
/** @type {some~number} */
var x = 1;

/**
 * @param {function(redundantName: Number)} x
 */
function method(x) {}

/**
 * @param {Number|Boolean|object|array} x invalid for strictNativeCase
 */
function method(x) {}
/** @type {some~number} */
var x = 1;

checkRedundantAccess

Reports redundant access declarations.

Type: Boolean or String

Values: true or "enforceLeadingUnderscore" or "enforceTrailingUnderscore"

Context: functions

Tags: access, private, protected, public

Example

"checkRedundantAccess": true
"checkRedundantAccess": "enforceLeadingUnderscore"
Valid for true, "enforceLeadingUnderscore"
/**
 * @access private
 */
function _f() {}

/**
 * @access public
 */
function f() {}
Invalid for true
/**
 * @private
 * @access private
 */
function _f() {}
Invalid for "enforceLeadingUnderscore"
/**
 * @private
 */
function _f() {}

leadingUnderscoreAccess

Checks access declaration is set for _underscored function names

Ignores a bunch of popular identifiers: __filename, __dirname, __proto__, __defineGetter__, super_, __constructor, etc.

Type: Boolean or String

Values: true (means not public), "private", "protected"

Context: functions

Tags: access, private, protected, public

Example

"leadingUnderscoreAccess": "protected"
Valid
/**
 * @protected
 */
function _f() {}
Invalid
function _g() {}

/**
 * @private
 */
function _e() {}

enforceExistence

Checks jsdoc block exists.

Type: Boolean, String or Object

Values:

  • true
  • "exceptExports" (deprecated use "allExcept": ["exports"])
  • Object:
    • "allExcept" array of exceptions:
      • "expressions" skip expression functions
      • "exports" skip module.exports = function () {};
      • "paramless-procedures" functions without parameters and with empty return statements will be skipped

Context: functions

Example

"enforceExistence": true
Valid
/**
 * @protected
 */
function _f() {}
Invalid
function _g() {}

requireHyphenBeforeDescription

Checks a param description has a hyphen before it (checks for - ).

Type: Boolean

Values: true

Context: functions

Tags: param, arg, argument

Example

"requireHyphenBeforeDescription": true
Valid
/**
 * @param {String} - message
 */
function method() {}
Invalid
/**
 * @param {String} message
 */
function method() {}

requireNewlineAfterDescription

Checks a doc comment description has padding newline.

Type: Boolean

Values: true

Context: functions

Tags: *

Example

"requireNewlineAfterDescription": true
Valid
/**
 * @param {String} msg - message
 */
function method(msg) {}

/**
 * Description
 */
function method() {}

/**
 * Description
 *
 * @param {String} msg - message
 */
function method(msg) {}
Invalid
/**
 * Description
 * @param {String} message
 */
function method() {}

disallowNewlineAfterDescription

Checks a doc comment description has no padding newlines.

Type: Boolean

Values: true

Context: functions

Tags: *

Example

"disallowNewlineAfterDescription": true
Valid
/**
 * @param {String} msg - message
 */
function method(msg) {}

/**
 * Description
 */
function method() {}

/**
 * Description
 * @param {String} msg - message
 */
function method(msg) {}
Invalid
/**
 * Description
 *
 * @param {String} message
 */
function method(message) {}

requireDescriptionCompleteSentence

Checks a doc comment description is a complete sentence.

A complete sentence is defined as starting with an upper case letter and ending with a period.

Type: Boolean

Values: true

Context: functions

Tags: *

Example

"requireDescriptionCompleteSentence": true
Valid
/**
 * @param {String} msg - message
 */
function method(msg) {}

/**
 * Description.
 */
function method() {}

/**
 * (Description).
 */
function method() {}

/**
 * Description.
 *
 * @param {String} msg - message
 */
function method(msg) {}

/**
 * Description
 * on multiple lines are allowed.
 *
 * @param {String} msg - message
 */
function method(msg) {}
Invalid
/**
 * Description
 * @param {String} message
 */
function method() {}

/**
 * Description
 * On multiple lines should not start with an upper case.
 *
 * @param {String} - message
 */
function method() {}

/**
 * description starting with a lower case letter.
 * @param {String} message
 */
function method() {}

/**
 * Description period is offset .
 * @param {String} message
 */
function method() {}

/**
 * Description!
 * @param {String} message
 */
function method() {}

requireParamDescription

Checks a param description exists.

Type: Boolean

Values: true

Context: functions

Tags: param, arg, argument

Example

"requireParamDescription": true
Valid
/**
 * @param {String} arg message
 */
function method(arg) {}

/**
 * @param arg message
 */
function method(arg) {}
Invalid
/**
 * @param {String} arg
 */
function method(arg) {}

/**
 * @param arg
 */
function method(arg) {}

requireReturnDescription

Checks a return description exists.

Type: Boolean

Values: true

Context: functions

Tags: return, returns

Example

"requireReturnDescription": true
Valid
/**
 * @returns {Boolean} Method result.
 */
function method() {
  return false;
}

/**
 * @returns {String} method result
 */
function method() {
  return 'Hello!';
}
Invalid
/**
 * @returns {Boolean}
 */
function method() {
  return false;
}

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.