gdelmas / typedoc-plugin-sourcefile-url Goto Github PK

Currently the line number of a type definition is hard coded to be #L{line-number} in the generated URL. This should be able to be configured either on the command-line or in the configuration JSON to support source browsers that expect this information in a different URL format.

Is it possible to use this in conjunction with gulp-typedoc? It's not possible to specify sourcefile-url-prefix in the typedoc options

One of the reasons is this：TypeStrong/typedoc#1097
But if I solved this problem, this plugin still doesn't work.

Azure uses the following format for its code:

https://dev.azure.com/some/project/_git/repoName?version=GBdev&path=%2Fpath%2Fto%2Ffile%2Ffoo.js

It escapes the slashes in the actual path to the file - instead of slash it uses %2F.

It would be nice if we could perform a regex search/replace on the Defined In URLs so that we could fix the path before appending it to the prefix.

extending this issue: #18
Maybe another issue will wake up gdelmas?

In the hope of getting an update.

when typedoc is updated to 0.14:

Error: The plugin ...typedoc-plugin-sourcefile-url could not be loaded.

TypeError: Class constructor ConverterComponent cannot be invoked without 'new'

(above typed not copy-pasted fyi)

typedoc 0.22.3
typedoc-plugin-sourcefile-url 1.0.6

Error: The plugin .../node_modules/typedoc-plugin-sourcefile-url could not be loaded.
Error: Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: Package subpath './dist/lib/utils/component' is not defined by "exports" in .../node_modules/typedoc/package.json

Hello, thanks for this plugin. Is there a way to have the source links go to the master branch instead of the commit ID? I check in my generated files, and having the commitID makes my changeset very noisy.