relative path in docs incorrect on when build on windows

[mikaelkaron]

Stencil version:

 @stencil/[email protected]

I'm submitting a:

[x] bug report
[ ] feature request
[ ] support request => Please do not submit support requests here, use one of these channels: https://stencil-worldwide.herokuapp.com/ or https://forum.ionicframework.com/

Current behavior:

Links to other components use system path separator instead of URL path separator.

Take this readme as an example. Because it was built on windows it uses \ as a path separator instead of the correct /.

I'm making an assumption here that the separator is reversed because I use a windows machine. I have not looked at the code or verified with other generated readme.md files from a linux system.

In some way I guess it's my own fault for using windows as a dev system (it's not the first time I report path related bugs in a project) but I'm sure I'm not the only one.

Expected behavior:

Paths in .md files can safely be assumed to be intended to be consumed on the internet, so the path separator should always be /.

Steps to reproduce:

Build a multi-component stencil project on a windows system and check the generated readme.md files.

Related code:

// insert any relevant code here

Other information:

[mikaelkaron]

After changing my setup to run the build inside a Docker container during development I can confirm that the separator is correct when built on a Linux system. This points to earlier assumption that this is an OS related problem.

Funnily enough the problem is usually reversed (as in generated paths are not using path.sep and that screws things up) but in this case we always want the separator to be /.

¯\_(ツ)_/¯

[dutscher]

i had the problem aswell, my collegues are on mac and linux. iam the dude with windows.
now i got all components readme's as changed and only the pathes are with backslash instead of slash.

i found the code:
https://github.com/ionic-team/stencil/blob/master/src/compiler/docs/readme/markdown-dependencies.ts getCmpLink -> cmpRelPath should get a simple .replace(/\\/g,"\/") and then its fine!

cheers

[mikaelkaron]

i found the code:
https://github.com/ionic-team/stencil/blob/master/src/compiler/docs/readme/markdown-dependencies.ts getCmpLink -> cmpRelPath should get a simple .replace(/\/g,"/") and then its fine!

PR!

[mikaelkaron]

Think this can be closed by 22d9c93