ETH-284: update release workflow and README (#203)

* refactor(config): rename config*.ts to index*.ts

* build(config): update automatic release workflow

* docs(config): update example in README

Author: kare

packages/config/.gitignore

@@ -1,2 +1,3 @@
+/build
 /dist
 /*.tgz

packages/config/Makefile

@@ -31,9 +31,22 @@ build: NODE_ENV = "production"
 build: ## Run build
 	$(call npm, run build)
 
+.PHONY: npm-install
+npm-install:
+	$(call npm, install)
+
+.PHONY: npm-publish
+npm-publish:
+	$(call npm, publish . --access public)
+
+.PHONY: npm-pack
+npm-pack:
+	$(call npm, pack)
+
 .PHONY: clean
 clean: ## Remove generated files
 	$(RM) -r \
+		build \
 		dist \
 		node_modules
 

packages/config/README.md

@@ -11,15 +11,16 @@ npm install --save @streamr/config
 ```
 
 ## Examples
+### Typescript
 Import DATA token production Ethereum address as a variable in a Typescript project:
 ```typescript
-import * as config from "config"
+import * as config from "@streamr/config"
 
 const chains: config.Chains = config.Chains.load("production")
 const contractAddress: string = chains.ethereum.contracts["DATA-token"]
 const chainId: number = chains.ethereum.id
-const httpRpcEndpoints: RPCEndpoint[] = chains.ethereum.getRPCEndpointsByProtocol(RPCProtocol.HTTP)
-const wsRpcEndpoints: RPCEndpoint[] = chains.ethereum.getRPCEndpointsByProtocol(RPCProtocol.WEBSOCKET)
+const httpRpcEndpoints: RPCEndpoint[] = chains.ethereum.getRPCEndpointsByProtocol(config.RPCProtocol.HTTP)
+const wsRpcEndpoints: RPCEndpoint[] = chains.ethereum.getRPCEndpointsByProtocol(config.RPCProtocol.WEBSOCKET)
 ```
 
 You can also load configuration based on `$NODE_ENV` environment variable:
@@ -29,6 +30,14 @@ import * as config from "config"
 const chains: Chains = config.Chains.loadFromNodeEnv()
 ```
 
+### Javascript
+Use in a Javascript project:
+```javascript
+const config = require("@streamr/config")
+const chains: config.Chains = config.Chains.loadFromNodeEnv()
+```
+
+### Other Languages
 Other languages can read the [JSON file](./src/networks.json) directly.
 
 ## Development
@@ -80,12 +89,7 @@ Login to Npmjs.com:
 npm login --registry https://registry.npmjs.org --scope @streamr
 ```
 
-Run build:
-```bash
-make clean build
-```
-
-Create a new release on Npmjs.com, update version in package.json, push a release commit, and tag it on GitHub:
+Run clean build, create a new release on Npmjs.com, update version in `package.json`, push a release commit, and tag it on GitHub:
 ```bash
 ./release.bash 0.0.1
 ```

packages/config/package-lock.json

@@ -2,18 +2,19 @@
   "name": "@streamr/config",
   "version": "0.0.1",
   "description": "Zero dependency package that contains Streamr Network smart contract addresses",
-  "main": "dist/index.js",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
   "directories": {
     "lib": "./dist",
     "src": "./src",
     "test": "./test"
   },
   "files": [
-    "dist/src"
+    "dist"
   ],
   "scripts": {
-    "build": "npm run prepare",
-    "prepare": "tsc --project tsconfig.json",
+    "build": "tsc --project tsconfig.json",
+    "pretest": "tsc --project tsconfig-test.json",
     "test": "mocha --config mocharc.json",
     "lint": "eslint --ext .ts src test"
   },

packages/config/package.json

@@ -30,3 +30,5 @@ fi
 
 sed -i '' -e 's/"version": ".*",$/"version": "'"$version"'",/g' package.json
 git add package.json
+make npm-install
+git add package-lock.json

packages/config/release-npm-publish.bash

@@ -20,6 +20,7 @@ while getopts "h" arg; do
 	esac
 done
 
+make clean
 ./release-git-validate.bash
 
 version="${1-}"
@@ -29,6 +30,6 @@ if test -z "$version"; then
 fi
 
 ./release-validate-semver.bash "$version"
-
 ./release-git-tag.bash "$version"
-./release-npm-publish.bash
+make build
+make npm-publish

packages/config/release-npm-update-version-package-json.bash

@@ -1,6 +1,6 @@
 import { describe, it } from "mocha"
 import { assert } from "chai"
-import * as config from "../src/config"
+import * as config from "../src"
 
 describe("Load configuration from JSON file", () => {
     it("ethereum chain id is 1", () => {