GitLab

While updating the README,

- found a few minor issues which I fixed

- updated the API docs

- added more integration tests (to verify README examples)

- added support for regexp testing to STRING_args, fixing issue
  #2

- custom validators can now return truthy values (or nothing) to
  pass verification, or either throw errors or return falsy values
  to fail verification

- renamed 'FlagSpec' to 'Flags' in various argument properties
  since that seemed more intuitive, and it's closer to
  `RegExp`'s `flags` argument, which is what it relates to

Unfortunately, there appears to be a bug with the job engine
whereby it doesn't wait for the Rollup build to finish before
it thinks it's actually done, and therefore doesn't save all
the build output files as artifacts because they just aren't
there yet when it saves the ./dist dir's contents.

I'll have to look into this later. The most important thing
for now is that the test stage works.

There were some linguering bugs with these types from the recent change
to require object type args with the '$' for the shape, as well as
array with args.ts with the typeset still around that existing tests
were skirting around. Added more tests to make tests more robust!

These were found thanks to a new 'integration.test.js' test suite
I added. It's already proving its usefulness!

This commit also removes the value from RtvError's message property
in case it happens to contain sensitive information. Please see the
note on the `RtvError#path` property.

*   Fix INT -> SAFE_INT

*   Remove completed TODOs

*   Clarify example titles

*   Fix missing rtvref.validation and rtvref.validator docs

    Also rename `validation/isValidator -> validation/isCustomValidator`
    to avoid confusion between custom validators in typesets, and
    type validators in the library.

*   Clarify rtv.t and rtv.q enumerations

*   Clean-up the rtv interface

Commit it, but don't publish it, since it'll be ignored anyway:
https://docs.npmjs.com/files/package-lock.json

"One key detail about package-lock.json is that it cannot be
published, and it will be ignored if found in any place other
than the toplevel package."

With this change, all object types (ANY_OBJECT, OBJECT, PLAIN_OBJECT,
CLASS_OBJECT) now expect type args with a special '$' property that
specifies the shape, rather than all but CLASS_OBJECT assuming that
the type args are the shape itself. The only exception is when
providing a shape as the typeset itself, as the first element in
an Array typeset, or as the second element if a qualifier is used:

```javascript
// shape as typeset:
{...}

// first element in Array typeset:
[{...}]

// second element with a qualifier:
[OPTIONAL, {...}]
```

In the three cases above, the DEFAULT_OBJECT_TYPE is implied.
Otherwise, the shape must be specified in the type args:

```javascript
[PLAIN_OBJECT, {$: {...}}]
[OBJECT, {$: {...}}]
```

This change makes the type system, and the library, more extensible
going forward.

Coverage: 100%

This error, hopefully including a helpful message, is then captured
in the resulting RtvError's `failure` property, as well as part of
its `message`.

Coverage: 100%

FLOAT type was missing its validation and validator!

STRING, NUMBER, FINITE, INT, SAFE_INT, and FLOAT now support, in
their arguments, a 'oneOf' property (replacing 'exact') which can
either be a single value or a list of values. If a list, then the
value being checked must find an exact match (`===`) in the list.
Empty lists are ignored.

Coverage: 100%

And rename CLASS_OBJECT_args.ctr -> ctor since I think that's
probably a more common abbreviation for 'constructor'.

Keeps package.json a little cleaner.