Helpers are not discovered

[raido]

I am struggling to get helpers section to display.

{ file: 'addon/helpers/my-helper',
  line: 3,
  hide: '',
  class: 'addon/services/file-queue~FileQueue',
  module: undefined }

I just added few console.logs to lib/models/function.js on yuidoc package. It seems it matches helper to random service. That explains why I saw part of docblock from helper file in my service methods list. Helper’s docblock had @method defined.

[allthesignals]

I'm having issues with helpers too, maybe it's related.

I'm seeing:

Build Error (DocsCompiler)

Cannot read property 'filter' of undefined

In my case, if I comment the lines here and here, the docs are generated no problem.

Full stack trace:

=================================================================================
ERROR Summary:

• broccoliBuilderErrorStack: TypeError: Cannot read property 'filter' of undefined
  at generateResolvedTypedNavigationItems (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:143:20)
  at modules.forEach (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:191:23)
  at Array.forEach ()
  at generateNavigationIndex (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:187:11)
  at DocsCompiler.build (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:282:24)
  at /Users/mgardner/ember-mapbox-gl/node_modules/broccoli-caching-writer/index.js:149:21
  at tryCatch (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:525:12)
  at invokeCallback (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:538:13)
  at publish (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:508:7)
  at flush (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:2415:5)
• codeFrame: Cannot read property 'filter' of undefined
• errorMessage: Build Canceled: Broccoli Builder ran into an error with DocsCompiler plugin. 💥
  Cannot read property 'filter' of undefined
• errorType: Build Error
• location:
  • column: [undefined]
  • file: [undefined]
  • line: [undefined]
  • treeDir: [undefined]
• message: Build Canceled: Broccoli Builder ran into an error with DocsCompiler plugin. 💥
  Cannot read property 'filter' of undefined
• name: Error
• nodeAnnotation: DocsCompiler
• nodeName: DocsCompiler
• originalErrorMessage: Cannot read property 'filter' of undefined
• stack: TypeError: Cannot read property 'filter' of undefined
  at generateResolvedTypedNavigationItems (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:143:20)
  at modules.forEach (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:191:23)
  at Array.forEach ()
  at generateNavigationIndex (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:187:11)
  at DocsCompiler.build (/Users/mgardner/ember-mapbox-gl/node_modules/ember-cli-addon-docs/lib/broccoli/docs-compiler.js:282:24)
  at /Users/mgardner/ember-mapbox-gl/node_modules/broccoli-caching-writer/index.js:149:21
  at tryCatch (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:525:12)
  at invokeCallback (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:538:13)
  at publish (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:508:7)
  at flush (/Users/mgardner/ember-mapbox-gl/node_modules/rsvp/dist/rsvp.js:2415:5)

=================================================================================

[allthesignals]

In the modules collection, the helpers keys is missing for me:

{ id: 'addon/components/mapbox-gl',
    file: '/components/mapbox-gl',
    functions: [],
    variables: [],
    classes: [],
    components: [ [Object] ] }

[makepanic]

I'm seeing a similar error with an addon that has no helpers:

If I add a log to https://github.com/ember-learn/ember-cli-addon-docs/blob/master/lib/broccoli/docs-compiler.js#L60 it prints an object without the helpers property. Meaning module.helpers.length is called where module.helpers is undefined.

Also the collection in https://github.com/ember-learn/ember-cli-addon-docs/blob/master/lib/broccoli/docs-compiler.js#L143 is undefined, throwing an error when trying to call filter on undefined.

[pzuraq]

We've just upgraded and published changes to the API doc plugins that removed the notion of helpers altogether. Helpers can be classes or functions, so it makes more sense to just have a special nav item and have it point to whatever exists there (class or module).

Unfortunately we weren't able to merge the corresponding updates/fixes in the main ember-cli-addon-docs library due to failures on beta and canary, but we just did and just published the fix in a new version. Let us know if you're still having issues!

[raido]

It seems to work fine for my use case now. Thank you!