Project style guide?

[kingcody]

I read an interesting blog post by @toddmotto; it's an opinionated angularjs style guide for teams. He has a git repo that contains his guide and will be the place for any future updates. He definitely makes some good points and I would recommend the read.

It kinda got me thinking. Seeing as generator-angular-fullstack is a generator with best practices in mind, I was wondering if we should look at adopting/formulating a project style guide. I feel that it could improve the quality and cohesiveness of the project's code base.

I wouldn't go so far as not accepting PR's that don't comply with the guide; but merely suggest that they follow. Much like the current commit message suggestion.

Just my thoughts.

I'd like to hear what others think.

[DaftMonk]

👍 Some excellent suggestions in there.

[JaKXz]

It would be cool to get some of those things into the editorConfig, for example.

[JaKXz]

Quick read reminds me of #263 which may present a problem.

[remicastaing]

Her another angular style guide that got some attention the last days: https://github.com/johnpapa/angularjs-styleguide.

[kingcody]

@JaKXz to be honest I'm not that experienced with coffeescript, but I put a small fiddle together using coffee and the new controller as syntax.

http://jsfiddle.net/gvJdn/179/

I know support for 'controller as' was spotty in earlier versions of angular. Perhaps I'll get some time this weekend to take a closer look, in particular using fullstack v2. See if #263 still seems to be present.

[kingcody]

@remicastaing awesome, nice find.

[kingcody]

Another thought I'd like to add to this is, maybe the use of grunt-jsbeautifier would be useful for testing. It could be configured like:

"jsbeautifier" : {
    "default": {
        src : ["**/*.js"]
    },
    "verify": {
        src : ["**/*.js"],
        options : {
            mode:"VERIFY_ONLY"
        }
    }
}

I'm guessing that a grunt task could be configured to run for the different variations that are tested.

Could help with PRs, commits, etc...

[kingcody]

Obviously an appropriate jsbeautifier config would be needed for verifying the generated code.

[toddmotto]

Thanks for the mention guys, good luck with the project :)

John and I collaborated on our styleguides, the reason they're independent is we have differences in some things and wanted a way to compare.

If there's anything worth integrating into the styleguide (things that may be missing/worth a mention from this generator) then do drop an issue/PR! :)

Happy coding!

[DaftMonk]

We should also look at adopting a styleguide for the node side of things to keep it consistent.

[kingcody]

I absolutely agree.

side note, @DaftMonk so in trying to learn some testing frameworks I've been looking at extending/completing some of the test for the project. Would that be a welcome addition?

[DaftMonk]

@kingcody We could definitely use some more tests.

[kingcody]

I'm working with chai as promised with mocha atm. Really simplifies the model tests since mocha accepts promises.