Standardization Across Examples

[tastejs]

Standardization Across Examples

[addyosmani]

All valid points. One of the largest problems we've had is that there's never been a set of specifications written defining exactly what is expected of a 'Todo' application. This has led to some of the applications being written with basic list/add/remove/edit capabilities, but there's little else provided in terms of guidance other than saying 'study one of the other apps and base it off of that'. The obvious problem there is certain visual specs (mark all checkbox etc.) have been omitted in some implementations whilst not in others.

I agree about us dropping ember's SCSS. Another problem I ran into was trying to decide whether to continue opting for what the official solution was advocating for use (eg. Ember's original todo app that I refactored used SCSS so I assumed developers using it would wish to go for it too), however in hindsight, everything should just be using simple stylesheets instead.

What I see as us needing to do to clean the examples up is:

• Define what is expected of a typical application
• Identify the apps missing any aspects of these specs
• Working on patching the above

Another intention I had had (but never had time for) was creating a basic boilerplate (index/CSS) for a Todo app that could be handed to a framework author or someone working with the framework if they wished to create a 'TodoMVC' compatible example for submission. This is another area where those submitting pull requests for their own frameworks have run into trouble and whilst it may not be directly solved by our cleanup, it's worth keeping in mind.

[boushley]

I'm fine with helping to write a specification for what a Todo app should do, but an issue is probably not the right location for that. We could add this to a wiki, but it appears that wikis are turned off for this repo.

Once we have that defined somewhere it would be fairly trivial to identify which apps are missing pieces or have extra pieces (I would assume that we could have a requirement that is something like don't use a special css language, or avoid a minimizer/compiler if possible). These would probably be best filed as issues that people could then claim ownership over and submit pull-requests for.

Creating a boilerplate css I think is a really good idea. The boilerplate index I'm not as sure about. Most of the frameworks have a pretty different index page between them, although a starting point probably wouldn't hurt. I would assume that these would belong somewhere in the repo as checked in code.

[addyosmani]

For reference, adding the work that's been started on a wiki entry for the specs: https://github.com/addyosmani/todomvc/wiki/Todo-Application-Specification

I think we should probably leave this issue open until we're happy that its complete.

[addyosmani]

Just to make sure this issue tracks progress: as part of the standardization process we've landed a boilerplate template for todo apps. This can be found in todo-example\template. We plan on moving all applications over to use this template for version 1.0.

[addyosmani]

I tend to prefer jshint over jslint, but just for reference it would appear someone has put together a version of the Backbone Todo app that passes jslint here: jashkenas/backbone#778. Not sure if we want to aim for jshint support in this project, but just throwing this out there. We probably have enough work to transition apps over to standardization as it is at the moment.

[boushley]

We've definitely got our hands full doing the conversion at this point. Passing jshint/lint would certainly be nice, but I think is a lower priority at this point. However if someone does the work I would probably land the pull request.

[rniemeyer]

I am working on updates to the KnockoutJS example to match the template. Is the "Press Enter to save this task" tooltip not something that we should be including with the new template?

[addyosmani]

I believe we've decided to no longer include the tooltip.

[sindresorhus]

Tooltip discussion

@boushley Can you remove the list item "Need to add tooltip to creation text box." from your framework update issues?

[sindresorhus]

This has been fixed with the App Spec and the new template.