Relative instead of absolute paths

[jakobrosenberg]

Is it possible to change this to a relative path? I imagine it could cause confusion or even breakage on other machines.

[Gerrit0]

Definitely needs investigation; this looks like a bug to me.

[jimblanc]

Running into the same issue and noticed this was closed as "not planned". @jakobrosenberg were you ever able to resolve? @Gerrit0 any idea of the root-cause?

[Gerrit0]

GitHub shows not planned for any of the non-"done" reasons. In this case, closed because no minimal reproduction was provided so it is unworkable.

[jimblanc]

That's fair, I'll work on seeing if I can boil down a reproduction app.

[blutorange]

@Gerrit0 I made a sample project for testing how to document the JavaScript code of a different project. I'll probably change a lot of the setup, but also came across this issue. I made a branch with the state where this issue occurs, try the following to reproduce it:

git clone https://github.com/blutorange/primefaces-js-refactor-test.git
cd primefaces-js-refactor-test/
git checkout typedoc-plugin-missing-exports-issue-12
npm install
cd packages/core/
npx tsc
npm run typedoc
open docs/index.html

Then open docs/index.html, I get the following with absolute links:

[Gerrit0]

Ah, that makes a ton of sense... ick. It's probably going to require some terrible hack to fix this.

[blutorange]

@Gerrit0 For reference, this can also cause an error when generating the documentation, in conjunction with yarn's PNP mode:

[error] Could not write /home/user/tmp/repro/primefaces-js-refactor-test/docs/modules/internal._home_user_tmp_repro_primefaces_js_refactor_test__yarn___virtual____fullcalendar_interaction_virtual_507a71b689_4__yarn_berry_cache__fullcalendar_interaction_npm_6_1_15_20b6da9676_10c0_zip_node_modules__fullcalendar_interaction_index.html

The OS complains because the filename it tries to use it too long (touch: cannot touch '...': File name too long). Simple reproduction:

git clone https://github.com/blutorange/primefaces-js-refactor-test.git
cd primefaces-js-refactor-test/
git checkout demo-typedoc-issue-long-file-names
yarn install
yarn typedoc src/index.ts --out docs --plugin typedoc-plugin-missing-exports

This happens as soon as there are multiple imports / external modules. When you comment out one of the imports in index.ts, it only generates names like docs/classes/_internal_.Component.html

Though perhaps this would need to be addressed by the typedoc core, that it finds a way to avoid long file names?