search

mozilla / scanjs

[DEPRECATED] Static analysis tool for javascript code.
Other
428 stars 39 forks source link

[ux] rule editing in interface #91

Closed pwnetrationguru closed 10 years ago

pwnetrationguru commented 10 years ago

@mozfreddyb and @pauljt

Should we really allow editing of rules in interface? It seems a little inconsistent since changing the rules in the interface doesn't actually change /common/rules.

Also, I see defining/editing rules as an "expert" usecase and as such I am fine with a user having to manually edit /common/rules.

I think we should abandon rule editing in the client interface. What do both of you think?

mozfreddyb commented 10 years ago

I tentatively agree about rule editing being an expert case. But if you make changes, they are saved in localStorage and retrieved instead of common/rules.js on future loads. See https://github.com/mozilla/scanjs/blob/master/client/js/rules.js

pauljt commented 10 years ago

My original intention was to allow for loading and saving rulesets. This is important as you need to use different rulesets for different tasks - e.g. you might have a really strict ruleset for using the tool as a code review aid (which was its original intention) but you want a more relaxed (less false positive) ruleset. But I agree we probably don’t need UI for this, and the current UI is a little unhelpful (it loads/saves rule changes to local storage).

It would be helpful however to have some kind of “rule workshop” tool, i.e. write a rule, and see how it applies to a given string though. Maybe this could generate a rules file which you could save to a specific location, and then loaded later when you want to run the rules again.

On 20 Mar 2014, at 5:54 am, Rob Fletcher notifications@github.com wrote:

@mozfreddyb and @pauljt

Should we really allow editing of rules in interface? It seems a little inconsistent since changing the rules in the interface doesn't actually change /common/rules.

Also, I see defining/editing rules as an "expert" usecase and as such I am fine with a user having to manually edit /common/rules.

I think we should abandon rule editing in the client interface. What do both of you think?

— Reply to this email directly or view it on GitHub.

pwnetrationguru commented 10 years ago

I'm working on the UX uplift now. I'm thinking of leaving out rule editing until the next version. The user would still be able to list and view rules in interface, just not edit.

I think we have some work to do on our rule architecture, so it makes sense to me to wait until we iron that out. Thoughts, @pauljt and @mozfreddyb?

mozfreddyb commented 10 years ago

fine by me

pwnetrationguru commented 10 years ago

Rule editing is not included in 1.0