refactor: commands now register themselves#475
Merged
Conversation
Contributor
|
LGTM! |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This is based off the plugin API spec. All ShellJS commands now register themselves from within their source file. The only modification that is required to
shell.jsis to put:for a hypothetical new command named
foo()implemented inside ofsrc/foo.js.In a possible future plugin, the
//@includewould be unnecessary (that's for our internal docs) and therequire()statement would be all that is needed by the plugin's end-user. The plugin hypothetically doesn't even need to export anything, because the plugin author can require ShellJS as a peer dependency and modify the existing ShellJS instance using a call tocommon.register().Let's wait to merge this until after #452 is merged, since I can quickly resolve the merge conflict. Send feedback my way in the meantime, however.