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!
![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...
![Responsive Images: The Ultimate Guide]()
Chances are that any Web designers using our Ghostlab browser testing app, which allows seamless testing across all devices simultaneously, will have worked with responsive design in some shape or form. And as today's websites and devices become ever more varied, a plethora of responsive images...
![JavaScript Speech Recognition]()
Speech recognition software is becoming more and more important; it started (for me) with Siri on iOS, then Amazon's Echo, then my new Apple TV, and so on. Speech recognition is so useful for not just us tech superstars but for people who either want to work "hands...
![CSS Transforms]()
CSS has become more and more powerful over the past few years and CSS transforms are a prime example. CSS transforms allow for sophisticated, powerful transformations of HTML elements. One or more transformations can be applied to a given element and transforms can even be animated...
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.