We need to provide an easier workflow for non-Rails projects using install and update commands (like we do for bourbon).
Package up neat into a gem
Preliminary README edits
Ready gem for first release.
Ignore pkg and Gemfile.lock
Add instructions to the README on what to do about sass
Add a Rakefile to ease building a gem
Proposal: a bourbon plugin infrastructure for installation and updates.
From the user's perspective, they type bourbon install neat and bourbon update neat.
bourbon install neat
bourbon update neat
On the bourbon side this will require the file neat/plugin. Neat::Plugin looks like this:
class Plugin < Bourbon::Plugin
Instance of Neat::Plugin can be used to #install and #update neat. The inherited installer and updater simply copy the relevant files from app/assets/stylesheets.
Just to make sure we're on the same page, would this requires the Neat gem to be installed locally?
Yes, that part does not change. The Gemfile still needs this line:
Mike, I have plans for improving the install and update commands. Like specifying a location.
bourbon install ./stylesheets/scss/
bourbon update ./stylesheets/scss/
I don't necessarily think bourbon should require neat. If we build a plugin system, we should think about building it so that other members of the open source community can use it too. Bourbon should not have to require all the plugins we may build for it.
Neat should require bourbon, but not vice versa.
Though, I do like the simplicity of bourbon install neat & bourbon install neat ./stylesheets/scss/ (location specified)
bourbon install neat ./stylesheets/scss/
Sorry, I miscommunicated. Bourbon will not depend on Neat, but the Ruby code will translate bourbon install neat into require neat/plugin.
I definitely want hooks that the community can build atop, and I see Neat as a good testbed for that.
Gotcha. I'm fine with with the proposal then.
Is there a way to make bourbon install neat install the actual Neat gem if it's missing? That way we can skip the gem install neat altogether.
gem install neat
It can, yes, but this will interact oddly with bundle/Gemfile. If this is actually an option you want then I recommend something like bourbon install neat --remote or --system or something extra.
bourbon install neat --remote
I guess what bothers me is this exact sequence:
$ gem install neat
$ bourbon install neat
Let's optimize for the common case. So, what is the common case: will people who use bourbon install often use Bundler and Gemfiles, or will they instead type gem install neat?
Unless @plapier has some concrete data for Bourbon, my hunch tells me it's the latter. Either way, those who use Gemfile are well covered regardless of he direction we take. I'm fine with bourbon install neat for a start, just thinking of ways to make it even simpler.
Remove typography mixins and add visual grid
Add executable for non-Rails installs
Add missing instruction in the executable
I think we should temporarily provide a way to install and update Neat on non-Rails projects . I added this functionality in the present PR.
Update README with install instructions
Change stylesheets structure
Add helper functions and override documentation
Rename overrides to neat-overrides
Better override documentation
- Rename neat-overrides to neat-helpers
Rename breakpoint() to media()