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!
![Create a CSS Flipping Animation]()
CSS animations are a lot of fun; the beauty of them is that through many simple properties, you can create anything from an elegant fade in to a WTF-Pixar-would-be-proud effect. One CSS effect somewhere in between is the CSS flip effect, whereby there's...
![Facebook Open Graph META Tags]()
It's no secret that Facebook has become a major traffic driver for all types of websites. Nowadays even large corporations steer consumers toward their Facebook pages instead of the corporate websites directly. And of course there are Facebook "Like" and "Recommend" widgets on every website. One...
![iPhone Click Effect Using MooTools or jQuery]()
One thing I love about love about Safari on the iPhone is that Safari provides a darkened background effect when you click a link. It's the most subtle of details but just enforces than an action is taking place. So why not implement that...
![MooTools TextOverlap Plugin]()
Developers everywhere seem to be looking for different ways to make use of JavaScript libraries. Some creations are extremely practical, others aren't. This one may be more on the "aren't" side but used correctly, my TextOverlap plugin could add another interesting design element...
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.