MooTools Forge / GitHub Plugin Structure Shell Script

By  on  

One thing I love about the MooTools Forge is that it requires a strict structure for its plugins i.e. requiring a README.md file, Source directory, etc. I've created a shell script that I can run that creates the directory structure and files required to add my plugin to GitHub and then the Forge.

The Shell Script & Usage

The first step is creating the repository at GitHub. Once created at GitHub, I run the script, giving it the name of the plugin and repository (they must be the same):

./newPlugin.sh ScrollSpy

The script itself looks like:

#!/bin/sh
mkdir $1
cd $1
git init
touch README.md
mkdir Source
touch Source/$1.js
touch Source/$1-yui-compressed.js
mkdir Docs
touch Docs/$1.md
touch package.yml
echo "name:  $1
author:  davidwalsh
current:  
category:  
tags:  []
docs:  
demo:  " >> package.yml;
cd $1
git add *
git commit -m "First Commit"
git remote add origin git@github.com:darkwing/$1.git

Tada! Done! Now I just need to populate each file with the necessary content. MooTools FTW!

Recent Features

  • By
    CSS @supports

    Feature detection via JavaScript is a client side best practice and for all the right reasons, but unfortunately that same functionality hasn't been available within CSS.  What we end up doing is repeating the same properties multiple times with each browser prefix.  Yuck.  Another thing we...

  • By
    Introducing MooTools Templated

    One major problem with creating UI components with the MooTools JavaScript framework is that there isn't a great way of allowing customization of template and ease of node creation. As of today, there are two ways of creating: new Element Madness The first way to create UI-driven...

Incredible Demos

  • By
    Image Data URIs with PHP

    If you troll page markup like me, you've no doubt seen the use of data URI's within image src attributes. Instead of providing a traditional address to the image, the image file data is base64-encoded and stuffed within the src attribute. Doing so saves...

  • By
    WebKit-Specific Style:  -webkit-appearance

    I was recently scoping out the horrid source code of the Google homepage when I noticed the "Google Search" and "I'm Feeling Lucky" buttons had a style definition I hadn't seen before:  -webkit-appearance.  The value assigned to the style was "push-button."  They are buttons so that...

Discussion

  1. That is very useful :)

  2. Hmm, Thanks!
    Since I’m on PC, I tend to use TortoiseGit instead of the Bash itself, but the structure can still be quite useful!

    Of course, for the last code line, we have to use our own username…
    git remote add origin git@github.com:USERNAME/$1.git
    No?

  3. @Nickolas Simard: Correct.

  4. Was thinking of making a textmate command to do the same, but a shell script makes more sense. Thanks!

  5. Just so you know, this works just fine with msysgit on windows. You can throw it in a .bat file and run it as shown above.

  6. PaquitoSoft

    Great tip. Thanks!

  7. PaquitoSoft

    @PaquitoSoft: There’s one thing that didn’t worked for me when using your structure for GitHub.
    You suggest to create a minified version of our source code files and put them into the Source folder but the process in MooForge that validates your GitHub repository checks that every file in that folder has a yaml header. It’s not a good idea to put that header into the minified version since this one has to be as little as possible.
    I asked Guillermo Rauch where should we put our minified files, I mean a standard name for a folder that will hold this kind of files, but I didn’t received an answer yet.

  8. Good afternoon, I have a problem with the addition of plug-in Mootools Forge, tell me please, what am I doing wrong?

    The form of adding an error:
    `provides` field missing or empty in PageMooSlider.js

    Although I write in the Header:

    provides:
    – PageMooSlider

    And in the code plug is present class:
    var PageMooSlider = new Class ({});
    http://github.com/Cleverscript/PageMooSlider/blob/master/Source/PageMooSlider.js

    Help with the addition of poalina, thank you.

Wrap your code in <pre class="{language}"></pre> tags, link to a GitHub gist, JSFiddle fiddle, or CodePen pen to embed!