Refactor for plugin capability, add pods and npm clean commands #12

mikehardy · 2019-05-17T05:36:10Z

Hi there!

A few of us in the react-native-community were discussing how we could never escape the need to completely wipe out state and start clean, and the react-native command line should just have a command for it.

The CLI maintainers mentioned we could probably do it as a plugin pretty quickly, and I found this project, and thought you might be okay with refactoring it so it could be used as a plugin?

So I did that, and I also added a couple extra possible commands - pod delete, pod update, and npm cache clean

It should work with both CLI 1.x and the upcoming 2.x for react-native 0.60, and you just need to do react-native clean-project or react-native clean-project-auto to have it either take you through the questions, or just purge everything respectively

If it's merge-worthy, it fixes react-native-community/cli#387

pmadruga · 2019-05-17T13:48:20Z

Thanks for this and yes, it can totally be used as a plugin. I will only ask for retroactive compatibility and any changes requested that may have come from the review. Jumping to the review now.

pmadruga

Looks good to me. Left a few comments. Somethings are mandatory:

A README update
Writing a test ensuring a specific task has been called (you can use Tapejs for this)

And beware that the version of node on this project is slightly older (=>8*) than the one in React Native's documentation.

👍

package.json

source/plugin.js

source/internals.js

mikehardy · 2019-05-17T15:41:10Z

Oh great - I'm sure we can get this in a shape you like then. I'm pretty agnostic on everything except that things should work and be easy to maintain :-). I'll go through your review now

mikehardy · 2019-05-17T15:46:17Z

Worth mentioning that I agree 100% on backwards compatibility, I see no reason this should be a breaking change in any way, it's really just making the code so it can be wrapped, then doing so. I think the community will really like this - they were excited when I showed them this package, since the UI and feedback is really cool for users

…nore example project

- refactor original implementation into separate internal modules - re-package implementation for use as react-native-community/cli plugin (v1 and v2) - turn contents section in README into a table, describe when tasks run - change spawn to use shell: true so we can group tasks - alter watchman task to add '|| true' so it does not return an error - add test to verify current tasks run in plugin auto mode Fixes #12 / Fixes react-native-community/cli#387

mikehardy · 2019-05-19T02:11:45Z

Okay @pmadruga (and @thymikee if you have interest) - I think this one is an actual Pull Request as opposed to a quick-and-dirty Proposal Request like it was originally. Please take a fresh look and let me know what think?

CONTRIBUTING.md

package.json

pmadruga

Looks good 👍 Left some comments. Also, I'll create a dist version of this lib in the future so I also left a comment to make sure I can just edit it one/two places.

CONTRIBUTING.md

pmadruga · 2019-05-19T07:18:36Z

CONTRIBUTING.md

@@ -119,7 +119,7 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.

-### Scope
+### Code of Conduct Scope


Why this change?

This was markdown lint - there were two headings with identical contents, so generated header anchors won't work. So I just changed one slightly. It's just lint so I don't really care, but it's a valid technical change - if it's a poor stylistic change, easy to revert. What do you think?

Looks good. Thank you!

README.md

pmadruga · 2019-05-19T07:24:38Z

source/index.js

+const { executeTask } = require('./internals/executor');
+const { tasks } = require('./internals/tasks');
+
+options.askiOS()


I think the askiOS should be separated from the askAndroid task, opposed to the latter being included in the first. It will allow some concern separation in the short term (e.g., the askiOS shouldn't run tasks.wipeAndroidBuildFolder) and also more scalable in the future, in case we then want to really add OS specific tasks.

Okay - let me think about that one (to do it well) and address it

Hmm - on review I think this is original structure as well - they were mixed to start - and is orthogonal to my changes. I need to draw boundaries or I'll be on this forever. If it was simple I'd go after it immediately but really it should be two phases fully separate / one for all asking, and one for all execution. It's sort of like that now but if you want to disentangle it's really going to be up to your taste and there is a large chance I won't do it the way you'll want to live with. Additionally there already were OS-specific tasks, but they weren't handled that way to begin with (brew is macOS only, pods are new and macOS only so I just followed the pattern of brew, watchman isn't on linux but is on windows and mac, there's no "choco" but that is recommended for windows etc, also some people use yarn some use npm, the package install should check for yarn.lock or package-lock.json). So there's lots of scope here to do it really right, but I followed existing pattern. I'd like to leave this for now if possible?

You're right and I totally agree to leave it for now. I'll get to it in the future then.

(I hope my comment before didn't sound as criticism)

:-), no worries - I love a good engineering debate, it makes great software. Just running out of time and wanted to fix the scope out of self-interest haha

package.json

pmadruga · 2019-05-19T17:27:14Z

source/plugin.js

+      console.log('Use \`./node_modules/.bin/react-native-clean-project\' for total control');
+      console.log('');
+
+      rlInterface.close(); // if we don't do this it hangs waiting for input


The tests' results also raise a warning regarding an open task that's keeping preventing jest from exiting, and it's related to rlInterface. You can check it by running ./node_modules/.bin/jest --detectOpenHandles. Can you give it a look, please?

I gave that one a long look and I'm not sure how to fix it well. My general take was that it was like that before - by which I mean structurally you have the readline opened immediately whether it will be used or not, then you close it in an unrelated area. My conversion to a plugin style didn't relate to that though it did mean I had to be careful to close it myself in plugin.js. Unfortunately even though I'm closing it there it isn't closing when run by jest.

It was late enough at night and I'd worked enough on it that after contemplating the "no fix" path (no real consequence) I let it go. It's an existing issue with the code that needs cleaning but it'll require re-organizing how readline is used in the options.js which are orthogonal to my change.

Can we let it go for this PR?

You also have a point here and I'll take it in another PR. Thank you for explaining it thoroughly.

mikehardy · 2019-05-19T19:57:37Z

Thanks so much for the quick review, great comments and I'll fix what's obviously wrong while waiting for your reply on the rest.

mikehardy · 2019-05-19T20:19:15Z

Okay - I've addressed all the comments, even if for the 2 more substantial ones I was essentially pleading to keep them separate. Let me know what you think - thanks!

All comments have been addressed.

pmadruga · 2019-05-19T21:07:05Z

Thanks for the replies, @mikehardy . The PR looks great and exposed some of the issues that I need to address. Thumbs up from me. I'll merge as soon as possible - would just like @thymikee 's thumbs up.

And overall, thanks for this PR.

pmadruga

💯

source/plugin.js

mikehardy · 2019-05-20T02:49:30Z

Fantastic! I'm not part of the CLI team (I just run around making changes on things that drive me crazy personally) but I am going to use the heck out of this thing now. If the CLI folks want to keep this out of core I could see this plugin being the de facto standard at which point you and your module will be #InternetFamous, which is fun :-). Cheers

Co-Authored-By: Michał Pierzchała <thymikee@gmail.com>

mikehardy · 2019-05-20T02:53:25Z

@thymikee I'm so glad you looked at this, I would have never known that helped the CLI, not knowing the internals. I committed your suggestion exactly as is

mikehardy · 2019-05-24T14:52:55Z

@pmadruga Any chance of a release with this soon 🙏 😃 - would love to recommend this as a simple npm install vs using a git master dependency

pmadruga · 2019-05-24T20:07:32Z

Done :)

