chore(toolkit): cleanup public interfaces#105
Conversation
mrgrain
temporarily deployed
to
integ-approval
GitHub Actions
Inactive
|
|
||
| toolkitLib.addTask('docs', { | ||
| exec: 'typedoc lib/index.ts --excludeExternals --excludePrivate --excludeProtected --excludeInternal', | ||
| exec: 'typedoc lib/index.ts', |
There was a problem hiding this comment.
This is now all in typedoc.json
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #105 +/- ##
==========================================
- Coverage 84.44% 84.36% -0.09%
==========================================
Files 196 196
Lines 35089 35089
Branches 4509 4506 -3
==========================================
- Hits 29632 29603 -29
- Misses 5320 5342 +22
- Partials 137 144 +7
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Enum values need to be the same in CLI and Toolkit Lib. This option is not publicly exposed as a CLI option, so changing the value is okay
There was a problem hiding this comment.
I would advise against load-bearing enum values to begin with. Just because TypeScript allows you to do it doesn't mean it's a good idea. If you need to translate between two enums that are structurally but not nominally the same, the boring and annoying (but safe and correct) way to do it would be:
function enumOneToTwo(x: my.AssetBuildTime): their.AssetBuildTime {
switch (x) {
case my.AssetBuildTime.VALUE_ONE: return their.AssetBuildTime.VALUE_ONE;
case my.AssetBuildTime.VALUE_TWO: return their.AssetBuildTime.VALUE_TWO;
// ...
}
}
In #105 I renamed the interface from `Extend` to `Expand`, but forgot the options itself and some docs. This is marked as a chore so it doesn't show up in the changelog for the first release. That's what we want, because it is not relevant to users just yet. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license
4 participants
Clean-up public interface and docs generation in preparation of the release.
This mostly moves some previously public interfaces to be private, renames interface and removes unused options.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license