embarklabs
/
embark
mirror of https://github.com/embarklabs/embark.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
embark/packages/embarkjs/package.json

83 lines
2.5 KiB
JSON
Raw Normal View History

refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
{
"name": "embarkjs",
chore(release): 4.1.0-beta.3
2019-06-07 18:42:13 +00:00
"version": "4.1.0-beta.3",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"author": "Iuri Matias <iuri.matias@gmail.com>",
"contributors": [],
"description": "JavaScript library for easily interacting with web3 technologies",
feat: normalize README and package.json bugs, homepage, description Make changes by running these commands in the root of the monorepo: **bugs** ```shell npx lerna exec --concurrency 1 --stream -- \ 'DIRPATH=$(realpath $PWD --relative-to=$LERNA_ROOT_PATH); \ npx json -I -f package.json -e "this.bugs=\ \"https://github.com/embark-framework/embark/issues\""' ``` **homepage** ```shell npx lerna exec --concurrency 1 --stream -- \ 'DIRPATH=$(realpath $PWD --relative-to=$LERNA_ROOT_PATH); \ npx json -I -f package.json -e "this.homepage=\ \"https://github.com/embark-framework/embark/tree/master/${DIRPATH}#readme\""' ``` Don't commit changes to private packages, with the exceptions of embark-typings and embark-reset because those may switch from private to public, and also because the latter will be included in `node_modules` of embark even if it is private since embark-reset is presently a bundled dependency of embark. Don't include the homepage and bugs fields in dapps generated from the template packages, except for the demo. Set those dapps' description field to an empty string. Ensure every package (inc. private packages) has a description. Ensure every package (inc. private packages) has a README that begins with: ```markdown `[pkgJson.name]` ================ > [pkgJson.description] Visit [embark.status.im](https://embark.status.im/) to get started with [Embark](https://github.com/embark-framework/embark). ``` Don't include the README in dapps generated from the template packages, except for the demo.
2019-03-08 19:58:27 +00:00
"homepage": "https://github.com/embark-framework/embark/tree/master/packages/embarkjs#readme",
"bugs": "https://github.com/embark-framework/embark/issues",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"keywords": [
"blockchain",
"dapps",
"ethereum",
"ipfs",
"serverless",
"solc",
"solidity"
],
"license": "MIT",
feat: add repository.directory field to package.json See: https://github.com/npm/rfcs/blob/latest/implemented/0010-monorepo-subdirectory-declaration.md Make changes by running this command in the root of the monorepo: ```shell npx lerna exec --concurrency 1 --stream -- \ 'DIRPATH=$(realpath $PWD --relative-to=$LERNA_ROOT_PATH); \ npx json -I -f package.json -e \ "this.repository=\ {\"directory\": \"$DIRPATH\", \ \"type\": \"git\", \ \"url\": \"https://github.com/embark-framework/embark.git\"}"' ``` Don't commit changes to private packages, with the exceptions of embark-typings and embark-reset because those may switch from private to public, and also because the latter will be included in `node_modules` of embark even if it is private since embark-reset is presently a bundled dependency of embark. Don't include the repository field in dapps generated from the template packages, except for the demo.
2019-03-08 15:58:25 +00:00
"repository": {
"directory": "packages/embarkjs",
"type": "git",
"url": "https://github.com/embark-framework/embark.git"
},
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"main": "dist/node/index.js",
"browser": {
"./dist/node/index.js": "./dist/browser/index.js"
},
"browserslist": [
"last 1 version",
"not dead",
"> 0.2%"
],
"files": [
"dist"
],
"scripts": {
"build": "npm-run-all build:**",
build: use babel cli's `--extensions` consistently in all packages If a package uses only `.js` then supply `--extensions ".js"`. If a package uses only `.ts` then supply `--extensions ".ts"`. If a package uses both, then supply `--extensions ".js,.ts"`. The reason for this is that adding/removing TS/JS support ought to occasion revising a package's `package.json` file and adjusting other scripts as well, e.g. for linting. With these changes, it won't work to simply start adding `.ts` files in a package's `src/` directory, which should prompt the developer to review `package.json` and make the appropriate changes, and/or other developers may realize changes need to be made during code review.
2019-05-02 18:24:38 +00:00
"build:browser": "cross-env BABEL_ENV=browser babel src --extensions \".js\" --out-dir dist/browser --root-mode upward",
"build:node": "cross-env BABEL_ENV=node babel src --extensions \".js\" --out-dir dist --root-mode upward --source-maps",
"build:node:async": "cross-env BABEL_ENV=node:async babel src/node --extensions \".js\" --out-dir dist --root-mode upward --source-maps",
"build:node:test": "cross-env BABEL_ENV=node:test babel test --extensions \".js\" --out-dir build-test --root-mode upward --source-maps",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"ci": "npm run qa",
build: make DApp templates member packages of the monorepo Previously, templates were in a subdirectory of `packages/embark`. Reorganize them so that they are member packages of the monorepo. This allows them to cleanly depend on other members of the monorepo, e.g. `embarkjs-connector-web3`. It is desirable for the templates, in the context of the monorepo, to specify embark as a dependency, to take advantage of `npx embark test` (and it's a "forward looking" setup re: how we plan to evolve embark). However, if embark were to specify the template packages as dependencies a circular relationship would be introduced, which is [unsupported by Lerna][circular]. Therefore, revise the template generator so that all templates are resolved / fetched at runtime, i.e. `boilerplate`, `demo`, and `simple` are no longer "built-ins" *per se*. This change won't be apparent to embark's users, but it does mean that the template generator won't work (in a production install of embark) if it can't connect to the npm registry, i.e. when the user runs `embark demo` or `embark new [--simple]`. When embark is inside the monorepo, templates are resolved and copied from the yarn workspace rather than being fetched from the registry, which is convenient for development. Also, any template dependencies that are members of the monorepo are linked into the copied template's `node_modules` rather than being installed from the registry, again for convenience. During template generation, remove scripts and dependencies that pertain only to membership in the monorepo; for now, that involves removing embark as a dependency since we're not quite ready for that arrangement to be the default, i.e. outside of the monorepo. Refactor the root scripts so that more of them can consistently be used with Lerna's filter options, e.g. `--scope` and `--ignore`. "Combo" scripts that don't support filtering generally have a `:full` postfix. Flip `clean` and `reset` scripts at the root and in the member packages for consistency re: Lerna's notion of `clean` and embark's notion of `reset`. Have each package run its `reset` script when its `clean` script is invoked (and that's all for now), relying on `lerna clean` to delete packages' `node_modules` in view of how Lerna's topological sorting works. Lift the implementation of `embark reset` into a private package in `packages/embark-reset` and make it a bundled dependency of embark. Packages in `dapps/*` depend on `embark-reset` directly and make use of it with `npx embark-reset` (but only in monorepo context). This removes a "wart" where reboots could show errors when embark's sources aren't already built in `packages/embark/dist`. Users will not notice any difference since `embark reset` works as before, transparently making use of the `embark-reset` package. The only downside to having it be a bundled dependency of embark is that bundled deps have all of their `node_modules` included in the tarball built with `npm pack` (that's why having the templates as bundled dependencies of embark isn't a viable approach). However, `embark-reset` only has one dependency, `rimraf`, which is a tiny module, so the cost seems acceptable. As part of the reorganization, move `test_dapps` into `dapps/tests` and `packages/embark/templates` into `dapps/templates`. Keep the directory names short but revise the package names to facilitate simple filtering with `embark-dapp-*`. Consolidate `.yarnrc` and `.gitignore` and clean up some redundant ignore listings. Scripts run with `--scope embark-dapp-*` use `--concurrency=1` to avoid conflicts that could arise over network ports. The `ci:full` and `qa:full` scripts use `--concurrency=1` in all scopes, for two reasons: resource limitations on Travis and AppVeyor result in slower runs with concurrency >1, and if something fails in those contexts it's easier to see what went wrong when Lerna's output isn't interleaved from a bunch of scripts in `packages/*`. Bump the Lerna version. [circular]: https://github.com/lerna/lerna/issues/1198#issuecomment-442278902
2019-02-25 20:47:54 +00:00
"clean": "npm run reset",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"package": "npm pack",
"qa": "npm-run-all build test package",
build: adjust reset script to delete coverage dirs if pkg has test script Make the adjustment even if the test script is currently disabled. Consistently use nyc to generate coverage with mocha even if the test script is currently disabled.
2019-05-16 17:02:24 +00:00
"reset": "npx rimraf .nyc_output build-test coverage dist embarkjs-*.tgz package",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"start": "npm run watch",
test: collect code coverage in the root of the monorepo Implement scripts to collect coverage reports (JSON format) from all packages in the monorepo that generate such reports. Reports are copied to `<root>/.nyc_output/coverage-[pkg-dir-name].json`. Implement scripts to generate a combined html report in `<root>/coverage`. Adjust root `reset` and `clean` scripts to delete `<root>/.nyc_output` and `<root>/coverage`. Implement a script in `<root>/package.json` to generate a `text-lcov` report and upload it to coveralls from CI builds. Remove coveralls from `packages/embark`. Supply `packages/embark` with an nyc configuration in its `package.json` and have its `"test":` script generate both `json` and `html` reports. Use nyc with `embarkjs`'s test suite: supply an nyc configuration in its `package.json` and have its `"test":` script generate both `json` and `html` reports. Adjust `embarkjs`'s tests for more accurate coverage reporting.
2019-04-28 21:33:41 +00:00
"test": "nyc --reporter=html --reporter=json mocha \"build-test/**/*.js\" --exit --no-timeouts --require source-map-support/register",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"watch": "run-p \"build:** -- --verbose --watch\""
},
test: collect code coverage in the root of the monorepo Implement scripts to collect coverage reports (JSON format) from all packages in the monorepo that generate such reports. Reports are copied to `<root>/.nyc_output/coverage-[pkg-dir-name].json`. Implement scripts to generate a combined html report in `<root>/coverage`. Adjust root `reset` and `clean` scripts to delete `<root>/.nyc_output` and `<root>/coverage`. Implement a script in `<root>/package.json` to generate a `text-lcov` report and upload it to coveralls from CI builds. Remove coveralls from `packages/embark`. Supply `packages/embark` with an nyc configuration in its `package.json` and have its `"test":` script generate both `json` and `html` reports. Use nyc with `embarkjs`'s test suite: supply an nyc configuration in its `package.json` and have its `"test":` script generate both `json` and `html` reports. Adjust `embarkjs`'s tests for more accurate coverage reporting.
2019-04-28 21:33:41 +00:00
"nyc": {
"exclude": [
"**/node_modules/**",
"build-test/**",
"coverage/**"
]
},
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"dependencies": {
"@babel/runtime-corejs2": "7.3.1",
"async": "2.6.1",
"async-es": "2.6.1"
},
"devDependencies": {
"@babel/cli": "7.2.3",
"@babel/core": "7.2.2",
"ajv": "6.5.2",
"chai": "4.2.0",
"cross-env": "5.2.0",
"lodash.clonedeep": "4.5.0",
"mocha": "5.2.0",
"npm-run-all": "4.1.5",
test: collect code coverage in the root of the monorepo Implement scripts to collect coverage reports (JSON format) from all packages in the monorepo that generate such reports. Reports are copied to `<root>/.nyc_output/coverage-[pkg-dir-name].json`. Implement scripts to generate a combined html report in `<root>/coverage`. Adjust root `reset` and `clean` scripts to delete `<root>/.nyc_output` and `<root>/coverage`. Implement a script in `<root>/package.json` to generate a `text-lcov` report and upload it to coveralls from CI builds. Remove coveralls from `packages/embark`. Supply `packages/embark` with an nyc configuration in its `package.json` and have its `"test":` script generate both `json` and `html` reports. Use nyc with `embarkjs`'s test suite: supply an nyc configuration in its `package.json` and have its `"test":` script generate both `json` and `html` reports. Adjust `embarkjs`'s tests for more accurate coverage reporting.
2019-04-28 21:33:41 +00:00
"nyc": "13.1.0",
build(embarkjs): clean script should invoke 'npx rimraf' Packages' `"clean"` scripts should run regardless of whether `node_modules` is in place at the root and/or package levels, but the `embarkjs` package was missing a needed `npx` in front of `rimraf` in its script. Also, bump its devDeps version of rimraf to be in line with the rest of `packages/*` and `test_dapps/*`.
2019-02-14 07:01:18 +00:00
"rimraf": "2.6.3",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"source-map-support": "0.5.9",
"web3": "1.0.0-beta.37"
},
"engines": {
build: change the engines range for NodeJS to indicate embark is not compatible with v12.x
2019-05-24 22:17:16 +00:00
"node": ">=8.12.0 <12.0.0",
refactor: add embarkjs to the monorepo Don't import git history of embark-framework/EmbarkJS, simply copy over the sources. Modify `package.json`, etc. re: being situated in the monorepo. Make use of the root babel config but extend with `packages/embarkjs/.babelrc.js`. Build `test/` scripts into `build-test/` and git-ignore `build-test/`. Revise `Blockchain.connect()` so that if the caller supplies a callback then a promise is not returned. Revise tests to test `Blockchain.connect()` usage with and without a callback.
2019-02-06 23:38:12 +00:00
"npm": ">=6.4.1",
"yarn": ">=1.12.3"
}
}