-
-
Notifications
You must be signed in to change notification settings - Fork 737
Exports in ambient module don't get included in certain case #1571
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Comments
There are a couple issues here:
I changed your config file as shown: diff --git a/docs/typedoc.json b/docs/typedoc.json
index a2f3c5e..a244462 100644
--- a/docs/typedoc.json
+++ b/docs/typedoc.json
@@ -1,8 +1,8 @@
{
"entryPoints": [
- "../client",
- "../server"
+ "client",
+ "server"
],
"excludeExternals": true,
- "json": "api/.manifest"
+ "json": "docs/api/.manifest"
} And then ran This produced the expected output. In alt-client, If aliases aren't showing up in your DocFX docs, then there's a problem with that tool... the HTML rendered from TypeDoc looks as I expect. |
I've missed at some point that paths aren't relative to the config file; Although alias thing seems to be proper when there'd be additional ambient module exporting these types and then other ambient modules re-exporting them, which sadly is not the case here. While making alias to first ambient module is smart from technical point, it's not valid from my logical point of view. 1st & 2nd ambient module have no connection to each other, so they should've exported these types separately anyway. |
With #1567, I believe you should be able to achieve what you want by including each module as packages rather than entry points. Using aliases makes sense for most projects.. I'm not fundamentally opposed to introducing a |
Yes, I'm already implementing a* switch for it |
Search terms
ambient, module, export, exports, import, imports, not, included
Expected Behavior
Shared types imported from other ambient module should be included in both ambient modules.
Actual Behavior
Shared types imported from other ambient module only get included in 1st ambient module.
(Types that are missing from
alt-server
are marked with red dot on the right)(Note that also functions are missing, but they're not visible here)
Steps to reproduce the bug
Clone this repo with specified branch and generate documentation by executing
./docs/build.ps1
script (only Windows is supported for now):https://github.com/altmp/altv-types/tree/shared-package
You should be able to check documentation on
localhost:8080
or simply check./docs/api/.manifest
, which contains renamed typedoc JSON output. (In case of problems, simply runnpm i
andnpx typedoc
inside./docs/
directory)Environment
The text was updated successfully, but these errors were encountered: