dbashford/skelmimosa

Mimosa's skeleton module, so Mimosa projects don't have to start from scratch

skelmimosa

Mimosa needs skeletons! If you are using a cool suite of technologies and have a setup that you usually copy/paste around to get you started, then Mimosa needs you! Spend a little time and share your setup with other Mimosa users. See the Contribute section below.

Overview

This module adds commands for dealing with Mimosa skeletons. This module also contains the Mimosa skeleton registry file.

Skeletons are small starter Mimosa projects that include libraries (like, for instance, BootStrap or Backbone) and boilerplate code to jumpstart application development.

Mimosa skeletons are hosted on GitHub, so this module has a dependency on git being installed and being available at the command line from the location the skeleton commands are executed.

For more information regarding Mimosa in general, see http://mimosa.io.

Functionality

This module adds 3 new commands to Mimosa:

mimosa skel:new

This command creates a new skeleton from the registry. The command takes two arguments.

• skeleton reference: either the name of the skeleton from the registry, the url of a github repo or a local system path.
• folder to create: this parameter is optional. If it is not provided, the skeleton will be dropped in the current directory. If it is provided, the skeleton will be dropped in the named folder. The named folder will be created if it does not exist.

mimosa skel:list

This command lists all skeletons from the registry including the name, a description, the URL and some keywords for the skeleton.

mimosa skel:search

This command takes a keyword as input, like backbone, and writes out all the skeletons that have that keyword. Someday I hope Mimosa has enough skeletons that this command becomes a necessity to wade through them all. For now it is a nice to have.

Contribute

To contribute a skeleton, just submit a pull request or open an issue to get your skeleton added to the registry. I will curate the list but only barely. I don't care if you use Backbone or Ember or Angular or Batman, and I don't care how you organize your projects. All I might do is suggest tweaks to increase hotness.

Your skeleton can be as in depth as you'd care to make it. You can provide a nodejs server stack if you wish. Example code is welcome, boilerplate code is definitely encouraged. But don't submit an entire enterprise app. It shouldn't take someone using a skeleton an hour to slice out all the demo code before getting started with their own stuff.

skelmimosa's Issues

legal ...?

I have a project which would make a great skeleton -- its the Ordr app from the peepcode ember screencast converted to coffeescript/stylus/ember-model, newest ember release. I also ported over the test suite from the peepcode-ordr-test demonstration app https://github.com/Ember-SC/peepcode-ordr-test. The test suite is an integration test-suite using testem, qunit and pavlov -- I gather its a recommended pattern for testing ember apps ...

The project is built with mimosa and shows the ['lint', 'just-copy', 'bower', 'server', 'minify', 'live-reload'] modules. I was thinking to add bower config and make sure that it works with all the newest releases of the various dependencies. Would this be a useful skeleton idea? I think I'd need to ask the peepcode folks for permission but there are other Ordr app derived projects floating around on github but I'd be willing to try and get it online ...

Target Directory

1. If I execute mimosa skel:new durandal then the repo is clones into the current folder...but it is actually placed inside a subfolder with the repo's name.
2. If I execute mimosa skel:new durandal somefolder then it puts it into that folder.

I can see how #2 would be desirable, especially when you don't have a repo in existence. In my case, I had an existing git repo I wanted to inject the skeleton code into, without an additional directory level (like #1) Is there a good way to do this?

Typo (missing bug)

16ef8d6#commitcomment-9988132

"A known Windows/Mimosa bug ..." 👍

Unpublish mimosa-skeleton from npm

Since you reuploaded mimosa-skeleton as skelmimosa, isn't it better to delete the old one? It doesn't have dependents (so far) and it's not maintained anymore.

https://npmjs.org/doc/cli/npm-unpublish.html
https://npmjs.org/package/mimosa-skeleton

Unexpected Artifacts

After the skeleton was created, there were a few artifacts in the directory that I didn't expect:

1. readme.md from the skeleton
2. npmignore file
3. .git directory

I could easily remove the first two from my skeleton repo, but what about number 3?

Marionette Skeleton

