status-im
/
sourcecred
mirror of https://github.com/status-im/sourcecred.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
sourcecred/package.json

128 lines
3.7 KiB
JSON
Raw Normal View History

Frontend setup (#13) * Initial infrastructure for sourcecred-explorer. Setup npm, yarn, flow, jest using scaffolding from create-react-app. - used create-react-app to get the basic pieces - added support for flow via instructions in the create-react-app user guide - added flow-typed so that flow+jest will work well * Add some additional resources * Add index.css * Remove .DS_STORE per @wchargin's suggestion
2018-02-16 22:32:24 +00:00
{
Change package.json name to sourcecred (#215)
2018-05-05 07:04:42 +00:00
"name": "sourcecred",
Frontend setup (#13) * Initial infrastructure for sourcecred-explorer. Setup npm, yarn, flow, jest using scaffolding from create-react-app. - used create-react-app to get the basic pieces - added support for flow via instructions in the create-react-app user guide - added flow-typed so that flow+jest will work well * Add some additional resources * Add index.css * Remove .DS_STORE per @wchargin's suggestion
2018-02-16 22:32:24 +00:00
"version": "0.1.0",
"private": true,
"dependencies": {
Add style support to the artifacts app Test Plan: Note that the header, when rendered, is magenta. wchargin-branch: stylish-artifacts
2018-03-19 22:31:08 +00:00
"aphrodite": "^2.1.0",
deps: add `better-sqlite3` (#836) Summary: I selected this over the alternatives, `sqlite` and `sqlite3`, primarily because its README explicitly acknowledges that using asynchronous APIs for CPU-bound or serialized work units are worse than useless. To me, this is a sign that the maintainer has his head on straight. The many-fold performance increase over `sqlite` and `sqlite3` is nice to have, too. For now, we use my fork of the project, which includes a critical patch to support private in-memory databases via SQLite’s standard `:memory:` filepath. When this patch is merged upstream, we can move back to mainline. Test Plan: The following session demonstrates the basic API and validates that the install has completed successfully: ```js const Database = require("better-sqlite3"); const db = new Database("/tmp/irrelevant", {memory: true}); db.prepare("CREATE TABLE pythagorean_triples (x, y, z)").run(); const insert = db.prepare("INSERT INTO pythagorean_triples VALUES (?, ?, ?)"); const get = db.prepare( "SELECT rowid, x * x + y * y AS xxyy, z * z AS zz FROM pythagorean_triples" ); function print(x) { console.log(JSON.stringify(x)); } print(insert.run(3, 4, 5)); print(get.all()); print(insert.run(5, 12, 13)); print(get.all()); db.prepare("DELETE FROM pythagorean_triples").run(); print(get.all()); ``` It prints: ```js {"changes":1,"lastInsertROWID":1} [{"rowid":1,"xxyy":25,"zz":25}] {"changes":1,"lastInsertROWID":2} [{"rowid":1,"xxyy":25,"zz":25},{"rowid":2,"xxyy":169,"zz":169}] [] ``` wchargin-branch: dep-better-sqlite3
2018-09-14 01:20:10 +00:00
"better-sqlite3": "wchargin/better-sqlite3#wchargin-private-inmemory-db",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"chalk": "1.1.3",
"commonmark": "^0.28.1",
"express": "^4.16.3",
"fs-extra": "3.0.1",
Add `createRelativeHistory` history implementation (#666) Summary: See #643 and the module docstring on `createRelativeHistory.js` for context and explanation. This patch adds `history@^3.0.0` as an explicit dependency—previously, we were depending on it only implicitly through `react-router` (which was fine then, but is not now). The dependency is chosen to match the version specified in `react-router`’s `package.json`. Test Plan: Extensive unit tests included, with full coverage; `yarn test` suffices. wchargin-branch: createRelativeHistory
2018-08-15 19:01:27 +00:00
"history": "^3.0.0",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"isomorphic-fetch": "^2.2.1",
"json-stable-stringify": "^1.0.1",
"lodash.clonedeep": "^4.5.0",
"lodash.isequal": "^4.5.0",
"lodash.sortby": "^4.7.0",
"mkdirp": "^0.5.1",
"object-assign": "4.1.1",
Store GitHub data gzipped at rest (#751) Summary: We store the relational view in `view.json.gz` instead of `view.json`, taking advantage of the isomorphic `pako` library for gzip encoding and decoding. Sample space savings (note that post bodies are included; i.e., #747 has not been applied): SAVE OLD (B) NEW (B) REPO 89.7% 25326 2617 sourcecred/example-github 82.9% 3257576 555948 sourcecred/sourcecred 85.2% 11287621 1665884 ipfs/js-ipfs 88.0% 20953425 2520358 gitcoinco/web 84.4% 38196825 5951459 ipfs/go-ipfs 84.9% 205770642 31101452 tensorflow/tensorflow <details> <summary>Script to generate space savings output</summary> ```shell savings() { printf '% 7s % 11s % 11s %s\n' 'SAVE' 'OLD (B)' 'NEW (B)' 'REPO' for repo; do file="${SOURCECRED_DIRECTORY}/data/${repo}/github/view.json.gz" if ! [ -f "${file}" ]; then printf >&2 'warn: no such file %s\n' "${file}" continue fi script="$(sed -e 's/^ *//' <<EOF repo = '${repo}' pre_size = $(<"${file}" gzip -dc | wc -c) post_size = $(<"${file}" wc -c) percentage = '%0.1f%%' % (100 * (1 - post_size / pre_size)) p = '% 7s % 11d % 11d %s' % (percentage, pre_size, post_size, repo) print(p) EOF )" python3 -c "${script}" done } ``` </details> Closes #750. Test Plan: Comparing the raw old version with the decompressed new version shows that they are identical: ``` $ <~/tmp/sourcecred/data/sourcecred/example-github/github/view.json \ > shasum -a 256 - 63853b9d3f918274aafacf5198787e18185a61b9c95faf640a1e61f5d11fa19f - $ <~/tmp/sourcecred/data/sourcecred/example-github/github/view.json.gz \ > gzip -dc | shasum -a 256 63853b9d3f918274aafacf5198787e18185a61b9c95faf640a1e61f5d11fa19f - ``` Additionally, `yarn test --full` passes, and `yarn start` still loads data and runs PageRank properly. wchargin-branch: gzip-relational-view
2018-09-01 17:42:30 +00:00
"pako": "^1.0.6",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"promise": "8.0.1",
Upgrade react and react-dom to latest (#541) Test plan: `yarn travis --full`, as well as thorough manual frontend testing
2018-07-27 20:27:19 +00:00
"react": "^16.4.1",
"react-dom": "^16.4.1",
Add a FileUploader component, with inspection test (#1149) * Add FileUploader with inspection test TODO: get it working * Add a FileUploader component, with inspection test This adds a FileUploader component, which allows the user to upload JSON files. Rather than using automated testing, it has an inspection test. The inspection test may be run by navigating to: http://localhost:8080/test/FileUploader/ This commit also adds some basic utility functions for defining inspection tests to `routeData.js`. We should improve support for inspection tests in the future; see [#1148]. [#1148]: https://github.com/sourcecred/sourcecred/issues/1148 Test plan: Ran the included inspection test.
2019-05-20 14:12:57 +00:00
"react-icons": "^3.7.0",
"react-markdown": "^4.0.8",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"react-router": "3.2.1",
Retry GitHub queries with exponential backoff (#699) Summary: This patch adds independent exponential backoff to each individual GitHub GraphQL query. We remove the fixed `GITHUB_DELAY_MS` delay before each query in favor of this solution, which requires no additional configuration (thus resolving a TODO in the process). We use the NPM module `retry` with its default settings: namely, a maximum of 10 retries with factor-2 backoff starting at 1000ms. Empirically, it seems very unlikely that we should require much more than 2 retries for a query. (See Test Plan for more details.) This is both a short-term unblocker and a good kind of thing to have in the long term. Test Plan: Note that `yarn test --full` passes, including `fetchGithubRepoTest.sh`. Consider manual testing as follows. Add `console.info` statements in `retryGithubFetch`, then load a large repository like TensorFlow, and observe the output: ```shell $ node bin/sourcecred.js load --plugin github tensorflow/tensorflow 2>&1 | ts -s '%.s' 0.252566 Fetching repo... 0.258422 Trying... 5.203014 Trying... [snip] 1244.521197 Trying... 1254.848044 Will retry (n=1)... 1260.893334 Trying... 1271.547368 Trying... 1282.094735 Will retry (n=1)... 1283.349192 Will retry (n=2)... 1289.188728 Trying... [snip] 1741.026869 Ensuring no more pages... 1742.139978 Creating view... 1752.023697 Stringifying... 1754.697116 Writing... 1754.697772 Done. ``` This took just under half an hour, with 264 queries total, of which: - 225 queries required 0 retries; - 38 queries required exactly 1 retry; - 1 query required exactly 2 retries; and - 0 queries required 3 or more retries. wchargin-branch: github-backoff
2018-08-22 18:37:29 +00:00
"retry": "^0.12.0",
Add CLI command to clear sourcecred data directory (#1111) Resolves #1067 Adds the CLI commands: `sourcecred clear --all` -- removes the $SOURCECRED_DIRECTORY `sourcecred clear --cache` -- removes the cache directory `sourcecred clear --help` -- provides usage info `sourcecred clear` -- prompts the user to be more specific Test plan: The unit tests ensure that the command is properly wired into the sourcecred CLI, including help text integration. However, just to be safe, we can start by verifying that calling `sourcecred` without arguments lists the `clear` command as a valid option, and that calling `sourcecred help clear` prints help information. (Note: it's necessary to run `yarn backend` before testing these changes) The unit tests also ensure that the command removes the proper directories, so there isn't really a need to manually test it, although the reviewer may choose to do so to be safe. Although out of scope for unit tests on this function, we can also do integration tests, to make sure that running the clear command doesn't leave the sourcecred directory in an invalid state from the perspective of the `load` command. ```js $ yarn backend; $ node bin/sourcecred.js load sourcecred/example-github; $ node bin/sourcecred.js clear --cache; $ node bin/sourcecred.js load sourcecred/example-github; $ node bin/sourcecred.js clear --all; $ node bin/sourcecred.js load sourcecred/example-github; ``` The expected behavior of the above command block is that the load command never fails or throws an error. @decentralion and I discussed the scenario where `rimraf` errors. We decided that testing this scenario wasn't necessary, because `rimraf` doesn't error if a directory doesn't exist, and rimraf's maintainer suggests [monkey-patching the fs module] to get rimraf to error in testing scenarios. Thanks @decentralion for reviewing and pair-programming this with me. [monkey-patching the fs module]: https://github.com/isaacs/rimraf/issues/31#issuecomment-29534796
2019-05-13 09:59:58 +00:00
"rimraf": "^2.6.3",
Add a FileUploader component, with inspection test (#1149) * Add FileUploader with inspection test TODO: get it working * Add a FileUploader component, with inspection test This adds a FileUploader component, which allows the user to upload JSON files. Rather than using automated testing, it has an inspection test. The inspection test may be run by navigating to: http://localhost:8080/test/FileUploader/ This commit also adds some basic utility functions for defining inspection tests to `routeData.js`. We should improve support for inspection tests in the future; see [#1148]. [#1148]: https://github.com/sourcecred/sourcecred/issues/1148 Test plan: Ran the included inspection test.
2019-05-20 14:12:57 +00:00
"svg-react-loader": "^0.4.6",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"tmp": "^0.0.33",
"whatwg-fetch": "2.0.3"
},
"devDependencies": {
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"babel-core": "6.26.0",
"babel-eslint": "7.2.3",
"babel-jest": "20.0.3",
"babel-loader": "7.1.2",
Target latest Node for backend applications (#213) Summary: Consequently, Babel won’t transform classes to their roughly equivalent ES5 counterparts, etc. Test Plan: Create `src/classy.js` with `class X {}; console.log(X);`. Then, add a build target for `classy: resolveApp("src/classy.js"),` in `paths.js`. Use `yarn backend` and inspect the contents of `bin/classy.js`; in particular, look at the definition of `X` (whatever the argument to `console.log` is). Before this commit, the result will be a big complicated mess. After this commit, it will be `class X {}`. Note also that `yarn travis --full` passes, indicating that the two manual tests, which call out to the utilities in `bin/`, still work. wchargin-branch: target-node
2018-05-05 02:22:39 +00:00
"babel-plugin-transform-es2015-for-of": "^6.23.0",
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"babel-preset-react-app": "^3.1.1",
"babel-runtime": "6.26.0",
Add a favicon (#637) Summary: In addition to the obvious benefit of having a favicon, this gets rid of a 404 Not Found error on our home page, tremendously boosting our hacker cred. Test Plan: The favicon is displayed in both `yarn start` and the static site (as a result of the build script). The added build test fails before this change. wchargin-branch: add-favicon
2018-08-10 20:15:49 +00:00
"copy-webpack-plugin": "^4.5.2",
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"css-loader": "0.28.7",
"dotenv": "4.0.0",
"dotenv-expand": "4.0.1",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"enzyme": "^3.3.0",
"enzyme-adapter-react-16": "^1.1.1",
"enzyme-to-json": "^3.3.3",
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"eslint": "4.10.0",
"eslint-config-react-app": "^2.1.0",
Prepare to enable flow-type eslint rules (#848) This commit upgrades the flow-type eslint plugin to latest, and writes new rules into the eslintrc. To keep the diff clean, the rules are disabled: I will turn them on individually (fixing errors) in followon commits. Test plan: `yarn test`. Uncommenting the lines produces many lint errors (but the linter still operates as expected).
2018-09-17 21:11:39 +00:00
"eslint-plugin-flowtype": "2.50.0",
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"eslint-plugin-import": "2.8.0",
"eslint-plugin-jsx-a11y": "5.1.1",
"eslint-plugin-react": "7.4.0",
"file-loader": "1.1.5",
deps: upgrade `flow-bin@^0.86.0` (#1002) Summary: There have been some breaking changes that require new type annotations, which is a good thing: these prevent `any`-leakage. Test Plan: Run `yarn flow`. wchargin-branch: flow-v0.86.0
2018-11-09 17:24:40 +00:00
"flow-bin": "^0.86.0",
Upgrade jest and typings (#893) Motivated by my desire for `.toMatchInlineSnapshot()`. Really we just need and updated typing file for this, but I upgraded `jest` too to just get us in a clean state. Commit generated via: ``` yarn add --dev jest flow-typed install jest@23.6.0 ``` Test plan: `yarn test`
2018-09-26 01:48:54 +00:00
"jest": "^23.6.0",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"jest-fetch-mock": "^1.6.5",
Upgrade prettier to 1.13 (#335) Release notes: https://prettier.io/blog/2018/05/27/1.13.0.html
2018-06-04 20:02:17 +00:00
"prettier": "^1.13.4",
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"raf": "3.4.0",
"react-dev-utils": "^5.0.0",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"static-site-generator-webpack-plugin": "^3.4.1",
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"url-loader": "0.6.2",
"webpack": "3.8.1",
"webpack-dev-server": "2.9.4",
"webpack-manifest-plugin": "1.3.2",
Reorganize dependencies and devDependencies (#540) This commit is a good faith effort to separate our dependencies (code that SourceCred app or CLI require to run) from devDependencies (all other deps) in our package.json. We don't have any actual dependents, so it's hard to test this distinction. Hence, it's a good faith effort. Test plan: `rm -r node_modules && yarn && yarn travis` works.
2018-07-27 19:38:40 +00:00
"webpack-node-externals": "^1.7.2"
Frontend setup (#13) * Initial infrastructure for sourcecred-explorer. Setup npm, yarn, flow, jest using scaffolding from create-react-app. - used create-react-app to get the basic pieces - added support for flow via instructions in the create-react-app user guide - added flow-typed so that flow+jest will work well * Add some additional resources * Add index.css * Remove .DS_STORE per @wchargin's suggestion
2018-02-16 22:32:24 +00:00
},
"scripts": {
Set up prettier as an autoformatter (#18) Setup prettier precommit, with yarn prettify to reformat. - Prettier runs as a precommit hook and fails if code is improperly formatted. - Run `yarn prettify` to reformat the project.
2018-02-18 09:59:28 +00:00
"prettify": "prettier --write '**/*.js'",
Setup travis CI testing (#58) Observe that it passed on this commit, but failed builds [#2: Break Tests][2], [#3: Break Flow][3], and [#4: Break Prettier][4]. Close #23 [2]: https://travis-ci.org/sourcecred/sourcecred/builds/348453195 [3]: https://travis-ci.org/sourcecred/sourcecred/builds/348454983 [4]: https://travis-ci.org/sourcecred/sourcecred/builds/348455387
2018-03-02 22:39:54 +00:00
"check-pretty": "prettier --list-different '**/*.js'",
Rename `makeWebpackConfig` to `webpack.config.web` (#770) Summary: The distinction was useful while `makeWebpackConfig` was being developed (between #562 and #570), but is now confusing: we have a web config and a backend config, and it is clearer if we name them as such. Test Plan: All of `yarn start`, `yarn build`, and `yarn test --full` work. wchargin-branch: webpack-config-web
2018-09-05 04:45:10 +00:00
"start": "NODE_ENV=development webpack-dev-server --config config/webpack.config.web.js",
"build": "NODE_ENV=production webpack --config config/webpack.config.web.js",
backend: invoke Webpack directly in package script (#782) Summary: This commit removes the `config/backend.js` script and replaces it with a direct invocation of Webpack. This enables us to use command-line arguments to Webpack, like `--output-path`. Test Plan: Note that `rm -rf bin; yarn backend` still works, and that the resulting applications work (`node bin/sourcecred.js load`). Note that `yarn test` and `yarn test --full` still work. wchargin-branch: backend-webpack-direct
2018-09-05 19:28:27 +00:00
"backend": "NODE_ENV=development webpack --config config/webpack.config.backend.js",
package.json: reorganize test commands (#571) Summary: Running `yarn test` (equiv. `npm test` or `npm run test`) now runs all checks. It takes the place of the former `yarn travis`. This is more in line with the expectation of a top-level `test` command: if it passes, your code is good. The `unit` command now runs Jest once, not in watch mode. It takes the place of the former `ci-test`. To run tests in watch mode, run any of the following: - `yarn unit --watch`, or - `npm run unit -- --watch`, or - `npm unit -- --watch`. This behavior is more consistent with the standard behavior of commands like `make test`. It is also empirically what @wchargin and @decentralion want most of the time. Test Plan: Verify that each of the scripts `test`, `unit`, and `coverage` passes. Verify that each of the aforementioned `--watch` invocations works. Verify that `.travis.yml` has the correct `script:` command. wchargin-branch: reorganize-test-command
2018-07-31 17:53:10 +00:00
"test": "node ./config/test.js",
"unit": "BABEL_ENV=test NODE_ENV=test jest --env=jsdom",
Add `sharness` for shell-based testing (#597) Summary: We will shortly want to perform testing of shell scripts; it makes the most sense to do so via the shell. We could roll our own testing framework, but it makes more sense to use an existing one. By choosing Sharness, we’re in good company: `go-ipfs` and `go-multihash` use it as well, and it’s derived from Git’s testing library. I like it a lot. For now, we need a dummy test file; our test runner will fail if there are no tests to run. As soon as we have a real test, we can remove this. This commit was generated by following the “per-project installation” instructions at https://github.com/chriscool/sharness, and by additionally including that repository’s `COPYING` file as `SHARNESS_LICENSE`, with a header prepended. I considered instead adding Sharness as a submodule, which is supported and has clear advantages (e.g., you can update the thing), but opted to avoid the complexity of submodules for now. Test Plan: Create the following tests in the `sharness` directory: ```shell $ cat sharness/good.t #!/bin/sh test_description='demo of passing tests' . ./sharness.sh test_expect_success "look at me go" true test_expect_success EXPENSIVE "this may take a while" 'sleep 2' test_done # vim: ft=sh $ cat sharness/bad.t #!/bin/sh test_description='demo of failing tests' . ./sharness.sh test_expect_success "I don't feel so good" false test_done # vim: ft=sh ``` Note that `yarn sharness` and `yarn test` fail appropriately. Note that `yarn sharness-full` fails appropriately after taking two extra seconds, and `yarn test --full` runs the latter. Each failure message should print the name of the failing test case, not just the suite name, and should indicate that the passing tests passed. Then, remove `sharness/bad.t`, and note that the above commands all pass, with the `--full` variants still taking longer. Finally, remove `sharness/good.t`, and note that the above commands all pass (and all pass quickly). wchargin-branch: add-sharness
2018-08-06 19:56:25 +00:00
"sharness": "make -sC ./sharness prove PROVE_OPTS=-f TEST_OPTS='--chain-lint'",
test: run Sharness verbosely on nightly jobs (#958) Summary: Tests that run only on nightly builds (`yarn test --full`) and fail only on CI (not locally) are a bit more inconvenient to debug when they fail. This patch makes the `yarn test --full` script print all the intermediate output in Sharness tests, which can be helpful. We don’t do this for `yarn test` simply because it generates a ton of spam even on successful tests. Test Plan: $ yarn test --full 2>&1 | wc -l 1173 wchargin-branch: test-full-verbose
2018-10-31 18:06:48 +00:00
"sharness-full": "make -sC ./sharness prove PROVE_OPTS=-vf TEST_OPTS='-v --chain-lint --long'",
Tests use yarn not npm (#1038) Currently, our underlying test script uses npm rather than yarn to execute the tests. This is awkward, because we use yarn everywhere else in lieu of npm. It turns out that some setups have node available without npm, and in such environments our tests fail with a cryptic ENOENT error. This changes the tests to use yarn instead. Test plan: `yarn test --full` passes. Thanks to @wpank for help uncovering this issue.
2019-01-07 22:38:21 +00:00
"coverage": "yarn run unit --coverage",
Setup travis CI testing (#58) Observe that it passed on this commit, but failed builds [#2: Break Tests][2], [#3: Break Flow][3], and [#4: Break Prettier][4]. Close #23 [2]: https://travis-ci.org/sourcecred/sourcecred/builds/348453195 [3]: https://travis-ci.org/sourcecred/sourcecred/builds/348454983 [4]: https://travis-ci.org/sourcecred/sourcecred/builds/348455387
2018-03-02 22:39:54 +00:00
"flow": "flow",
package.json: reorganize test commands (#571) Summary: Running `yarn test` (equiv. `npm test` or `npm run test`) now runs all checks. It takes the place of the former `yarn travis`. This is more in line with the expectation of a top-level `test` command: if it passes, your code is good. The `unit` command now runs Jest once, not in watch mode. It takes the place of the former `ci-test`. To run tests in watch mode, run any of the following: - `yarn unit --watch`, or - `npm run unit -- --watch`, or - `npm unit -- --watch`. This behavior is more consistent with the standard behavior of commands like `make test`. It is also empirically what @wchargin and @decentralion want most of the time. Test Plan: Verify that each of the scripts `test`, `unit`, and `coverage` passes. Verify that each of the aforementioned `--watch` invocations works. Verify that `.travis.yml` has the correct `script:` command. wchargin-branch: reorganize-test-command
2018-07-31 17:53:10 +00:00
"lint": "eslint src config --max-warnings 0"
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
},
license: relicense under MIT + Apache-2 (#896) Summary: All contributors to SourceCred have agreed to this more permissive licensing option: - @decentralion: [link to comment][decentralion] - @wchargin: [link to comment][wchargin] - @claireandcode: [link to comment][claireandcode] [decentralion]: https://github.com/sourcecred/sourcecred/issues/812#issuecomment-420817902 [wchargin]: https://github.com/sourcecred/sourcecred/issues/812#issuecomment-420819732 [claireandcode]: https://github.com/sourcecred/sourcecred/issues/812#issuecomment-424914639 Archive link to thread: <https://archive.fo/BH2v5> Resolves #812. Test Plan: Note that the GitHub tree explorer correctly links from the README to the individual license files. wchargin-branch: license-dual-mit-apache2
2018-09-27 02:28:41 +00:00
"license": "MIT + Apache-2",
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
"jest": {
"collectCoverageFrom": [
"src/**/*.{js,jsx,mjs}"
],
"setupFiles": [
Add jest-fetch-mock as dev dependency (#528) Also add config/jest/setupJest.js so we can configure jest-fetch-mock Test plan: I have verified that mocked fetch works as expected in a downstream commit.
2018-07-26 22:08:14 +00:00
"<rootDir>/config/polyfills.js",
"<rootDir>/config/jest/setupJest.js"
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
],
"testMatch": [
"<rootDir>/src/**/__tests__/**/*.{js,jsx,mjs}",
"<rootDir>/src/**/?(*.)(spec|test).{js,jsx,mjs}"
],
"testEnvironment": "node",
"testURL": "http://localhost",
"transform": {
"^.+\\.(js|jsx|mjs)$": "<rootDir>/node_modules/babel-jest",
"^.+\\.css$": "<rootDir>/config/jest/cssTransform.js",
"^(?!.*\\.(js|jsx|mjs|css|json)$)": "<rootDir>/config/jest/fileTransform.js"
},
"transformIgnorePatterns": [
"[/\\\\]node_modules[/\\\\].+\\.(js|jsx|mjs)$"
],
"moduleNameMapper": {
"^react-native$": "react-native-web"
},
"moduleFileExtensions": [
"web.js",
"mjs",
"js",
"json",
"web.jsx",
"jsx",
"node"
]
},
"babel": {
"presets": [
Fork `babel-preset-react-app` into config/ (#212) Summary: We want to change this configuration so that our compilation of backend applications can target latest Node. This commit forks the current configuration so that we can modify it easily. Test Plan: Both `yarn start` and `yarn travis` work. The generated backend applications work, too. wchargin-branch: fork-babel-config
2018-05-05 02:19:45 +00:00
"./config/babel"
Eject from create-react-app (#19) Summary: This commit was created by performing the following steps: - `rm -r node_modules` - `yarn install` - `yarn eject` - `rm -r node_modules` - `yarn install` on an environment wit Node v6.11.1. The final `rm -r node_modules && yarn install` ensures that the `yarn.lock` file is updated accordingly. Test Plan: `yarn test`, `yarn flow`, and `yarn start` all still do the right thing. wchargin-branch: eject
2018-02-17 21:28:47 +00:00
]
},
Upgrade oclif packages to latest (#542) This required adding a [files property] to the package.json, otherwise oclif started complaining. Test plan: I manually tested both CLI commands, and they seem fine. [files property]: https://docs.npmjs.com/files/package.json#files
2018-07-27 21:32:30 +00:00
"files": [
"/bin",
"/build"
Replace `oclif` with `cli` (#744) Summary: This commit changes the CLI to use the code in `cli` instead of `oclif`. A subsequent commit will remove the dependency on OClif altogether. Resolves #580. Test Plan: Note that `yarn backend; node bin/sourcecred.js help` works. Note that the documentation in the README is still correct. wchargin-branch: cli-replace-oclif
2018-09-02 23:11:56 +00:00
]
Frontend setup (#13) * Initial infrastructure for sourcecred-explorer. Setup npm, yarn, flow, jest using scaffolding from create-react-app. - used create-react-app to get the basic pieces - added support for flow via instructions in the create-react-app user guide - added flow-typed so that flow+jest will work well * Add some additional resources * Add index.css * Remove .DS_STORE per @wchargin's suggestion
2018-02-16 22:32:24 +00:00
}