@flowtyio/flow-contracts 0.0.3 → 0.0.4

package/README.md

@@ -4,6 +4,33 @@
 npm i @flowty/flow-contracts
 ```
 
+## Commands
+
+**These commands assume you have installed flow-contracts and npx on your machine**
+
+You can use `flow-contracts` to edit your own flow configuration so that you don't have to manually add contracts to your project.
+Currently, there are two commands:
+- add -> adds a contract and its dependencies to your flow.json
+- add-all -> adds all contracts in this repo to your flow.json
+
+### Add a contract
+
+Adds a contract and its dependencies to your flow.json. This command will also add the contract to your emulator deployment section.
+If there are any contracts already defined in your config which would be imported, it will be skipped
+
+```
+npx flow-contracts add MetadataViews -c /path/to/config/flow.json
+```
+
+### Add all contracts
+
+Adds all contracts maintained in this repo to your own flow.json, and add them to your emulator deployment section.
+
+```
+npx flow-contracts add-all -c /path/to/config/flow.json
+```
+
+
 This repository publishes common Flow contracts as an npm package so that they can be more easily consumed. 
 Currently, the list includes:
 
@@ -102,4 +129,4 @@ you will need to:
 If you would like to request other contracts be included, please create a ticket, or submit a PullRequest to add them and
 ping us on Twitter/Discord.
 
-Cheers!
+Cheers!

package/add.js

@@ -48,6 +48,8 @@ const importContract = (contractName, source, config, account) => {
     return
   }
 
+  contract.source = `./node_modules/@flowtyio/flow-contracts/contracts/${contractName}.cdc`
+
   if (specialContractsHandlers[contractName]) {
     specialContractsHandlers[contractName](contract, newConfig, account)
   } else {
@@ -70,12 +72,14 @@ const add = ({name, config, account}) => {
 
   const exampleConfigLocation = `${__dirname}/flow.json`
   const exampleConfig = getConfig(exampleConfigLocation)
-  const contract = exampleConfig.contracts[name]
+  let contract = exampleConfig.contracts[name]
   if (!contract) {
     console.error(`Contract "${name}" could not be found`)
     return
   }
 
+  contract.source = `./node_modules/@flowtyio/flow-contracts/contracts/${name}.cdc`
+
   if (!userConfig.contracts) {
     userConfig.contracts = {}
   }

package/index.js

@@ -10,7 +10,7 @@ program
   .description("A CLI to help manage and import Flow contracts")
 
 program.command('add')
-  .description('Add a contract to your flow.json config')
+  .description('Add a contract (and its dependencies) to your flow.json config')
   .argument('<contractName>', 'The contract to be added')
   .option('-c, --config <config>', 'File location of the config to be edited')
   .option('-a, --account <account>', 'Account that will deploy this imported contract', 'emulator-account')

package/package.json

@@ -1,13 +1,10 @@
 {
     "name": "@flowtyio/flow-contracts",
-    "version": "0.0.3",
+    "version": "0.0.4",
     "main": "index.json",
     "description": "An NPM package for common flow contracts",
     "author": "flowtyio",
     "license": "MIT",
-    "scripts": {
-        "add": "node ./index.js add"
-    },
     "repository": {
         "type": "git",
         "url": "git+https://github.com/Flowtyio/flow-contracts.git"
@@ -23,8 +20,6 @@
     },
     "homepage": "https://github.com/Flowtyio/flow-contracts/blob/main/README.md",
     "dependencies": {
-        "command-line-args": "^5.2.1",
-        "command-line-commands": "^3.0.2",
         "commander": "^11.0.0"
     },
     "bin": {