List of useful generators

cloverfield-tools / cloverfield

A next generation JavaScript boilerplate scaffolding tool.

MIT License

142 stars 8 forks source link

List of useful generators #3

Open ericelliott opened 9 years ago

ericelliott commented 9 years ago

Every opinionated framework has its own ideas about where to put stuff. e.g. Meteor has client, server and lib directories.

We need the ability to quickly and easily configure where to put compiled JavaScript bundles, CSS, HTML templates, etc... See the array of folders in Substack's ironic taskrunner. Yeah... kinda like that, except that every generator should be able to read your file config and put things in the appropriate places, so you only have to write your config once to have it used by everything. You can roll your own everything as Substack suggests, but having all the meaningless choices made for you is better.

With some meaningless choices made for you, your team gets to spend less time bikeshedding, and more time building useful things.

ericelliott commented 9 years ago

List of must-have generators:

Test - Scaffolding for unit tests that can be used in any module. This one should pay attention to the tech stack that has already been selected for the repo, and suggest appropriate test frameworks. For instance, your test framework choices can be limited if you're building a Meteor app. The default should be as simple as it gets: tape with faucet.
Functional Test - Scaffolding for functional tests with Selenium web-driver integration.
Sauce Labs - Add Sauce Labs support to unit and functional tests.
Web Components - front-end widgets are quickly moving to standard web components written in vanilla JS. A scaffold for a web component module that is completely independent of any frameworks or app would be great. For reference, see the bosonic generator and the element generator for yoeman.
API Resources. See siren-resource

Nevraeka commented 9 years ago

Generator-element & generator-polymer

ericelliott commented 9 years ago

:+1:

Nevraeka commented 9 years ago

I haven't used them but there generators for x-tag & brick as well

ericelliott commented 9 years ago

Yeah, generator-element supports x-tag and brick, I think. =)

Nevraeka commented 9 years ago

Yes and those projects have their own as well

ericelliott commented 9 years ago

This iojs generator includes some good ideas.

ericelliott commented 9 years ago

First things first:

I'm working on a production module boilerplate loosely inspired by the iojs generator above. It seems like this should be top priority, since it's likely to be used daily.

lcrespom commented 8 years ago

Would be great to have optional support for TypeScript in the package boilerplate.

@ericelliott I know you are not a fan of TS but from my experience it has greatly increased my productivity (auto-complete, instant in-editor errors, etc.).

ericelliott commented 8 years ago

@lcrespom Sounds like a great idea as a composable scaffold. I haven't seen any developments on that since last September. It needs a champion. Want to be the champion? =)

lcrespom commented 8 years ago

I took a look at the composable scaffold issue/request... maybe it is too high level for me to do it on my free time and on small task bursts... actually I am not even a user (yet?) of Cloverfield.

I will investigate further and try to help...