Skip to content
This repository has been archived by the owner on Jan 31, 2023. It is now read-only.

IBP VS CodeREADME should guide user when using Typescript sample contracts (ie non-generated) #1219

Closed
2 tasks
mahoney1 opened this issue Aug 2, 2019 · 1 comment
Labels
doc good first issue Good for newcomers wontfix This will not be worked on
Milestone

Comments

@mahoney1
Copy link

mahoney1 commented Aug 2, 2019

Add instruction to README for existing (not generated) TS contracts, like in fabric samples to install dependencies else packaging an open TS contract will err. One of those is typescript to transpile to javascript.

Description

Its obvious to most TS developers to install dependencies for their project, but for (say) TS newbies using Fabric Samples(like Fabcar) in the extension (and/or where they've used Javascript contracts prior) they might need a 'steer'. In discussions, deemed best place for this might be to add to (README)[https://github.com/IBM-Blockchain/blockchain-vscode-extension/]

If opening an existing TS project, the user is required to do an npm install manually first to install dependencies mentioned, such https://github.com/hyperledger/fabric-samples/blob/release-1.4/fabcar/typescript/package.json - in some tutorials, this may already be instructed, but if the IBP extension can mention this, in relation to packaging, it improves the 'lot' of developers / user experience and lets them package contract successfully.

Expected Behavior

Indicate in README they will need to have typescript dependencies installed (in package.json) eg. using npm install, before attempting to package S/C

Actual Behavior

Smart contract has errors, please fix.

Possible Fix

Steps to Reproduce

Existing issues

Log File

Your Environment

  • IBM Blockchain Platform Extension Version:
  • Visual Studio Code version:
  • Environment name and version (e.g. Node.js v8.12.0, npm v6.4.1):
  • Operating System and version:
  • Link to your project:
@cazfletch cazfletch added the doc label Aug 6, 2019
@cazfletch cazfletch added this to the Sprint 16 milestone Sep 11, 2019
@cazfletch cazfletch added the good first issue Good for newcomers label Sep 11, 2019
@erin-hughes erin-hughes self-assigned this Sep 24, 2019
@cazfletch cazfletch modified the milestones: Sprint 16, Sprint 17 Sep 27, 2019
@erin-hughes erin-hughes removed their assignment Oct 2, 2019
@IBM-Blockchain IBM-Blockchain deleted a comment from saqibking12 Feb 17, 2021
@IBM-Blockchain IBM-Blockchain deleted a comment from saqibking12 Feb 17, 2021
@IBM-Blockchain IBM-Blockchain deleted a comment from saqibking12 Feb 17, 2021
@jt-nti jt-nti added the wontfix This will not be worked on label Dec 13, 2022
@jt-nti
Copy link
Contributor

jt-nti commented Dec 13, 2022

See #3183

@jt-nti jt-nti closed this as completed Dec 13, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
doc good first issue Good for newcomers wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

4 participants