zack37 / fluent-assert Goto Github PK

Need to:

• Cleanup all of the test it messages to all be in the should language style.
• Add .npmignore to exclude tests and coverage reporting. Update package.json to only include the few things necessary. Shorter 😃
• Update all jsdoc
• Add a CONTRIBUTING.md to document coding styles and standards
• Cleanup README.md
• Fix CI and coverage tasks to be separate and run lint on CI. Along with this, remove the need for global mocha and istanbul
• Refactor assert classes to use an assert base class.
• Beef up .editorconfig and .eslintrc
• Add more tests, specifically for ensuring return values since it's bitten me in the butt before.

More could come up as the prior issues are being completed. Will add more as they come up

For example:

someFunc(thing){
  assert.optional().array('thing.arr', thing.arr).of('object');
}

will throw an exception when it gets to .of('object') if thing.arr is undefined or null

I would assume/prefer if the tag on assertions just passed if the optional parent was omitted.

I have not tested the other assertions for this (such as assert.optional().string(...).notWhitespace()), but would assume the behavior is the same currently.

assert.array('obj.arr', null);

or

assert.array('obj.arr', undefined);

throws Cannot read property 'toString' of null

Cause: common-assert.js #arrayCheck actual: value.toString(),

assert.date()
Need to add date assertions

• Before a date
• After a date
• Within date range
• Month of
• Date of
• Year of

The message passed in assert.ok is returning undefined for the context.

assert.ok('something', object);

Reports undefined instead of something in the error message

AssertionError: expected [Function] to throw error matching /object/ but got 'AssertionError: undefined + \'should not be undefined or null'

Need to add NODE_NDEBUG flag for making sure assertions don't affect performance and can be turned off for production. Decided to use NODE_ENV instead and turn off typeof checks for NODE_ENV=production
For simplicity, the production flag is only going to wrap typeof checks and return true when in production mode to still get validation on type properties.

Ran into a use case where null is allowed but I don't want undefined.

In this use case null was going to be used as a SQL value.

var isUndefined = metadata.value === undefined ? undefined : 1;
assert.ok('value', isUndefined);

The docs say that it is .boolean and not .bool for the assertion on booleans. This is with the latest version.