1
0
Fork 0
easejs/TODO

65 lines
2.5 KiB
Plaintext
Raw Normal View History

2011-01-09 00:58:49 -05:00
# TODOs for ease.js
#
# This is by no means a complete list.
Misc
- Deep cloning level for util.clone()
2011-01-09 19:27:27 -05:00
- Optional preprocessing support
- Ability to disable features that wouldn't impact base functionality
- For example, one may wish to have type checking enabled for development
but may not want the performance hit for their production code.
Disabling type checking, as long as the proper types are passed to the
functions, will not impact function logic.
- Should be able to run source file without preprocessing, so C-style macros
cannot be used (# is not a valid token)
- Class module is becoming too large; refactor
2011-01-09 00:58:49 -05:00
Property Keywords
- Restrictions; throw exceptions when unknown keywords are used
- public (default)
- protected; 'this' will contain protected members of self and parents
- private; 'this' will contain private members of self, but not private
members of parents
- const; immutable properties
- final; methods cannot be overridden by subtypes
- static; method/property accessible via class definition
- event; designates a supported event
2011-01-09 19:27:27 -05:00
Typing
- Support JSDoc-style type definitions for parameters
- Syntax:
[ 'string', 'number', function( name, age ) {} ]
- Optional; if a function is simply provided, rather than an array, no type
checking will be performed
- For abstract methods, simply leave the function off (last index)
- Provide option to throw errors on any type mismatch
- Auto-cast, unless casting is impossible, then throw error
2011-01-11 22:15:30 -05:00
Reflection
- Rather than exposing internal data via properties, fully encapsulate
- Classes, not just modules like the rest of ease.js
Patterns
- Provide automated means to generate classes for common patterns (primarily
GoF)
- Generating classes at runtime gives us the powerful benefit of being able
to generate the classes however we wish. Therefore, we do not need code
generation techniques to generate classes. We can simply call a method.
This will remove repetitive tasks and duplicate code needed to properly
implement the various patterns, and serve as an excellent tool for those
unfamiliar with them.
2011-01-09 01:04:35 -05:00
Documentation
- Ensure all docblocks contain only valid JSDoc tags
- Generate documentation
- Add to Makefile
- Begin technical documentation for developers
- Include designs and project decisions
- Wiki, LaTeX, Texinfo?
- API documentation
- Wiki, LaTeX, Texinfo?
2011-01-09 01:38:53 -05:00
Client-Side
- implement assert.deepEqual()