diff --git a/packages/config/.gitignore b/packages/config/.gitignore index 1446f010a..20782b130 100644 --- a/packages/config/.gitignore +++ b/packages/config/.gitignore @@ -1,2 +1,3 @@ +/build /dist /*.tgz diff --git a/packages/config/Makefile b/packages/config/Makefile index 52e3c2099..a554ec7a7 100644 --- a/packages/config/Makefile +++ b/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 diff --git a/packages/config/README.md b/packages/config/README.md index 2d51ccf19..a7520bbff 100644 --- a/packages/config/README.md +++ b/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 ``` diff --git a/packages/config/package-lock.json b/packages/config/package-lock.json new file mode 100644 index 000000000..f6f556f1b --- /dev/null +++ b/packages/config/package-lock.json @@ -0,0 +1,13 @@ +{ + "name": "@streamr/config", + "version": "0.0.1", + "lockfileVersion": 2, + "requires": true, + "packages": { + "": { + "name": "@streamr/config", + "version": "0.0.1", + "license": "MIT" + } + } +} diff --git a/packages/config/package.json b/packages/config/package.json index b86f857d8..f844e994b 100644 --- a/packages/config/package.json +++ b/packages/config/package.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" }, diff --git a/packages/config/release-npm-publish.bash b/packages/config/release-npm-publish.bash deleted file mode 100755 index 3f891c60d..000000000 --- a/packages/config/release-npm-publish.bash +++ /dev/null @@ -1,23 +0,0 @@ -#!/bin/bash - -set -e -u -o pipefail - -function usage() { - local name - name=$(basename "$0") - echo "$name: Publish new version in Npm" 1>&2 - echo "Usage: $name [-h]" 1>&2 - echo " -h Show help" 1>&2 - echo "Example: $name" 1>&2 -} - -while getopts "h" arg; do - case $arg in - h|*) # Show help - usage - exit 1 - ;; - esac -done - -npm publish . --access public diff --git a/packages/config/release-npm-update-version-package-json.bash b/packages/config/release-npm-update-version-package-json.bash index a1a37ccf0..8fda74e55 100755 --- a/packages/config/release-npm-update-version-package-json.bash +++ b/packages/config/release-npm-update-version-package-json.bash @@ -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 diff --git a/packages/config/release.bash b/packages/config/release.bash index 3bf223848..e4552d6fc 100755 --- a/packages/config/release.bash +++ b/packages/config/release.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 diff --git a/packages/config/src/config.ts b/packages/config/src/index.ts similarity index 100% rename from packages/config/src/config.ts rename to packages/config/src/index.ts diff --git a/packages/config/test/config.test.ts b/packages/config/test/index.test.ts similarity index 98% rename from packages/config/test/config.test.ts rename to packages/config/test/index.test.ts index 60e3357a6..0d4747184 100644 --- a/packages/config/test/config.test.ts +++ b/packages/config/test/index.test.ts @@ -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", () => { diff --git a/packages/config/tsconfig-test.json b/packages/config/tsconfig-test.json new file mode 100644 index 000000000..3a3935b4f --- /dev/null +++ b/packages/config/tsconfig-test.json @@ -0,0 +1,77 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es2020", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ + "lib": [ /* Specify library files to be included in the compilation. */ + "es6" + ], + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */ + "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + "outDir": "./build", /* Redirect output structure to the directory. */ + "rootDir": ".", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ + // "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + + /* Advanced Options */ + "skipLibCheck": true, /* Skip type checking of declaration files. */ + "forceConsistentCasingInFileNames": true, /* Disallow inconsistently-cased references to the same file. */ + "resolveJsonModule": true, + }, + "include": [ + "test/**/*.ts" + ] +} diff --git a/packages/config/tsconfig.json b/packages/config/tsconfig.json index dcf74a1b1..286cf3cac 100644 --- a/packages/config/tsconfig.json +++ b/packages/config/tsconfig.json @@ -4,7 +4,7 @@ /* Basic Options */ // "incremental": true, /* Enable incremental compilation */ - "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ + "target": "es2020", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ "lib": [ /* Specify library files to be included in the compilation. */ "es6" @@ -73,6 +73,5 @@ }, "include": [ "src/**/*.ts", - "test/**/*.ts" ] }