truffle icon indicating copy to clipboard operation
truffle copied to clipboard

Provide an example for leveraging truffle boxes and plugins together for devs

Open CruzMolina opened this issue 5 years ago • 7 comments

Inspired by #1695.

Would be nice to have a documented and viewable example to exhibit how plugin developers can leverage the truffle box mechanism to more easily ship their plugins for consumption.

For example:

truffle unbox userOrg/truffleBox

could install a plugin in an install or postinstall hook, setting users up with a preconfigured truffle config, and output plugin-specific supported commands.

Commands:

  Run plugin: truffle run pluginCommand

Requirements

  1. Create or use an existing truffle plugin npm package.
  2. Create an example truffle box repo configured to install the truffle plugin npm package with a preconfigured truffle config and output for the supported plugin command on successful unboxing.
  3. Update the trufflesuite.com documentation to exhibit the example.

Prerequisite Context

  • Familiarity with the current plugin support documentation: https://truffleframework.com/docs/truffle/getting-started/writing-external-scripts#third-party-plugin-commands
  • Familiarity with creating a truffle box: https://truffleframework.com/docs/truffle/advanced/creating-a-truffle-box
  • Familiarity with the location of the trufflesuite.com truffle plugin documentation: https://github.com/trufflesuite/trufflesuite.com/blob/master/src/docs/truffle/getting-started/writing-external-scripts.md#third-party-plugin-commands

CruzMolina avatar Jun 04 '19 19:06 CruzMolina

@kevinbluer This might be a nice project for a Truffle U student, eh?

eggplantzzz avatar Mar 18 '20 18:03 eggplantzzz

Hello, may I please take this issue?

ghost avatar Mar 10 '22 20:03 ghost

Hey @Lijamaija, thanks for the offer! Do you have an idea of how you want to do this?

eggplantzzz avatar Mar 10 '22 21:03 eggplantzzz

Likewise, many thanks @Lijamaija...more than happy to assist with scoping this out if you'd like. Just let us know 👍

kevinbluer avatar Mar 10 '22 21:03 kevinbluer

@eggplantzzz nothing specific apart from the tutorials at the moment, I am just getting familiar.. Is there something you would like me to try?

@kevinbluer thanks, will send you a message :) much appreciated!

ghost avatar Mar 10 '22 21:03 ghost

@Lijamaija actually I really haven't spent too much time thinking about this. If you want to take a shot at it and go through a team review then please do! Thanks!

eggplantzzz avatar Mar 11 '22 15:03 eggplantzzz

i want to contribute to this issue. can somebody please help me out. am a beginner in open source

Gurpreet-2602 avatar Apr 20 '23 08:04 Gurpreet-2602