A developer can start a new smart contract project

cazfletch / fabric-vscode-extension

Apache License 2.0

0 stars 3 forks source link

A developer can start a new smart contract project #1

Closed heatherlp closed 6 years ago

heatherlp commented 6 years ago

This will be from a yeoman generator. There will be a command that can be run that will use the generator. The command will start the generator then the newly created project will be opened in vscode

The generator can be found

https://www.npmjs.com/package/generator-fabric

Below is an example of how the generator can be run

yo fabric -- --subgenerator=chaincode --language=javascript --name=my-smart-contract --version=0.0.1 --description=blah --author=blah --license=Apache-2.0

heatherlp commented 6 years ago

Stuff I've learned so far:

Add a new command in Command Palette called something like "start fabric project"
allow user to specify location to start project (all other options set to default) via pop up window of their file system
command ran echo-ed + cli output for command displayed in the output window
this opens new smart contract project in that location, shown in explorer view

heatherlp commented 6 years ago

Current branch does this:

new "start Fabric project" command in command palette
prompts the user for a location on their file system and opens it
runs a dummy command in terminal (which will be yo fabric command)

Gonna talk to Ed next week to discuss how we want this to look

branch is here: https://github.com/heatherlp/fabric-vscode-extension/tree/issue1_startfabricproject

heatherlp commented 6 years ago

Notes from meeting Ed, Simran and Nivedhaa:

yes we agree we don't like the way you open a new workspace in VSCode. Show Simon as a VSCode user.
ask the user if they want us to install yo and generator fabric for them (don't make them pre-reqs for the extension installation) and don't wait for those installations to happen before moving on? Get Caroline's and Simon's view.
look into getting the yo command's output shown in the output tab
keyboard shortcuts? add a "start fabric project" button? nah

heatherlp commented 6 years ago

Latest amendment to the commit:

renamed startFabricProject to createfabricProject on advice from MGK
command now opens new fabric project in a new window, and asks the user if it's ok to install yo and generator fabric. It's not possible to open the terminal of the new window (I've asked SO!)
added command to extension.text.ts to check it's registered

Need people's input next week to see if this solution is what we're after

heatherlp commented 6 years ago

delivered under https://github.com/caroline-church/fabric-vscode-extension/commit/7a9490aed8dfe623874829156b458ec3222d52ac and also closed: https://github.ibm.com/IBM-Blockchain/fabric-vscode-extension/issues/1

Doesn't include a fix for: https://github.ibm.com/IBM-Blockchain/fabric-vscode-extension/issues/39