A Failed Almost Pull Request
So, I came across a scaffold generator for Ember called (surprise!) generator-ember. This generator, as the word indicates, generates a scaffolding of an ember application for you for 2 main reasons.
1. It is daunting to setup and ember app from scratch. The convention vs configuration gets you always.
2. There are certain best practices followed when it comes to building the front end for modern web applications. These are brought to you out of the box by the generator.
This generator is written using Yeoman and its helper methods. TO make it work, you have to do the following.
1. Install the generator as per instructions.
2. Create a new folder for your new ember application.
3. cd to the new webapp and run “yo ember”
A whole ember application is created for you saving you so much of boiler plate.
But here was the awesome part. Addy Osmani, one of the founders of this tool and of course, the uber famous JS icon, had raised an issue request to find a maintainer for this project. Sounded like an opportunity. Somebody had already applied and Addy had suggested he look for potential solutions to the issues already raised and give his 2 cents on them. This sounded like a reasonable test to me. So I decided to test myself before applying.
I was right to decide what I decided because I did not know shit about Yeoman or the generator. So I dutifully forked the project, cloned it and took it home. That night I fired up sublime with my generator-ember clone and started going through the code. It was just node code and I had some confidence.
The structure seemed straight forward. For each of the generator the folder structure was
* (name of hook) [DIR]
* template [DIR]
index.js had all the code required to generate the structure described by the hook. I could see it used api from Yeoman’s base to copy the files to the new folders in a structured manner, fill in the templates using Lo-dash and put those in to the respective folders too. I looked at this file for some time and then opened the “templates” folder. The “templates” folder had the whole structure of the hook that had to be mapped to the new folder as per the index.js code. Ok, so this gave me some context. It had the Gruntfile, package.json, bower.json, gitignore and all the other files that any app worth its js salt should have.
Now I went to the yeoman generator tutorial at Yeoman-generator. The page is very well done and the instructions were very clear as to how to create your own generator. These had been applied well into the generator-ember and I could see the corresponding similarities of structure and understand the yeoman base methods better through the tutorial.
Issue to solve
I deemed myself ready to open the issues page and see if I can tackle one of them and send in a PR. So, I picked Issue-110. This was more of a gruntfile change than anything to do with yeoman. All I had to do was modify the grunt task of usemin to pick ember.prod.js while creating the concat subtask and replace the template in the app folder. I found grunt-string-replace and used it to replace instances of ember.js with ember.prod.js in a temporary index file. I then pointed useminPrepare to this temp index file and use that in the concat method it was creating. I would then later clean up this file. I tested it on the app, it worked like a charm. The addition of these replacement tasks looked a tad immature but then I anyway added it to the Gruntfile template, generated a new ember app and built it successfully with the prod version and push it to my fork.
Now I want to create a pull request. In the list of pull requests, I find PR-95 and my heart sinks. It’s been already solved. In a much better way. This person replaced the prod files for ember and ember data in the scripts array even before they were added to the html file. Good job and much cleaner. So I give up for the day and have written this.
Things I learned
- Best practices for an ember application can be found at generator-ember
- Discovered the super awesome usemin grunt plugin.
- Learnt what Yeoman and Bower do.
- Check existing PRs before you head to solve an issue.
blog comments powered by Disqus