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
    Conquering Impostor Syndrome

    Two years ago I documented my struggles with Imposter Syndrome and the response was immense.  I received messages of support and commiseration from new web developers, veteran engineers, and even persons of all experience levels in other professions.  I've even caught myself reading the post...

  • By
    7 Essential JavaScript Functions

    I remember the early days of JavaScript where you needed a simple function for just about everything because the browser vendors implemented features differently, and not just edge features, basic features, like addEventListener and attachEvent.  Times have changed but there are still a few functions each developer should...

Incredible Demos

  • By
    MooTools 1.2 OpenLinks Plugin

    I often incorporate tools into my customers' websites that allow them to have some control over the content on their website. When doing so, I offer some tips to my clients to help them keep their website in good shape. One of the tips...

  • By
    HTML5 Placeholder Styling with CSS

    Last week I showed you how you could style selected text with CSS. I've searched for more interesting CSS style properties and found another: INPUT placeholder styling. Let me show you how to style placeholder text within INPUTelements with some unique CSS code. The CSS Firefox...

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!