MooTools Forge / GitHub Plugin Structure Shell Script
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!
![9 Mind-Blowing Canvas Demos]()
The <canvas> element has been a revelation for the visual experts among our ranks. Canvas provides the means for incredible and efficient animations with the added bonus of no Flash; these developers can flash their awesome JavaScript skills instead. Here are nine unbelievable canvas demos that...
![CSS 3D Folding Animation]()
Google Plus provides loads of inspiration for front-end developers, especially when it comes to the CSS and JavaScript wonders they create. Last year I duplicated their incredible PhotoStack effect with both MooTools and pure CSS; this time I'm going to duplicate...
![MooTools ContextMenu Plugin]()
ContextMenu is a highly customizable, compact context menu script written with CSS, XHTML, and the MooTools JavaScript framework. ContextMenu allows you to offer stylish, functional context menus on your website.
The XHTML Menu
Use a list of menu items with one link per item. The...
![MooTools CountDown Plugin]()
There are numerous websites around the internet, RapidShare for example, that make you wait an allotted amount of time before presenting you with your reward. Using MooTools, I've created a CountDown plugin that allows you to easily implement a similar system.
The MooTools JavaScript
The CountDown class...
That is very useful :)
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?
@Nickolas Simard: Correct.
Was thinking of making a textmate command to do the same, but a shell script makes more sense. Thanks!
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.
Great tip. Thanks!
@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.
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.