My Rant on Development Practices
April 06, 2018
!Note: I wrote this actually on 01.08.2017 but never published it. So here it goes!
There are already a lot of rants about the state of (over)tooling, development style, scalability and what not. This is not news. My rant is aimed at my realm1. The University.
Dear (developer/student Let’s call you:) Johnny,
The next time you build something that others should be able to use in a project, think twice about what cool new [FRAMEWORK || BUILD TOOL || ENVIRONMENT]2 you use. It would be great to just pop up a terminal and run
npm install && npm start, open localhost:3000 and be ready to go. Instead, I have to learn:
- that cool new way to write commit messages because somebody thinks
git commit -a -m "I did something important"is too verbose or not enough3
- that fancy framework4 from, let’s say Foobook™, for running a simple one-page application with three buttons that kick of some process
- that awesome IDE because those simple text editors are for old geezers
- that new JS flavor called MilkyScript5 that is so much superior to JS
- you name it…
Oh. I need to install a ton of global tools you run for compiling es2525 and beyond because we really need
import instead of
module.exports now everywhere. Of course, you did not tell me which version you installed half a year ago and did not update on a regular basis.
After I dug through all those dependencies and got them installed I try to understand your
package.json but they are all broken or written in Latin or executing a sub shell in elvish6. Except for
dev which compiles your es2525 every time even though I did not change anything.
I almost forget to read your README entirely, because it is not enough to run
cd into/project/folder/ && npm install. Of course not. You needed to symlink your
src folder into the
app folder to access your
node_modules (instead of using something that happens on module level and is cross-platform).
Of course, you need that fully scalable multi site CMS to build the documentation of your project. No, you won’t stick around to take care of this. You were just asked to set it up. When confronted with the question: “Why not use a static site generator?” the answer is “They feel so retro, but that’s hip currently isn’t it?”. You tell me. Yeah – you need the big guns. I know.
Did I mention the hard coded absolute path to your Library to fetch that platform specific framework for accessing that MongoDB YOU HAVE RU…. 😡
You get the gist.
I get it that you need to play with those tools and where to try them out best? In projects. It’s important you learn these things. But at what cost? The project will be abandoned at some point. That’s for sure. By abandoning it in a state where only you can use it nobody will be able to build on it. That is sad because the project is pretty awesome. What bugs me about it that you took hours and hours of setting up your tool-chain. That time could have been used to work on real problems concerning your application logic or your concept. What is wrong with some VanillaJS, a tiny bit of HTML and some CSS toppings? and what is wrong with
Don’t get me wrong - those tools a great, but they were build by a large group of developers at Foobook™ for, well, building Foobook™.
You have to take some things into account before introducing a new tool.
- Can you achieve the same thing without it in the time you use to learn it?
- Will somebody else need to run it (if so write some docs)?
- Will you write these docs or just put it down as a todo?
- Is it portable to another computer without problems?
- Where lies your focus? On the tool of the project?
- Will you have to use this tool often?
- And many more things…8
I remember being the same. When I was at the same point of learning to write software, it was cool to run Processing in Eclipse, because Eclipse is the way better IDE (long pause) NOT!
A year or two later I tried to revive that project. It took me a long time to not accomplish it in Eclipse and some more time to port it back to Processing. Or another project where I started using Grunt. I have 304 lines of code in that Gruntfile.js. Now that project has been dormant for some time. Whenever I think “you could do something on it”. I stop when remembering that Gruntfile.js and that I can’t remember how to build. Yes, I could start looking at my documentation. Or not. Because writing docs are something I did not do at that time. I just coded the hell out of it because it is fun.
So did you write documentation? Oh of course not. It is the end of the semester and it had to be done quickly because fiddling with all those cool toys took so much time…
I could go on and on. This is not only for you Johnny. This mainly for myself to blow off some steam and to remind me to focus. I really would love to use
import instead of
require but not at the cost of always having to run a process that watches what I do and babels out some JS code my Node.js installation understands. The same thing goes for things like jQuery, Webpack, Rollup and so on. The things I build, like this site, actually don’t need so many libraries. 73% of jQuery are not in use for this site. I could write everything in plain old boring JS.9
At least this will be my realm until the end of August. But more about that in a later post. ↑
Insert value here. ↑
Of course still in alpha! ↑
Or maybe it is the tongue of Mordor in Elvish script? I can’t tell. ↑
Did I mention that your tiny Processing app does not work because you are so accustomed to leaving them out. ↑
I’m actually not sure if these are the right questions. Educate me if you want. ↑