mikehardy mentioned this pull request May 17, 2019

Add clean command react-native-community/cli#387

Closed

pmadruga self-requested a review May 17, 2019 13:43

pmadruga previously requested changes May 17, 2019

View reviewed changes

package.json Outdated Show resolved Hide resolved

source/plugin.js Show resolved Hide resolved

source/internals.js Outdated Show resolved Hide resolved

mikehardy mentioned this pull request May 17, 2019

Bugs in Android versions react-native-share/react-native-share#497

Closed

mikehardy added 6 commits May 18, 2019 16:08

style(README): markdown lint

617efa1

test(example): add dev cycle infrastructure - create and sync, but ig…

9e0d402

…nore example project

chore(eslint): update eslint package

d14d9dd

style(CONTRIBUTING.md): markdown lint

134f208

fix: handle possibly missing yarn, make dev-init mac-compatible

aec7007

mikehardy commented May 19, 2019

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

mikehardy commented May 19, 2019

View reviewed changes

package.json Outdated Show resolved Hide resolved

pmadruga reviewed May 19, 2019

View reviewed changes

pmadruga approved these changes May 19, 2019

View reviewed changes

thymikee approved these changes May 19, 2019

View reviewed changes

source/plugin.js Outdated Show resolved Hide resolved

fix: Update source/plugin.js to return result of promise

01993db

Co-Authored-By: Michał Pierzchała <thymikee@gmail.com>

pmadruga merged commit 523cb11 into pmadruga:master May 20, 2019

mikehardy deleted the plugin branch May 20, 2019 14:06

mikehardy mentioned this pull request May 20, 2019

Can't make this library work in ExpoKit project, IOS react-native-device-info/react-native-device-info#668

Closed

mikehardy mentioned this pull request Jun 4, 2019

@firebase/firestore: Firestore (6.0.4): INTERNAL UNHANDLED ERROR: configureNetworkMonitoring firebase/firebase-js-sdk#1824

Closed

mikehardy mentioned this pull request Jun 26, 2019

Another alternative mikehardy/jetifier#21

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor for plugin capability, add pods and npm clean commands #12

Refactor for plugin capability, add pods and npm clean commands #12

mikehardy commented May 17, 2019

pmadruga commented May 17, 2019

pmadruga left a comment

mikehardy commented May 17, 2019

mikehardy commented May 17, 2019

mikehardy commented May 19, 2019

pmadruga left a comment

pmadruga May 19, 2019

mikehardy May 19, 2019

pmadruga May 19, 2019 •

edited

Loading

pmadruga May 19, 2019

mikehardy May 19, 2019

mikehardy May 19, 2019

pmadruga May 19, 2019

mikehardy May 20, 2019

pmadruga May 19, 2019

mikehardy May 19, 2019

pmadruga May 19, 2019

mikehardy commented May 19, 2019 •

edited

Loading

mikehardy commented May 19, 2019

pmadruga commented May 19, 2019

pmadruga left a comment

mikehardy commented May 20, 2019

mikehardy commented May 20, 2019

mikehardy commented May 24, 2019

pmadruga commented May 24, 2019

Refactor for plugin capability, add pods and npm clean commands #12

Refactor for plugin capability, add pods and npm clean commands #12

Conversation

mikehardy commented May 17, 2019

pmadruga commented May 17, 2019

pmadruga left a comment

Choose a reason for hiding this comment

mikehardy commented May 17, 2019

mikehardy commented May 17, 2019

mikehardy commented May 19, 2019

pmadruga left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pmadruga May 19, 2019 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mikehardy commented May 19, 2019 • edited Loading

mikehardy commented May 19, 2019

pmadruga commented May 19, 2019

pmadruga left a comment

Choose a reason for hiding this comment

mikehardy commented May 20, 2019

mikehardy commented May 20, 2019

mikehardy commented May 24, 2019

pmadruga commented May 24, 2019

pmadruga May 19, 2019 •

edited

Loading

mikehardy commented May 19, 2019 •

edited

Loading