[api-extractor] add basic support for `import * as module from './local-module'` #1796

mckn · 2020-03-25T13:08:49Z

I have basically taken the PR created by @adventure-yunfei here and cleaned up the code a bit. Tested it on the Grafana project which is a really big project and then opened this PR.

Thanks and great work by @adventure-yunfei!

Please let me know what you want to be adressed to get it merged. I think there are several people that wants to help out to get this PR merged.

Fixes: #1029

msftclas · 2020-03-25T13:09:02Z

All CLA requirements met.

mckn · 2020-03-25T14:56:20Z

~~I can run the tests and see that there are two failing tests but not sure how to get some more details about the failure.~~

Saw that it was a build failure and got more details by running the regular gulp script in the api-extractor.

stevengum

Just had two style/practice comments.

I ran into this issue today and am looking forward to these changes, thanks @mckn!

apps/api-extractor/src/analyzer/ExportAnalyzer.ts

apps/api-extractor/src/generators/ApiReportGenerator.ts

stevengum · 2020-03-27T20:08:38Z

@octogonz sorry for the out-of-the-blue PR review, just excited to use api-extractor on my team's projects 😄

@mckn, do you have tests that can be added to the PR?

mckn · 2020-03-27T20:20:19Z

@octogonz sorry for the out-of-the-blue PR review, just excited to use api-extractor on my team's projects 😄

@mckn, do you have tests that can be added to the PR?

@stevengum awesome feedback! Thanks for doing the review. Have made the updates and pushed the changes.

I have not added any tests but please give me some directions on how I can write some tests and I am happy to add that as well.

stevengum · 2020-03-31T20:45:09Z

@mckn sorry for the delay, I'm not a regular contributor to this project so I don't know how to write/run tests.

I've pulled the grafana branch and was going to run the tests locally, it looks like they've already passed as part of the setup of the repo.

I don't have insight into their CI pipelines either, could the rushstack CI Build be stuck in pending due to the merge conflict?

mckn · 2020-04-01T07:13:08Z

@stevengum I have added one some simple tests to verify the import * as .. scenario. Not sure if it is the merge conflict that is causing errors. But I will sync with upstream asap so we can get this mergeable.

mckn · 2020-04-03T06:49:06Z

@octogonz would be awesome if you could have a look at this PR 🙏

rbuckton · 2020-04-04T00:34:05Z

~~I tried this on one of my projects and the links in the TOC for namespaces are broken (as in, clicking on them does nothing).~~

~~This is when using the YamlDocumenter API via new YamlDocumenter(apiModel, /*newDocfxNamespaces*/ true);.~~

rbuckton · 2020-04-04T00:53:44Z

Disregard that comment. After a clean build of my documentation it seems to be working fine.

santam85 · 2021-03-17T08:44:44Z

Happy to see there's a PR already in this advanced stage for this. This is a must to support api-extractor for Angular projects as well, as there's limited control on the typings output from the CLI

lifeiscontent · 2021-05-30T02:38:47Z

@octogonz any updates here?

…-as-support

…reviews

octogonz · 2021-06-26T23:49:32Z

@octogonz any updates here?

To be clear, what's blocking this PR wasn't the code review, but rather some nontrivial work required to complete the implementation. (Some of which is identified by TODO in the author's comments.) I'm looking at it again this weekend to see if I can push it along.

…mespaceImport members get analyzed similar to exported APIs

… members

octogonz · 2021-06-27T00:47:21Z

Today I got the .api.md file straightened out. The last step will be the .api.json file.

…port references

…" syntax

octogonz · 2021-06-30T06:06:45Z

🚀 This is finally ready to go!

I tested it by building a large production monorepo with lots of projects that use API Extractor.

octogonz · 2021-06-30T18:05:50Z

Released with API Extractor 7.17.0

microsoft#1796 (comment) # Conflicts: # apps/api-extractor/src/analyzer/AstSymbolTable.ts # apps/api-extractor/src/analyzer/ExportAnalyzer.ts # apps/api-extractor/src/collector/Collector.ts # apps/api-extractor/src/generators/ApiModelGenerator.ts

added support for 'import * as module from ./local-module'

efdde26

mckn requested review from apostolisms, D4N14L, halfnibble, iclanton, octogonz and sachinjoseph as code owners March 25, 2020 13:08

mckn changed the title ~~So this PR adds basic support for import * as module from './local-module'~~ [api-extractor] add basic support for import * as module from './local-module' Mar 25, 2020

mckn added 2 commits March 25, 2020 14:54

added change description.

1a94da5

fixed so we return a proper error messae.

79b397e

mckn added 2 commits March 26, 2020 07:52

fixed build errors.

6e8b0e2

added missing annotation.

9c3d85a

mckn mentioned this pull request Mar 26, 2020

[api-extractor] Support "import * as __ from __" for local paths #1029

Closed

stevengum reviewed Mar 27, 2020

View reviewed changes

apps/api-extractor/src/analyzer/ExportAnalyzer.ts Outdated Show resolved Hide resolved

apps/api-extractor/src/generators/ApiReportGenerator.ts Outdated Show resolved Hide resolved

fixed feedback on pr.

ec5757a

added tests.

a4ea1c1

mckn requested a review from patmill as a code owner March 30, 2020 09:15

stevengum mentioned this pull request Mar 31, 2020

Use @microsoft/api-extractor microsoft/botbuilder-js#1903

Closed

mckn added 2 commits April 2, 2020 08:29

merged master into branch.

90032e9

fixed version missmatch.

64e2c66

adventure-yunfei mentioned this pull request Apr 2, 2020

prototype: support local module import adventure-yunfei/web-build-tools#2

Closed

kasperisager mentioned this pull request Mar 31, 2021

Set up API Extractor for generating API documentation Siteimprove/alfa#290

Merged

9 tasks

Rugvip mentioned this pull request Apr 7, 2021

Add api-extractor to manage the public API of core packages backstage/backstage#5242

Merged

JoostK mentioned this pull request May 17, 2021

Can't run api-extractor on library compiled with ivy angular/angular#42064

Closed

mdrichardson mentioned this pull request May 19, 2021

chore: add test:compat to CI tests microsoft/botbuilder-js#3691

Merged

octogonz added 4 commits June 25, 2021 15:02

Merge remote-tracking branch 'remotes/origin/master' into export-star…

7ff319d

…-as-support

rush build

615a387

Update lockfile

2e100e6

Include /// directives in API report, since they are relevant to API …

8cac97b

…reviews

octogonz added 3 commits June 26, 2021 17:25

Introduce CollectorEntity.consumable distinction to ensure that AstNa…

66636f4

…mespaceImport members get analyzed similar to exported APIs

Fix an issue where DocCommentEnhancer was skipping AstNamespaceImport…

ec267b3

… members

Eliminate trailing comma

0ba9748

octogonz added 3 commits June 29, 2021 22:00

Add a second test case

51acb54

Implement the missing ae-forgotten-export analysis for AstNamespaceIm…

12799aa

…port references

Update change log

fcc005a

octogonz mentioned this pull request Jun 30, 2021

[api-extractor] Support "export * as __ from __" for local paths #2780

Closed

Improve the error message for not yet supported "export * as ___ from…

73a3498

…" syntax

octogonz approved these changes Jun 30, 2021

View reviewed changes

octogonz merged commit 3ade23f into microsoft:master Jun 30, 2021

octogonz deleted the export-star-as-support branch June 30, 2021 06:12

octogonz restored the export-star-as-support branch June 30, 2021 06:12

SchoofsKelvin mentioned this pull request Jul 6, 2021

[api-extractor] Trimmed member from exported namespace still exported by namespace in rollup #2791

Closed

Platonn mentioned this pull request Jul 20, 2021

API Extractor not able to parse "import * as __ from __" SAP/spartacus#9803

Open

mckn mentioned this pull request Oct 15, 2021

Chore: replaced the @grafana/api-extractor with the @microsoft/api-extractor grafana/grafana#40519

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[api-extractor] add basic support for `import * as module from './local-module'` #1796

[api-extractor] add basic support for `import * as module from './local-module'` #1796

mckn commented Mar 25, 2020

msftclas commented Mar 25, 2020 •

edited

Loading

mckn commented Mar 25, 2020 •

edited

Loading

stevengum left a comment

stevengum commented Mar 27, 2020

mckn commented Mar 27, 2020

stevengum commented Mar 31, 2020

mckn commented Apr 1, 2020

mckn commented Apr 3, 2020

rbuckton commented Apr 4, 2020 •

edited

Loading

rbuckton commented Apr 4, 2020

santam85 commented Mar 17, 2021

lifeiscontent commented May 30, 2021

octogonz commented Jun 26, 2021

octogonz commented Jun 27, 2021

octogonz commented Jun 30, 2021

octogonz commented Jun 30, 2021

[api-extractor] add basic support for import * as module from './local-module' #1796

[api-extractor] add basic support for import * as module from './local-module' #1796

Conversation

mckn commented Mar 25, 2020

msftclas commented Mar 25, 2020 • edited Loading

mckn commented Mar 25, 2020 • edited Loading

stevengum left a comment

Choose a reason for hiding this comment

stevengum commented Mar 27, 2020

mckn commented Mar 27, 2020

stevengum commented Mar 31, 2020

mckn commented Apr 1, 2020

mckn commented Apr 3, 2020

rbuckton commented Apr 4, 2020 • edited Loading

rbuckton commented Apr 4, 2020

santam85 commented Mar 17, 2021

lifeiscontent commented May 30, 2021

octogonz commented Jun 26, 2021

octogonz commented Jun 27, 2021

octogonz commented Jun 30, 2021

octogonz commented Jun 30, 2021

[api-extractor] add basic support for `import * as module from './local-module'` #1796

[api-extractor] add basic support for `import * as module from './local-module'` #1796

msftclas commented Mar 25, 2020 •

edited

Loading

mckn commented Mar 25, 2020 •

edited

Loading

rbuckton commented Apr 4, 2020 •

edited

Loading