archive-gh-me/jsdoc
1
0
Fork 0
mirror of https://github.com/jsdoc/jsdoc.git synced 2025-12-08 19:46:11 +00:00
Code Issues Projects Releases Wiki Activity
jsdoc/test
History
Jeff Williams 4badaef5fd better config loading (#1550) 
+ Use `cosmiconfig` instead of rolling our own code (which gives us YAML support)
+ Look for the config in these locations, and in this order:
    + A `jsdoc` property in `package.json`
    + `.jsdocrc` (can be JSON or YAML; comments not allowed for JSON)
    + `.jsdocrc.json` (comments allowed)
    + `.jsdocrc.yaml`
    + `.jsdocrc.yml`
    + `.jsdocrc.js`
    + `jsdoc.config.js`
2019-01-25 19:33:18 -08:00
..
fixtures
migrate from underscore to lodash
2019-01-21 10:52:46 -08:00
helpers
migrate from old, vendored Jasmine to jasmine package (#1602)
2019-01-21 19:38:07 -08:00
specs
better config loading (#1550)
2019-01-25 19:33:18 -08:00
tutorials
don't crash on UTF-8 JSON files with a leading BOM (#1256, #1297)
2017-07-02 16:28:23 -07:00
index.js
better config loading (#1550)
2019-01-25 19:33:18 -08:00
README.md
migrate from old, vendored Jasmine to jasmine package (#1602)
2019-01-21 19:38:07 -08:00

README.md

Testing JSDoc

JSDoc uses Jasmine as its testing framework. See the Jasmine documentation for details.

Running tests

Clone the GitHub repository; change to its directory; and run the following commands:

npm install
node jsdoc.js -T

Writing tests

You can write tests for all of the following:

  • JSDoc itself. See the test directory. Test specs are in test/specs, and fixtures used by the tests are in test/fixtures.
  • Plugins. See the plugins/test directory.
  • Packages. See the packages/**/test directories.