After listening to a number of recent podcasts related to Visual Studio Code, and then seeing it hit it’s 1.0 offical release, I figured I’d give it a go.
I’ve been using Sublime Text 3 for most of my development and text editing needs for a long time. I’ve tried Atom (which, at the time, was a little too buggy in places and slower than ST) and recently I’ve tried to stear clear of fully featured IDEs.
Before that, I worked for Microsoft for 10 years and spent all of my time in the full version of Visual Studio. Visual Studio is a fantastic IDE - one of the most powerful available - but most of my work right now is on a non-MS tech stack, using a MacBook for development, so I’ve not had many reasons to use VS.
So far, I’m pretty impressed with VS Code. The editor starts up nice and quickly, the git support looks pretty neat, and for markdown editing (which is what I’m doing right now as I write this post) the support for markdown and previewing the output is pretty good. I even managed to get it to build my site using Jekyll so that Cmd+Shift+B will kick off jekyll serve.
Many of the keyboard shortcuts that I use in Sublime Text work in Code too, so I’m also not having to learn too many new tricks.
I’m going to see how it does with Ruby and Python development, and will report back.
For now, though, I’m pleasantly surprised.
Oh, and if you want to know how I got my jekyll build to work, here’s what I did…
using VS Code, type Cmd+Shift+P to get access to the command list
type “task” and select the option to configure the task runner
you will be given some options. Select the one for a custom task.
VS code will create a file .vscode/tasks.json
Set up the task you want to run here. Mine looks like this…
On Bitly you can set up custom domains. These allow you to replace the bit.ly part of any short link with your own short domain name.
Each short link on Bitly is made up of the domain plus a hash. The hash is autogenerated by Bitly when you ask them to shorten the link.
For example, in the short link…
… (a link to this blog) the domain is bit.ly and the text 1X5IvtX is the hash.
If you want, you can then customize your short links to make the hash easier to read/type.
For example, I’ve customized the previous short link to be:
So, with a custom domain, you are essentially replacing the bit.ly domain with your own.
However, even with a custom domains, all hashes must be globally unique across the whole of Bitly. This means that if someone has already used the hash martinpeck for a short url. That sounds fair enough, but this rule is enforced across custom domains too. So, regardless of whether the domain would make the short url look unique, the hash must be globally unique across all of Bitly and all of the custom domains.
The result is that you end up spending a lot of time trying to find useful hashes and, in many cases, the hashes get very long which defeats the purpose of using a link shortener.
The other problem with Bitly is that you can’t ever change the final location of a short url. Once created, you can never edit the short url to direct users to a different resource. This is a real problem if you’ve printed the short url on posters or leaflets, or if the destination url changes for reasons you can’t control. I’m sure there are very good reasons why changing the redirects for short urls is a bad idea but, combined with the difficulty in finding unique hashes in the first place it’s sometimes desirable to update one.
The Solution - Write Your Own
My solution to this was to stop using Bitly, to say to myself “it can’t be that hard to redirect web requests”, and to write my own.
Now…I’ve not written anything nearly as complicated or feature rich as Bitly. I’ve written the stupidest thing that does what I need:
accept an HTTP request
look up the destination
respond with an HTTP 301 redirect to the final destination.
track all such requests
respond with a default redirect if the lookup fails
Plinky is written in Python, and uses the flask micro-framework. I picked flask because I’d not really played much with flask. I’ve used Sinatra (with Ruby), but hadn’t tried flask. Plinky is hardly the most complicated example of a flask app, but I certainly found it simple to set up and get working.
At the heart of Plinky is a YAML file that contains a list of hashes with the intended destinations. If you look at the example YAML file in Github you’ll see it looks like this…
The default hash is used any time that a hash lookup fails. The other name/value pairs are short url hashes and their redirect destinations.
Plinky just sits there looking up hashes and issuing HTTP 301 redirects. If you look at the code you can see that there’s not much to it really.
plinky.py is the main entry point for HTTP requests. It sets up a handful of routes (some of which are a work in progress) but the main one is this…
This route tracks the redirect event using some code in tracking.py and then performs the HTTP 301 redirect using some code in shortcuts.py
Plinky uses Segment to track how many times a given hash is used for redirect. This is optional, and controlled by the existance of an environemnt variable holding the key that Segment requires.
Segment is a service that takes events and then hands them off to 1 or more other analytics services. So, you can send a single event to Segment and have Segment issue an analytics event to Google Analytics, MixPanel or a whole host of other analytics endpoints. This makes it super easy to add and replace the services you use for analytics.
And that’s about it. If you deploy Plinky to Heroku it’ll sit there and preform redirects for you.
Another Use for Plinky
At the place I work we recently deprecated one of our domains and wanted to set up redirects to the new domain and new URL structure. Plinky was perfect for this.
Plinky just needs name/value pairs in the configured YAML file, and it really doesn’t care in the name is more complex than a few characters. So, if you set up the short urls like this…
… and then configure a Plinky instance, via DNS, to sit on your old domain, then it can sit there and redirect your users to the new domain and new url strucutre, and if you’re using the tracking feature you can see whether this traffic slowly migrates over to your new domain.
Again, I’m sure there are better ways to do this, but this one got me and my team out of a hole and worked really well.
There are some things I want to improve with Plinky. For example, I want to add some stats and info pages to the service so that it’s easier to see how the short urls are set up. If you have any suggestions, or see any problems, please log an issue in the GitHub Issues database for this project.
So, for this week, I thought I’d try showing them how I go about designing a Scratch game and how I try and get the logic of the game working first, and make it look pretty later. We’re building Viking themed quiz games (a little like Code Club’s Brain Game project).
First, I showed them this sketch that I’d made to help me think about the game. It’s deliberately “scrappy” in nature, with some simple bullet point notes about what I want to happen in the game…
Next, I showed them how I took my scrappy sketch and built a game with equally scrappy graphics…
My hope, in all of this, was that by showing them this progression…
plan what you’re going to build
write a game that works, without worrying about the graphics
add better graphics and animation to your final game
… that they would focus on getting their games working before they then spent a lot of time making them look nice.
Did it work?
They did take some time to plan out their games on paper. However, as soon as they moved to the computers the lure of the sprite and background editors was too much for them. To be honest, I can’t blame them - it’s the bit that’s most fun.
Perhaps my mistake was showing them my final/finished project. Maybe I should have held back the finished project for another week. I’ll try this next time.
I joined Code Club in Jan 2015 to head up their engineering team. However, way before this I was already voluneering for Code Club.
Here’s why I started volunteering and what I get out of it…
What is a Code Club?
Code Club is an organisation that helps set up after school coding clubs for kids, aged 9 to 11. The clubs are generally run by a teacher, and a volunteer. Most clubs run after school, but not all of them…mine runs once a week at lunchtime.
As a volunteer, I’m there to help explain some of the concepts they’re learning, to help them when they get stuck etc. There’s a teacher with me too, who also helps the kids with the lesson but is also in charge of “crowd control”.
The idea is to introduce the kids to coding, but also to other concepts such as computational thinking, problem solving, planning, designing and collaboration.
Why did I start volunteering?
I started volunteering for Code Club back in April 2013. My son brought home a news letter from his school, in which they were asking for someone to help start a Code Club. I jumped at the chance, got myself registered with Code Club, and soon had the club up and running.
Is it hard to volunteer?
It’s 1 hour a week, during term time. The school I volunteer at is just around the corner from my house so it’s not a big deal in terms of time.
The projects that Code Club provide are really well structured. For the first few sessions you’ll probably want to read through the project and the volunteer notes before you turn up (which might mean you spend an hour, one evening, doing the lesson yourself). However, you soon get into the swing of things and that preparation time goes away.
I suspect that most people who work with computers during the day (not just programmers), who have a methodical approach to things (i.e. can read and follow instructions), and who are willing to learn new stuff could successfully volunteer at a Code Club.
What’s the best bit about volunteering?
For 1 hour each week I get to work with a group of programmers who are super keen and really interested in learning to code. It doesn’t matter how crappy my week has been, at the end of that hour I’m buzzing from the enthusiasm and energy that the kids have. They want to learn, and they really appreciate the help I’m giving them.
My advice to anyone considering volunteering for Code Club is do it! I was really nervous before my first club session (“What if the kids don’t like me?”, “What if they know more than I do?”) but after that first session I realised that I had nothing to worry about. Even if it’s just for a term, give it a go and help some kids learn to code.
If you use GitHub Issues for tracking work and bugs, then you probably also use labels for categorizing or highlighting those issues. You might also use labels for applying some sort of workflow, such as highlighting which issues are ready to be worked on, in progress, or blocked.
I have a set of labels that I tend to use in all of my GitHub projects. Creating them by hand is a pain. So, to fix this, I’ve written a python script that does this for me…
The definition of what labels I want, and which colour to use for them, is described a definitions.json file. For example, here are the definitions I generally use…
The script then does all the hard work for me.
It’s a pretty dumb script at present, taking no account of labels that already exist - it’ll fail to create the label if it already exists, and goes on to the next one. It will also leave any other labels alone. I may get around to changing some of these things…but don’t hold your breath.
If you see a problem with the script, or have any suggestions for how it could be improved, then add something to the issues on GitHub.com.