search

angular / angular-hint

run-time hinting for AngularJS applications
362 stars 45 forks source link

Sample AngularHint application? #36

Open ealtenho opened 9 years ago

ealtenho commented 9 years ago

@btford Besides the contrived examples in the e2e tests, we had discussed having a more realistic sample application using AngularHint to demonstrate its functionality. Would this sample application be developed in this repository? Do we have any ideas of what sort of application it should be like?

ealtenho commented 9 years ago

@caguillen214, I've created an example app that is meant to look somewhat correct although underneath it violates many best practices in order to showcase how silent errors affect applications. Please feel free to add to the errors in the application or change it as necessary. I know that many of the errors in HintDirectives correspond to custom directives, but I wasn't sure if it was overkill to create a custom directive for this simple application. What do you think? I'm also considering making a second application with identical look and feel and goal, but that does not violate the best practices.

ealtenho commented 9 years ago

In https://github.com/angular/angular-hint/commit/17ed6ae0e1d6e117cbafe1e46e16a9f80acd4056 I've added a correctExample that has the same behavior as the example but does not violate best practices. It should not produce any error messages. However, some problems in individual modules cause incorrect hints. I've filed issues on those modules: https://github.com/angular/angular-hint-dom/issues/14, https://github.com/angular/angular-hint-modules/issues/14, https://github.com/angular/angular-hint-controllers/issues/10

caguillen214 commented 9 years ago

This is great! And I think thats a good idea. I do think that making custom directives would be beneficial though because theres a lot of features related to that in HintDirectives

ealtenho commented 9 years ago

Okay, I've basically spent today fixing the issues I referenced above that I discovered in testing the SampleApplication. I will work on adding a custom directive to test and show AngularHintDirectives behavior.

ealtenho commented 9 years ago

In https://github.com/angular/angular-hint/commit/149b9b50700db29a506652fdacf531cb4b8b5e00 I updated the incorrect example app and the correctExample app to use a custom directive. Honestly, I'm not sure I'm familiar enough with directives to make a really convincing broken example. Feel free to suggest changes. I've tried to maximize the number of hints that I am generating.