Remove plugin dev files from npm package #4433
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tomekzaw
reviewed
May 8, 2023
Co-authored-by: Tomek Zawadzki <tomasz.zawadzki@swmansion.com>
tomekzaw
approved these changes
May 8, 2023
fluiddot
pushed a commit
to wordpress-mobile/react-native-reanimated
that referenced
this pull request
Jun 5, 2023
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect. --> ## Summary Currently development files from `plugin/` are included in npm package. This PR removes them from it. b4: <img width="253" alt="Screenshot 2023-05-08 at 14 39 29" src="https://user-images.githubusercontent.com/40713406/236829343-1865480f-99d0-4843-adb2-f658db2acce0.png"> after: <img width="238" alt="Screenshot 2023-05-08 at 14 39 51" src="https://user-images.githubusercontent.com/40713406/236829379-7c31b6b4-27e1-493c-8be0-6254edbd0c4c.png"> Since [README is always included](https://docs.npmjs.com/cli/v6/configuring-npm/package-json#files) I renamed plugin's dev README and removed `README` from being included in `package.json`. ## Test plan I recommend using this powerful oneliner: `./createNPMPackage.sh && mkdir tarball-new && mv react-native-reanimated-3.1.0.tgz tarball-new && tarball-new && tar -xf react-native-reanimated-3.1.0.tgz && ..` to see the contents of the new package. Also run _some_ Example App to see if Reanimated plugin from the tarball is actually working. --- _Note_: Testing this PR took me longer than it should. For some reason with current configuration of Example App and running it on Android (I didn't check iOS) it's surprisingly difficult to use reanimated from either tarball or unpacked tarball directory. I had to make a new app and then include Example's source code there. While it's not that troublesome I think we should have a more streamlined approach for using custom reanimated package location for tests with our Examples. --------- Co-authored-by: Tomek Zawadzki <tomasz.zawadzki@swmansion.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Currently development files from
plugin/are included in npm package. This PR removes them from it.b4:
after:
Since README is always included I renamed plugin's dev README and removed
READMEfrom being included inpackage.json.Test plan
I recommend using this powerful oneliner:
./createNPMPackage.sh && mkdir tarball-new && mv react-native-reanimated-3.1.0.tgz tarball-new && tarball-new && tar -xf react-native-reanimated-3.1.0.tgz && ..to see the contents of the new package.
Also run some Example App to see if Reanimated plugin from the tarball is actually working.
Note: Testing this PR took me longer than it should.
For some reason with current configuration of Example App and running it on Android (I didn't check iOS) it's surprisingly difficult to use reanimated from either tarball or unpacked tarball directory. I had to make a new app and then include Example's source code there.
While it's not that troublesome I think we should have a more streamlined approach for using custom reanimated package location for tests with our Examples.