-
Notifications
You must be signed in to change notification settings - Fork 156
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
Api extractor setup #44
Conversation
…-native into apiExtractorSetup
@ecraig12345 is a really good person to review this since she just touched ours in fabric |
@@ -0,0 +1,3 @@ | |||
{ | |||
"extends": "../../api-extractor.json" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kenotron We should do this extends thing in OUFR's API extractor configs too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense to me, though I'm not sure I'm the most qualified to review in this repo. Left a few comments.
@@ -48,7 +48,7 @@ export type IMergeRecursionHandler = (options: IMergeOptions, ...objs: any[]) => | |||
* create a new object. | |||
* | |||
* @param options - options driving behavior of the merge. See IMergeOptions for a description. Some basic combos would | |||
* be {} - no recursion, { depth: -1 } - recurse infinitely | |||
* be \{\} - no recursion, \{ depth: -1 \} - recurse infinitely |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small thing, I'm guessing you could get rid of the need for escapes by wrapping the {}
and { depth: -1 }
in backticks (which also improves readability in intellisense)
* be \{\} - no recursion, \{ depth: -1 \} - recurse infinitely | |
* be `{}` - no recursion, `{ depth: -1 }` - recurse infinitely |
* <ThemeLayer>{(theme: ITheme) => { | ||
* return (<MyComponent style={someStyleFn(theme, 'stylename')}/>); | ||
* }}</ThemeLayer> | ||
* \<ThemeLayer\>\{(theme: ITheme) =\> \{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
const _isProduction = process.argv.indexOf('--production') > -1; | ||
|
||
// For API-Extractor to point you to source files rather than .d.ts files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@kenotron We should fix this declarationMap thing in OUFR too
state: IPressableState; | ||
} | ||
|
||
// Warning: (ae-forgotten-export) The symbol "IDivProps" needs to be exported by the entry point index.d.ts |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Might be a good idea to look through these warnings and either export the things that it points out are missing, or figure out how to prevent them from being referenced by exported stuff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, likely I'll keep the warnings in the api reports and add an issue to clean up our exports more generally. There's a good deal of cleanup that could be done regarding exports.
This PR addresses #24 and sets up the API-Extractor. Worth noting the following