Skip to content

Commit

Permalink
Clarify names of generated bundles (#21)
Browse files Browse the repository at this point in the history
* dist/run.js → dist/cli.js
* dist/bundle.js → dist/browser.js
  • Loading branch information
mathiasbynens authored and bmeurer committed Nov 6, 2017
1 parent 542f5fd commit 6f7e181
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ node_js:
- "8"
script:
- npm test
- node dist/run.js
- node dist/cli.js
sudo: false
branches:
only:
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ contributing, please read the

## Setup locally

> The Web Tooling Benchmark doesn't officially support any version of [Node](https://www.nodejs.org) prior to Node 8, it currently works with Node 6 and Node 7, but that might change at any point in time.
> The Web Tooling Benchmark doesn't officially support any version of [Node](https://www.nodejs.org/) prior to Node 8, it currently works with Node 6 and Node 7, but that might change at any point in time.
To start developing on the Web Tooling Benchmark you only need to install its dependencies:

Expand All @@ -22,8 +22,8 @@ There's no formal test suite yet. For now the process is roughly:

- [ ] Check that `npm install` passes.
- [ ] Check that `npm test` passes.
- [ ] Check that the suite runs in `node`, via `node src/cli`.
- [ ] Check that the suite runs in `d8` via `/path/to/d8 dist/run.js`.
- [ ] Check that the suite runs in `node`, via `node src/cli.js`.
- [ ] Check that the suite runs in `d8` via `/path/to/d8 dist/cli.js`.
- [ ] Check that the browser bundle works by pointing your browser to `dist/index.html`.

## Creating a new benchmark
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ To build the benchmark suite, run
$ npm install
```

assuming that you have a working [Node.js](https://nodejs.org) installation.
The command produces a bundled version that is suitable to run in JS shells
(i.e. `d8`, `jsc`, or `jsshell`) in `dist/run.js` and another bundle in
`dist/bundle.js` that is used by the browser version in `dist/index.html`.
assuming that you have a working [Node.js](https://nodejs.org) installation. Once
the command is done, it produces a bundled version that is suitable to run in
JS shells (i.e. `d8`, `jsc` or `jsshell`) in `dist/cli.js` and another bundle
in `dist/browser.js` that is used by the browser version in `dist/index.html`.

## Running

Expand Down
4 changes: 2 additions & 2 deletions webpack.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ module.exports = [
context: path.resolve("src"),
entry: "./cli.js",
output: {
filename: "run.js",
filename: "cli.js",
path: path.resolve("dist")
},
bail: true,
Expand All @@ -38,7 +38,7 @@ module.exports = [
context: path.resolve("src"),
entry: "./bootstrap.js",
output: {
filename: "bundle.js",
filename: "browser.js",
path: path.resolve("dist")
},
bail: true,
Expand Down

0 comments on commit 6f7e181

Please sign in to comment.