Skip to main content

The Pragmatic Bookshelf | PragPub May 2012 | What Makes an Awesome Command-line Application?

Media_httpapragprogco_hmejd

I thought this was a great article. It hit a chord with me as I have had to tackle some foolish command line apps recently where the devs have just dreamt up new commands and ways of working for themselves instead of just using the normal heuristics. Very annoying.

Something that I have just found and annoys me is setting up command line programs for schedules tasks. If you don't do this right, you end up with a complete mess! Like a list of emailers for different programs and clients:

- Emailer_01
- Emailer
- Emailer_New
- emailer_March2012

This is just annoying. I know you can still tell what the programs are if you look into them or work it out from the other columns but it's still a pain.

- The arguments the scheduled tasks take should be documented.
- The scheduled task itself should log to the event log.
- The error messages logged to the event log should be sensible (for example - give a list of the possible params if an incorrect one was given, if there are too many, wtf?).
- When you create a scheduled task, name the task nicely with something like - "company.program.program instanceName" so it's apparent what the scheduled task is for, this type of naming should apply to the source of the event log as well so they're easily filtered when trying to find information out about the program.

Comments

Popular posts from this blog

My home office upgrade wish list.

My home office is almost due an upgrade. I have been holding off until my youngest daughter is out of her cot as then we can finally dispatch the enormous monstrosity of a cot out from the kids bedroom and the drawers that are in my office can be banished giving me better access to my wonderful whiteboard. My other improvements will be purchasing a new, larger monitor. I currently work from a single 22ich Samsung which just doesn't cut it anymore, I did have two at some point but I can't recall what I did with it. I really enjoy using a touch screen so I think I will go for one of these 27inch Hannspree models that I have used before. I put a lot of hours in at home and whilst I have a reasonable chair I still tend to suffer with some back problems, so my next port of call will be to get a Varidesk for home. It works an absolute treat at work and just lets me switch stuff up when I feel like it. they take a reasonable amount of desk space up but I tend to leave my desk fairly

Arduino ethernet shield

My ethernet shield arrived this morning from Hong Kong. Looking forward to making a little Arduino based Web server! The price for the shield was only ?5 on ebay including delivery :-) super cheap considering how much they cost a couple of years ago.

Specflow

After listening to .Net Rocks with Scott Millett this week I felt a renewed enthusiasm for trying out some BDD. I downloaded Specflow and got straight on with the screen cast they have on their website. The video acts as a good introduction into how to get up and running in Specflow. Interestingly it also gave me a better insight into how bowling works. I have never really thought about it. I normally just wang the balls down the lane until the game is over! Specflow introduces the idea of writing the specification first. It uses a specific language called Gherkin which comes from Ruby land. You will need NUnit installed as well. An example of it is:  [edit: NUnit is what I have used up to now but Specflow is compatible with other testing frameworks aswell. See the comments section below.] Feature : Passwords In order to have a strong password As a new user or existing user changing my password I need to check if my password is alphanumeric and is greater than 6 characters Scenario