Skip to content
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

[tools] refactor gdad version param, update TypeDoc and TS #17515

Merged
merged 1 commit into from
May 16, 2022

Conversation

Simek
Copy link
Collaborator

@Simek Simek commented May 16, 2022

Why

It looks like the version parameter in gdad command from Expo Tools is a bit confusing for people, let's refactor it.

How

This PR refactors the gdad command, changes the version parameter to sdk, adds the output path validation with an helpful (I hope) error.

I have also bumped TypeDoc and TypeScript dependencies in tools. The changes in JSON files are only related to the new features, which added qualifiedName and package for some of the references:

Test Plan

The changes have been tested by recompiling and running Expo Tolls locally. Compilation do not output any new warning/errors after bumps.

I have also checked, that et gdad --sdk executed with invalid parameter value results in error:

Screenshot 2022-05-16 at 11 20 47

Checklist

  • Documentation is up to date to reflect these changes (eg: https://docs.expo.dev and README.md).
  • This diff will work correctly for expo build (eg: updated @expo/xdl).
  • This diff will work correctly for expo prebuild & EAS Build (eg: updated a module plugin).

@Simek Simek requested a review from tsapeta as a code owner May 16, 2022 09:31
@expo-bot expo-bot added the bot: passed checks ExpoBot has nothing to complain about label May 16, 2022
Copy link
Member

@tsapeta tsapeta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks. Although I'm not a big fan of upgrading deps on each occasion and so many docs data as well.

@Simek
Copy link
Collaborator Author

Simek commented May 16, 2022

Although I'm not a big fan of upgrading deps on each occasion

FYI, I have upgraded the TypeDoc only initially, since this PR involved working with its code anyway, but this result in warning that current used TS version might not support newly added feature. Additionally I have saw this PR lately (#17387), so the TS bump is on the schedule for workspace. Tools are detached, so I thought that I have kill two birds with one stone. 😛

and so many docs data as well.

This is out of our control IMO, the reason why I have updated the files is that I want to avoid the confusion for someone who updates the TSDoc and want to regenerate data file to test the rendering on the docs side and after running et gdad instead of seeing one JSON changed for edited package they will see the list of several packages, and have no clue why they have been changed.

Also, as you know, I'm still the advocator of adding/hooking up JSON files regeneration into the package build process, which should also help/streamline the data generation. However bumping TypeDoc probably will always require the manual regeneration. 😅

Copy link
Contributor

@barthap barthap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it, this is gonna make me stop forgetting the v prefix when specifying the version 😉

@Simek Simek merged commit a2e0af1 into expo:main May 16, 2022
@Simek Simek deleted the @simek/tools-gdad-sdk-param-deps-bump branch May 16, 2022 12:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot: passed checks ExpoBot has nothing to complain about
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants