Code coverage report for master/lib/jsdoc/package.js

Statements: 100% (43 / 43)      Branches: 100% (36 / 36)      Functions: 100% (2 / 2)      Lines: 100% (43 / 43)      Ignored: none     

All files » master/lib/jsdoc/ » package.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256    1                   1 3   3 2     3                                                                                                 1 58                 58   58 58     1 1     58           2               58   58                 1     58               1     58             1     58             1     58           1     58             1     58                   1                           58   58             1     58             1     58             3     58                 1     58             1     58               1      
'use strict';
 
var logger = require('jsdoc/util/logger');
 
/**
 * Provides access to information about a JavaScript package.
 *
 * @module jsdoc/package
 * @see https://www.npmjs.org/doc/files/package.json.html
 */
 
// Collect all of the license information from a `package.json` file.
function getLicenses(packageInfo) {
    var licenses = packageInfo.licenses ? packageInfo.licenses.slice(0) : [];
 
    if (packageInfo.license) {
        licenses.push({ type: packageInfo.license });
    }
 
    return licenses;
}
 
/**
 * Information about where to report bugs in the package.
 *
 * @typedef {Object} module:jsdoc/package.Package~BugInfo
 * @property {string} email - The email address for reporting bugs.
 * @property {string} url - The URL for reporting bugs.
 */
 
/**
 * Information about a package's software license.
 *
 * @typedef {Object} module:jsdoc/package.Package~LicenseInfo
 * @property {string} type - An identifier for the type of license.
 * @property {string} url - The URL for the complete text of the license.
 */
 
/**
 * Information about a package author or contributor.
 *
 * @typedef {Object} module:jsdoc/package.Package~PersonInfo
 * @property {string} name - The person's full name.
 * @property {string} email - The person's email address.
 * @property {string} url - The URL of the person's website.
 */
 
/**
 * Information about a package's version-control repository.
 *
 * @typedef {Object} module:jsdoc/package.Package~RepositoryInfo
 * @property {string} type - The type of version-control system that the repository uses (for
 * example, `git` or `svn`).
 * @property {string} url - The URL for the repository.
 */
 
/**
 * Information about a JavaScript package. JSDoc can extract package information from
 * `package.json` files that follow the
 * [npm specification](https://www.npmjs.org/doc/files/package.json.html).
 *
 * **Note**: JSDoc does not validate or normalize the contents of `package.json` files. If your
 * `package.json` file does not follow the npm specification, some properties of the `Package`
 * object may not use the format documented here.
 *
 * @class
 * @param {string} json - The contents of the `package.json` file.
 */
exports.Package = function(json) {
    var packageInfo;
 
    /**
     * The string identifier that is shared by all `Package` objects.
     *
     * @readonly
     * @default
     * @type {string}
     */
    this.kind = 'package';
 
    try {
        packageInfo = JSON.parse(json || '{}');
    }
    catch (e) {
        logger.error('Unable to parse the package file: %s', e.message);
        packageInfo = {};
    }
 
    if (packageInfo.name) {
        /**
         * The package name.
         *
         * @type {string}
         */
        this.name = packageInfo.name;
    }
 
    /**
     * The unique longname for this `Package` object.
     *
     * @type {string}
     */
    this.longname = this.kind + ':' + this.name;
 
    if (packageInfo.author) {
        /**
         * The author of this package. Contains either a
         * {@link module:jsdoc/package.Package~PersonInfo PersonInfo} object or a string with
         * information about the author.
         *
         * @type {(module:jsdoc/package.Package~PersonInfo|string)}
         * @since 3.3.0
         */
        this.author = packageInfo.author;
    }
 
    if (packageInfo.bugs) {
        /**
         * Information about where to report bugs in the project. May contain a URL, a string, or an
         * object with more detailed information.
         *
         * @type {(string|module:jsdoc/package.Package~BugInfo)}
         * @since 3.3.0
         */
        this.bugs = packageInfo.bugs;
    }
 
    if (packageInfo.contributors) {
        /**
         * The contributors to this package.
         *
         * @type {Array.<(module:jsdoc/package.Package~PersonInfo|string)>}
         * @since 3.3.0
         */
        this.contributors = packageInfo.contributors;
    }
 
    if (packageInfo.dependencies) {
        /**
         * The dependencies for this package.
         *
         * @type {Object}
         * @since 3.3.0
         */
        this.dependencies = packageInfo.dependencies;
    }
 
    if (packageInfo.description) {
        /**
         * A brief description of the package.
         *
         * @type {string}
         */
        this.description = packageInfo.description;
    }
 
    if (packageInfo.devDependencies) {
        /**
         * The development dependencies for this package.
         *
         * @type {Object}
         * @since 3.3.0
         */
        this.devDependencies = packageInfo.devDependencies;
    }
 
    if (packageInfo.engines) {
        /**
         * The JavaScript engines that this package supports. Each key is a string that identifies
         * the engine (for example, `node`). Each value is a
         * [semver](https://www.npmjs.org/doc/misc/semver.html)-compliant version number for the
         * engine.
         *
         * @type {Object}
         * @since 3.3.0
         */
        this.engines = packageInfo.engines;
    }
 
    /**
     * The source files associated with the package.
     *
     * New `Package` objects always contain an empty array, regardless of whether the `package.json`
     * file includes a `files` property.
     *
     * After JSDoc parses your input files, it sets this property to a list of paths to your input
     * files.
     *
     * @type {Array.<string>}
     */
    this.files = [];
 
    if (packageInfo.homepage) {
        /**
         * The URL for the package's homepage.
         *
         * @type {string}
         * @since 3.3.0
         */
        this.homepage = packageInfo.homepage;
    }
 
    if (packageInfo.keywords) {
        /**
         * Keywords to help users find the package.
         *
         * @type {Array.<string>}
         * @since 3.3.0
         */
        this.keywords = packageInfo.keywords;
    }
 
    if (packageInfo.license || packageInfo.licenses) {
        /**
         * The licenses used by this package. Combines information from the `package.json` file's
         * `license` property and the deprecated `licenses` property.
         *
         * @type {Array.<module:jsdoc/package.Package~LicenseInfo>}
         */
        this.licenses = getLicenses(packageInfo);
    }
 
    if (packageInfo.main) {
        /**
         * The module ID that provides the primary entry point to the package. For example, if your
         * package is a CommonJS module, and the value of this property is `foo`, users should be
         * able to load your module with `require('foo')`.
         *
         * @type {string}
         * @since 3.3.0
         */
        this.main = packageInfo.main;
    }
 
    if (packageInfo.repository) {
        /**
         * The version-control repository for the package.
         *
         * @type {module:jsdoc/package.Package~RepositoryInfo}
         * @since 3.3.0
         */
        this.repository = packageInfo.repository;
    }
 
    if (packageInfo.version) {
        /**
         * The [semver](https://www.npmjs.org/doc/misc/semver.html)-compliant version number of the
         * package.
         *
         * @type {string}
         * @since 3.2.0
         */
        this.version = packageInfo.version;
    }
};