mpatkisson / kersey-old Goto Github PK

I'm not really happy with how the API looks right now. Things to consider for changing include:

• Importation plugin 'create' functions (is there a more standard way)
• Importation plugin 'start' functions (is there a better name)
• User supplied 'parse' function. The name needs to be changed to something like transform. The options function is confusing and the callback method also seems a little confusing.

The readme should include the following:

• Project goal(s)
• Simple use cases
• Options and defaults
• Events
• Plugin creation

Currently subscribing to events is done through the options. Events should be a bit more like:

inserter.on('inserted', fucntion (count) {
 // react
});

Many of the tests have similar or the same options. Bundle these together in a configuration file.

I've decided (I think) that using an HTML documentation generator is not necessary. However, I do want to provide consistent commenting for all functions.

Investingate unit / integration testing in node and refactor tests appropriately.

The test data being used write now is from EAN and should probably be something else to avoid an IP / licensing issues.

Use Vagrant plus shell or Ansbile or some other CM tool to automatically create and provision the development environment. Determine the best box to use (precise 32, etc) and commit the VagrantFile and provisioning software.

Leverage either github milestones, wikis or both to say where the project is headed.