Hey there, I've decided to update my Marionette-Skeleton a little so you can get an idea of what it will look like.

Basically, Marionette is a collection of best practices how to use Backbone and has a lot of great additions to it!

The skeleton can be found here:
https://github.com/Anachron/mimosa-marionette

It's based on 2.0 canary but I am sure it will work with 2.0 RC just as well. (Had no time to test yet)

Will implement the simple Todo-App soon, for now it's about loading Marionette in RequireJS, putting the required pieces together to only load apps when needed and to make sure it's easy to have several apps per project (seperation of interest).

Would love to get some feedback, and once it's (imo) ready to be used as 2.0 Skeleton, I will submit a PR to skelmimosa.

Enjoy!

basic node.js npm project skeleton?

Is there a good basic skeleton for a standard npm module targeting node and building with mimosa (supporting coffeescript et al)?

As someone new to node -- would be helpful to bootstrap myself with a more knowledgable person's sensible default layout for an npm module+tests and the like ...

Node Error?

I tried to use the skel command to create a project based on my own skeleton...coming from the official repo. It worked but...I got an error:

C:\Users\Rob\Documents\GitHub\Durandal-Web-Site [master]> mimosa skel:new durandal site
14:28:47 - Retrieving registry...
14:28:48 - Found skeleton in registry
14:28:48 - Cloning GitHub repo [[ git://github.com/BlueSpire/Durandal-Mimosa-Skeleton.git ]]
14:28:50 - Error: ENOTDIR, readdir 'C:\Users\Rob\Documents\GitHub\Durandal-Web-Site\site.git\objects\pack\pack-77db4606
0d2816fabaf51cb8813201c927c61667.idx'

Not sure what that's about...

An angularjs+karma skeleton

Hello, I have put together a skeleton project for mimosa which I usually set up for myself.

It builds on the default skeleton project by adding

• Bootstrap
• Angularjs
• Karma

into the mix.

repository is here:

https://github.com/idursun/mimosa-angular-karma-bootstrap-skeleton

git is not recognized from windows command prompt

When I try to do mimosa skel:new durandal I get this error:

17:52:22 - Retrieving registry...
17:52:23 - Found skeleton in registry
17:52:23 - Cloning GitHub repo [[ git://github.com/BlueSpire/Durandal-Mimosa-Skeleton.git ]] to temp holding directory.
17:52:23 - Error cloning git repo: 'git' is not recognized as an internal or external command, operable program or batch file.

I was able to fix it by adding the path to git in my environment variables.

Not really an issue anymore, but I thought I would share this in case anyone else runs into this problem.

Automatically run npm install inside the project directory

After pulling in the skeleton, run npm install inside that directory. First, it saves the user the trouble of doing that themselves. Second, it gives the skeletons a chance to run any scripts that can be attached to npm postpublish.

Unable to fully remove .git folder on Windows

See conversation in #4. The original issue brought up by #4 is solved.

Being unable to remove the .git folder on Windows also encompasses #2 and #3.

I've recently had a chance to play around with other stuff, like TypeScript support, on a Windows machine, so hopefully I can reproduce this and get it fixed in the coming week.

Create and maintain 2.x skeleton registry

I think it's a good time now to add more power to the skeleton registry and add new skeletons that are up-to-date.

You could implement cli-pagination (simply with f=first, p=previous, n=next and l=last) for searching/listing.

Also check the cli-table issue I opened earlier last year.

What are your thoughts about this?

sample simple ember app

Hi -- I made a simple ember app using mimosa in coffeescript and emblem. There is a testem testsuite as well.

Its a port of the peepcode ember tutorial into a standard mimosa project. It might make a good skeleton ...?

https://github.com/breathe/mimosa-peepcode

Feature Idea: Automatic file removal for GIT

Since Git doesn't provide a way how to keep track of folders (it's not planned either, no matter how many requests come) I would like to give a little brainstorming about my idea:

It would be great to have a way to tell Mimosa (from a Skeleton) to run through all folders and delete blank files that users create for actually submitting empty folders to git projects.

Maybe the best place for this is mimosa-config. What's your opinion?