Commit 26eee8da authored by Stefan Cameron's avatar Stefan Cameron

Move enhancements in the code to repo issues

parent ae417402
......@@ -31,14 +31,8 @@ Shapes must be:
[MIT](LICENSE)
# TODO
- [ ] Unit tests must be run both in the browser and in Node.js -- in the browser via Gitlab CI
- [ ] Add Gitlab CI config, or use TravisCI?
- [ ] Publish to npm
- [ ] Make sure 'Goals' section is complete and accurate, add some links
- [ ] Make sure `CONTRIBUTING.md` is filled-out
# Future
* Support a formal plugin architecture allowing third-parties to register custom types?
See the list of proposed [enhancements](https://gitlab.com/stefcameron/rtvjs/issues?label_name%5B%5D=enhancement). Up-vote the ones you like to help contributors prioritize them!
Feel free to log an __enhancement__ if you have an idea! You may also file a PR, although it might be best to discuss your idea with the community first by logging an enhancement issue.
......@@ -95,9 +95,6 @@ import Enumeration from './Enumeration';
* @see {@link rtvref.validation.isTypeArgs}
*/
// TODO[future]: Add 'exp: string' and 'expFlags: string' args (strings because
// of JSON requirement...) for a regular expression test. Similar prop names
// to collection_args.
/**
* <h3>String Arguments</h3>
* @typedef {Object} rtvref.types.STRING_args
......@@ -163,12 +160,6 @@ import Enumeration from './Enumeration';
* @see {@link rtvref.qualifiers}
*/
// TODO[future]: Consider adding a `strict` or `restrict` flag in the args to
// fail validation if any own-properties are found which are NOT in the shape
// if enough users ask for it. Not adding this immediately because that's not
// the true spirit of a shape, which is an interface. The consumer of the object
// matched to a shape shouldn't care what _other_ properties are on the object,
// just that the properties described in the shape are as expected.
/**
* <h3>Shape Object Arguments</h3>
*
......@@ -200,9 +191,6 @@ import Enumeration from './Enumeration';
* @see {@link rtvref.types.CLASS_OBJECT}
*/
// TODO[future]: Short-hand 'exact' with `[ARRAY, 2, [STRING]]` or `[2, [STRING]]` syntax?
// IIF this becomes such a common thing to expect an exact length; otherwise, don't
// optimize for an infrequent case.
/**
* <h3>Array Arguments</h3>
* @typedef {Object} rtvref.types.ARRAY_args
......@@ -761,8 +749,6 @@ const defs = {
*/
REGEXP: def('REGEXP'),
// TODO[future] Consider DATE args for ranges, date values to be ISO8601 UTC strings so they are
// easily serializable.
/**
* Date rules per qualifiers: Must be a `Date` instance.
* @name rtvref.types.DATE
......
......@@ -36,12 +36,6 @@ import * as valSymbol from './lib/validator/valSymbol';
import * as valWeakMap from './lib/validator/valWeakMap';
import * as valWeakSet from './lib/validator/valWeakSet';
// TODO[future]: Consider making 'rtv' a function object rather than a plain object.
// Invoking it as a function would call rtv.verify(), so rtv.verify(...) could be
// shortened to rtv(...), and `rtv.e && rtv.verify(...)` would be shortened to just
// `rtv.e && rtv(...)`. This could easily be done in the future, but is not easily
// undone, so best to see how people use it first, and if `rtv.verify()` really
// is too much typing or not.
/**
* <h3>RTV.js Public Interface</h3>
*
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment