Updated README.md and added mocha to run the existing test. #1
Conversation
| @@ -22,19 +22,19 @@ As soon as you keep a reference to an object, array, arrow function, ... you do | |||
|
|
|||
| ```js | |||
| import myLib from 'my-lib' | |||
| import { iterate } from 'leakage' | |||
| import { iteration } from 'leakage' | |||
There was a problem hiding this comment.
Thanks for fixing this! It took me a moment to figure out why my import wasn't working before I discovered the name was different.
| @@ -4,7 +4,7 @@ | |||
| "description": "Memory leak testing for node. Write tests using your favorite test runner.", | |||
| "main": "lib/index.js", | |||
| "scripts": { | |||
| "test": "standard lib/**/*.js" | |||
| "test": "node_modules/.bin/standard lib/**/*.js && node_modules/.bin/mocha test" | |||
There was a problem hiding this comment.
npm adds node_modules/.bin to PATH, so you can use standard and mocha without the manual path prefix
There was a problem hiding this comment.
Ah, I didn't know they added this. Thank you.
There was a problem hiding this comment.
👍 Sure thing! Here's that section in the docs, in case you're interested in reading more: https://docs.npmjs.com/misc/scripts#path
…nds in package.json
|
Ahhh, I'm sorry for the misleading docs, guys! Thanks for fixing, @kroogs! |
There was a problem hiding this comment.
Just one thing: Now you run mocha on npm test (see) package.json. But the test in test/ is supposed to fail, so npm test will always fail.
Let's skip the package.json modification for now. I will open a new PR introducing at least a little bit of unit/integration testing.
|
|
|
@btmills Yeah, feeling the same. I will just edit the PR. |
|
Or maybe not... Guess it's easier to start a new one, since editing so much isn't easy using the GitHub web UI. |
|
Opened a new PR. Still thankful that you opened this one, @kroogs :) |
When I imported 'iterate' from the package, the value was undefined. I realized that the README.md was misleading, so this PR adjusts it to reflect what the package exports ('iteration').
I'm having another issue with the library, which might end up in another PR, so I wanted to run the test suite to see what happens and realized that it didn't come with mocha and needed an improved test command (both using mocha and not relying on any local PATH modifications).