JSDoc has a few requirements that are somewhat unusual for a Node.js app:
1. We need `require('jsdoc/foo')` to work from any module.
2. We need `require('jsdoc/foo')` to work from external code, such as templates and plugins.
Prior to this commit, JSDoc did two separate things to meet these requirements:
1. Use an npm post-install script to create a symlink from `lib/jsdoc` to `node_modules/jsdoc`.
2. When a user runs JSDoc, copy templates and plugins into the JSDoc directory.
These fixes worked, sort of. But they also caused numerous issues with file permissions, especially on Windows.
We now use the Requizzle module, which hacks the Node.js module system to support JSDoc's use cases. There's no longer a post-install script, and there's no need for a symlink in `node_modules`.
- hoist require() calls into module scope to make them more efficient
- move some constants from jsdoc/doclet to jsdoc/name for sanity, and to break a circular dependency
- in jsdoc/src/astnode, define the node properties all at once
- remove the gratuitous constant for the `undocumented` tag; we only use it once
- remove a bit of dead code
The issue in brief: Within an object literal, if a standalone comment was followed by a commented symbol, the symbol's comment would not be attached correctly.
The fix essentially reverts the changes for #565, which are no longer needed thanks to 50cd99fa2fca753fcf7c9ec3ecf70afd47168e94.
The fix also corrects the order in which we walk a MemberExpression's child nodes. Without this correction, comments would not be attached correctly inside CallExpression nodes.
For consistency with method parameters, this change extends our unfortunate practice of adding type properties to the parent of the `type` object, rather than the object itself.
Replace an O(n^2) algorithm (indexOf + insert) * n with a much faster
algorithm, depending on what is supported by the JS engine.
I prefer the Set version as it is similar in spirit to the original
code and does not need to change the walked tree, but the flag setting
approach has the advantage that it works with current Node versions
without needing commandline flags.
Without the fix, we get the following when running ./jsdoc -T:
Failures:
jsdoc/src/filter Filter isIncluded
1) should be able to exclude descendants of excluded subdirectories
Message:
Expected 4 to be 2.
Stacktrace:
undefined
2) should be able to exclude descendants of excluded subdirectories
Message:
Expected 1 to be -1.
Stacktrace:
undefined
3) should be able to exclude descendants of excluded subdirectories
Message:
Expected 3 to be -1.
Stacktrace:
undefined
Finished in 6.696 seconds
849 tests, 2050 assertions, 3 failures
This test passes with the fix.
