Skip to content

TypeError when repository is not hosted on github #2

@SupernaviX

Description

@SupernaviX

Hi,

I seem to be getting a TypeError trying to generate docs for something without a repository url.

Unhandled rejection TypeError: Cannot read property 'isDirty' of undefined
    at DocBuilder.getSource (/Users/gelliss/stash/miniapp-version-resolver/node_modules/docts/dist/DocBuilder.js:52:30)
    at DocBuilder.formatPos (/Users/gelliss/stash/miniapp-version-resolver/node_modules/docts/dist/DocBuilder.js:76:22)
    at DocBuilder.printTitle (/Users/gelliss/stash/miniapp-version-resolver/node_modules/docts/dist/DocBuilder.js:93:22)
    at DocBuilder.printClass (/Users/gelliss/stash/miniapp-version-resolver/node_modules/docts/dist/DocBuilder.js:164:18)
    at /Users/gelliss/stash/miniapp-version-resolver/node_modules/docts/dist/DocBuilder.js:201:64
    at tryCatcher (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/util.js:16:23)
    at MappingPromiseArray._promiseFulfilled (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/map.js:61:38)
    at MappingPromiseArray.PromiseArray._iterate (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/promise_array.js:114:31)
    at MappingPromiseArray.init (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/promise_array.js:78:10)
    at MappingPromiseArray._asyncInit (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/map.js:30:10)
    at Async._drainQueue (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/async.js:138:12)
    at Async._drainQueues (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/async.js:143:10)
    at Immediate.Async.drainQueues (/Users/gelliss/stash/miniapp-version-resolver/node_modules/bluebird/js/release/async.js:17:14)
    at runCallback (timers.js:781:20)
    at tryOnImmediate (timers.js:743:5)
    at processImmediate [as _immediateCallback] (timers.js:714:5)

Taking a quick peek at the code, it looks like there's a regex explicitly checking for a repository.url that points to github. The project I'm trying to use this on is in an internal bitbucket instance, it would be helpful if docts either supported arbitrary repo urls or made the url optional.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions