Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

File scanning only works to a depth of 10 #1340

Closed
blindspeed90 opened this issue Mar 21, 2017 · 2 comments
Closed

File scanning only works to a depth of 10 #1340

blindspeed90 opened this issue Mar 21, 2017 · 2 comments
Labels
bugfix
Milestone
3.5.0

Comments

@blindspeed90
Copy link

We have a deep file structure, and some files weren't being processed, without any indication that the recursive scan was halted. I'm not sure why there has to be a limit at all, and shouldn't even be something you have to configure in the conf.json. The cli.js is what mattered to me, but resolver.js had the same limit.

cli.js:
cli.scanFiles = function() {
env.sourceFiles = app.jsdoc.scanner.scan(env.opts._, (env.opts.recurse ? 10 : undefined),

resolver.js:
exports.load = function(filepath) {
var files = fs.ls(filepath, env.opts.recurse ? 10 : undefined);
@hegemonic
Copy link
Contributor

The limit is there to prevent infinite recursion.

Contrary to what you said, I think the correct solution is to make this value configurable in conf.json, rather than hard-coding the value 10. A good name for this option would be recurseDepth.

@hegemonic hegemonic added this to the 3.5.0 milestone Mar 28, 2017
hegemonic added a commit that referenced this issue Jul 7, 2017
@hegemonic
add recurseDepth config option (#1340)
43a117d
@hegemonic
Copy link
Contributor

Fixed on master. The fix will be included in JSDoc 3.5.0.

lheberlie added a commit to bsvensson/jsdoc that referenced this issue Aug 15, 2017
@lheberlie
Merge tag '3.5.0' into esrijs-sdk-3.5.4
c33c1b2 
3.5.0

* tag '3.5.0': (97 commits)
  3.5.0
  bump revision; start 3.6.0-dev
  update 3.5.0 changelog
  3.5.0 changelog
  reformat changelog
  add yields tag (jsdoc#1388)
  resolve the path to the JS config file before requiring it (jsdoc#1386)
  support namespaces that are also functions (jsdoc#955)
  add hideconstructor tag (jsdoc#952)
  add package tag (jsdoc#962)
  autodetect default and repeatable parameters when a function is assigned to a variable (jsdoc#1054)
  correctly document constructors and instance properties of ES2015 classes (jsdoc#1182)
  add sourceType config option
  fix crash when the author tag is empty (jsdoc#1289)
  add recurseDepth config option (jsdoc#1340)
  support bigint
  support import.meta
  support optional chaining
  support numeric separators
  support dynamic import
  ...

# Conflicts:
#	.eslintrc
#	README.md
#	lib/jsdoc/fs.js
#	lib/jsdoc/opts/args.js
#	lib/jsdoc/src/astbuilder.js
#	lib/jsdoc/src/astnode.js
#	lib/jsdoc/src/handlers.js
#	lib/jsdoc/src/parser.js
#	lib/jsdoc/src/visitor.js
#	lib/jsdoc/src/walker.js
#	lib/jsdoc/tag/dictionary/definitions.js
#	lib/jsdoc/tag/validator.js
#	lib/jsdoc/util/markdown.js
#	lib/jsdoc/util/templateHelper.js
#	package.json
#	templates/default/static/styles/jsdoc-default.css
#	templates/haruki/publish.js
#	test/spec-collection.js
#	test/specs/documentation/defaultparams.js
#	test/specs/documentation/restparams.js
#	test/specs/jsdoc/src/astnode.js
#	test/specs/jsdoc/util/templateHelper.js
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bugfix
Projects
None yet
Milestone
3.5.0
Development

No branches or pull requests
2 participants
@hegemonic @blindspeed90