Notably Polite Mariner

    danger-plugin-jsdoc
    TypeScript icon, indicating that this package has built-in type declarations

    1.4.2 • Public • Published

    danger-plugin-jsdoc

    Build Status npm version semantic-release

    This plugin raises a warning if a js file has been modified without it's JSDoc being updated.

    Usage

    Install:

    yarn add danger-plugin-jsdoc --dev

    At a glance:

    // dangerfile.js
    import jsdoc from "danger-plugin-jsdoc"
    
    jsdoc({
      includes: ["**/*.js"],
      excludes: ["**/*.spec.js"],
      warningMessage: "Oops, you may need to update your JSDoc",
    })

    Configuration:

    Option Type Default Description
    includes string[] ["**/*.js"] Glob patterns to match files to be checked
    excludes string[] [] Glob patterns to match files that should not be checked even if it is in includes
    warningMessage string "This js file have been changed without updating its JSDoc, please update it's JSDoc if necessary" Warning message that will appear in the PR file comment

    Changelog

    See the GitHub release history.

    Contributing

    See CONTRIBUTING.md.

    Install

    npm i danger-plugin-jsdoc

    DownloadsWeekly Downloads

    15

    Version

    1.4.2

    License

    MIT

    Unpacked Size

    18.3 kB

    Total Files

    15

    Last publish

    Collaborators

    • clong310