From 211e0102e4ed27c0845b009960646198911f84b8 Mon Sep 17 00:00:00 2001 From: jauco noordzij Date: Mon, 20 Apr 2015 21:53:08 +0200 Subject: [PATCH 1/4] Updated readme to mention next release --- README.md | 25 +++++++++++++++++-------- 1 file changed, 17 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6f5c03b6..c354ed1d 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,12 @@ +**NOTE: you probably want the @next version of jester tester!** + +You can install it using `npm install jester-tester@next`. I've been working on it for a while now and it has a bunch of needed improvements such as being able to configure webpack and eslint directly. However I'm currently beta testing it and I have yet to add a migration script. Eslint is doing a lot of breaking changes at the moment while they're ramping up for their 1.0 release so I won't make the @next version the default until after the 1.0 eslint release. I also might replace karma with testem before that. + +But me and my team are using the @next version full time, so it probably won't delete your entire file system. I encourage new jester users to start with the @next version. Just be aware that you might have a non-automatic upgrades (usually changing some settings, renaming some properties) for new releases. + +If you encounter anything: let me know at https://github.com/jauco/jester/issues ! + + #Jester >Get your project tested and out there with minimal fuss. @@ -15,7 +24,7 @@ The goal of Jester is to give you a bootstrap for integrating these tools so you 1. Install [node.js](http://nodejs.org/download/) 2. Create a directory for your app `mkdir myApp; cd myApp` 3. Add a basic machine readable description of your app `npm init` - 4. Install jester from npm and save it into the development dependencies. Under windows you'll have to run this as administrator (required by jsdoc for creating symlinks): + 4. Install jester from npm and save it into the development dependencies. Under windows you'll have to run this as administrator (required by jsdoc for creating symlinks): `npm install --save-dev jester-tester` ## Creating a project @@ -127,7 +136,7 @@ describe("Greetings", function() { ``` This test asserts that the function hello will return the string `hello tested world`. -The test will run upon saving it if jester-watch is running, or else when you +The test will run upon saving it if jester-watch is running, or else when you execute jester-batch. Jester will now run your tests in the browsers as specified in `jester.js`. Of @@ -144,7 +153,7 @@ module.exports = hello; ##Dependency injection Jester makes it easy to replace a 'require'd module in the source file with a -test-stub. +test-stub. Let's say we have a file called src/lib/db.js ```javascript @@ -196,7 +205,7 @@ what happens under the hood. It's not really magical. ## Generating documentation from source -Documentation will be generated from appropriately annotated sources by jsdoc and includes the syntax highlighted source code. See [usejsdoc](http://usejsdoc.org/) for how to annotate your code, especially relevant is [Document CommonJS Modules](http://usejsdoc.org/howto-commonjs-modules.html). +Documentation will be generated from appropriately annotated sources by jsdoc and includes the syntax highlighted source code. See [usejsdoc](http://usejsdoc.org/) for how to annotate your code, especially relevant is [Document CommonJS Modules](http://usejsdoc.org/howto-commonjs-modules.html). There are many ways to export and document code. The recommended way to export functions is: @@ -204,7 +213,7 @@ There are many ways to export and document code. The recommended way to export f * Deep clone an object * * @param {Object} obj - the object to clone - * @returns {Object} a deep clone of the original object + * @returns {Object} a deep clone of the original object * @see {@link http://stackoverflow.com/questions/728360/most-elegant-way-to-clone-a-javascript-object} */ function clone(obj) { @@ -215,8 +224,8 @@ There are many ways to export and document code. The recommended way to export f This enables jsdoc to recognize that clone is a (static) function, the clone symbol will show up in stack traces and is fully supported by IE8. -The api documentation will be written to a directory specified by the `apiDocPath` setting in `jester.json`, which defaults to `./doc/api/`. You can set the configuration option `readme` to point to a file that is a markdown formatted readme which will be included in the generated documentation on the homepage. +The api documentation will be written to a directory specified by the `apiDocPath` setting in `jester.json`, which defaults to `./doc/api/`. You can set the configuration option `readme` to point to a file that is a markdown formatted readme which will be included in the generated documentation on the homepage. -The api documentation will be generated when you run `jester-batch` or `jester-doc`. The latter is a bit faster because it *only* runs jsdoc. The documentation is *not* automatically updated when running `jester-watch`. +The api documentation will be generated when you run `jester-batch` or `jester-doc`. The latter is a bit faster because it *only* runs jsdoc. The documentation is *not* automatically updated when running `jester-watch`. -An additional benefit of annotating your code with jsdoc style comments is that there are a number of tools such as ide's and compilers which can take advantages of the additional information contained in those comments. \ No newline at end of file +An additional benefit of annotating your code with jsdoc style comments is that there are a number of tools such as ide's and compilers which can take advantages of the additional information contained in those comments. From f4ba91ffd82fae08eb15ea738ae94be990a00cbd Mon Sep 17 00:00:00 2001 From: jauco noordzij Date: Mon, 20 Apr 2015 21:55:32 +0200 Subject: [PATCH 2/4] Update i dependency because the author accidentally removed the 0.3.2 version from npm --- npm-shrinkwrap.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/npm-shrinkwrap.json b/npm-shrinkwrap.json index 37e9c03c..ad138445 100644 --- a/npm-shrinkwrap.json +++ b/npm-shrinkwrap.json @@ -353,8 +353,8 @@ "from": "deep-equal@0.2.1" }, "i": { - "version": "0.3.2", - "from": "i@0.3.2" + "version": "0.3.3", + "from": "i@0.3.3" }, "ncp": { "version": "0.4.2", diff --git a/package.json b/package.json index edc478d3..845a7869 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "jester-tester", "description": "Get your project tested and out there with minimal fuss.", "repository": "https://github.com/jauco/jester", - "version": "2.0.0", + "version": "2.0.1", "author": "Jauco Noordzij ", "bin": { "jester-watch": "./src/bin/jester-watch.js", From 30c7331267bb26ba1fab7e873ad60cd1b12c5980 Mon Sep 17 00:00:00 2001 From: Oscar de Groot Date: Wed, 13 May 2015 11:15:41 +0200 Subject: [PATCH 3/4] The debug instructions didn't work (anymore). Changed them to something that works. --- HACKING.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/HACKING.md b/HACKING.md index 5b0c53af..d75c2681 100644 --- a/HACKING.md +++ b/HACKING.md @@ -1,25 +1,17 @@ # How to debug Jester -You attach a graphical debugger ([node-inspector]) to jester. +You attach a graphical debugger ([Node Inspector]) to jester. -- Install [node-inspector] somewhere. Doesn't matter where. +- Install [Node Inspector] somewhere. Doesn't matter where. $ npm install node-inspector -- Start node-inspector. - - $ node_modules/.bin/node-inspector - Node Inspector v0.7.4 - Visit http://127.0.0.1:8080/debug?port=5858 to start debugging. - - *node-inspector* now waits for the process-to-debug on port 5858, and for you on port 8080. - - Start jester in debug mode. - $ node --debug-brk node_modules/jester-tester/src/bin/jester-watch.js + $ node-debug node_modules/jester-tester/src/bin/jester-watch.js debugger listening on port 5858 -- Browse to http://127.0.0.1:8080/debug?port=5858. +- Node Inspector opens http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in a browser. - Place your breakpoints and press the play button to start running jester. -[node-inspector]: https://npmjs.org/package/node-inspector +[Node Inspector]: https://npmjs.org/package/node-inspector From 8c925f76a3d405379418d65a4f2ed4c932e2f6c0 Mon Sep 17 00:00:00 2001 From: Oscar de Groot Date: Wed, 13 May 2015 13:17:19 +0200 Subject: [PATCH 4/4] Removing 'string' suffix on each error line. This was introduced by commit 93f78302b06c4a8eb0a3e94cf183eddc137a714b and that was presumably unintentional. --- src/lib/handleWebpackResult.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/lib/handleWebpackResult.js b/src/lib/handleWebpackResult.js index 3f2de0a8..dd10488d 100644 --- a/src/lib/handleWebpackResult.js +++ b/src/lib/handleWebpackResult.js @@ -17,7 +17,7 @@ module.exports = function handleWebpackResult(stats, webpackWarningFilters) { var logErrorsByLine = function (errors) { byLine(errors, function (err) { - console.log(" ", err, typeof err); + console.log(" ", err); }); };