Hi, there, today I would like to write about something I personally surprised me more than ever. Yes, that’s because using WSL in Windows is surprisingly good.
What is WSL and why we should bother
Windows Subsystem for Linux, or WSL for short, is a really cool piece of technology brought by Microsoft in August 2016 for the first time and in June 2019 with the introduction of WSL 2.
Essentially we talking about a compatibility layer between Windows and GNU/Linux. Microsoft claims that you can run linux applications and utilites inside Windows 10 (and Windows server 2019) without the overhead of some form of virtualization.
In this article we talking about WSL 2, available through the Windows Insider Program starting from June 2019. The WSL 2 technology is based on light virtualization technologies in order to run a set of customized GNU/Linux distribution with custom kernel images.
The incredible thing is that users can now access the same file from Windows AND Linux, so different programs one running from Windows and the other from Linux can access the same set of files.
This gives a developer an incredible amount of flexibility: first of all, services like LAMP architectures (does somebody still use it?) can be installed on WSL machine and accessed by project on Windows developed in PHP Storm for example, thus removing the hassle of install all the complicated, ported to Windows, Unix tools that nobody wants to install on Windows.
Think about MSYS, CygWin, Angular, or Python and Ruby. Installing tools like this for development in Windows is always been a pain in the ass historically. You have to mess with Path and file system convention for UNIX in Windows and annoying stuff.
But using WSL developers like me, forced to use Windows on a daily job can actually enjoy the freedom to install a new development environment in a breeze and access it from Windows as fast as you can. Snappy!
As we already seen in order to install WSL you have to manually enable the functionality inside the operating system by opening a Powershell in administrator mode and type:
Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
and you’re good to go.
Firstly open the Microsoft Store and search for one of the few linux distribution you can install as today on Windows (can you believe? Linux on Windows?):
- Kali Linux
- Ubuntu 18.04 LTS
- SUSE Linux Enterprise Server 15
- Alpine WSL
- OpenSUSE Leap 15.1
I chose Debian because its freedom and the goal the project and for the incredible amount of documentation you can find online. So maybe some command in the rest of the article should not work properly if you use another non-debian distros.
Once started debian you’ll be asked for username and password for your account, choose one and sign it down somewhere to make sure you won’t forget it.
Build an environment
By default Ruby is not installed on Debian and as we alredy seen in previous posts we can install it with a tool that makes installation of a specific version of Ruby a breeze. This tool is called rbenv which stands for Ruby Environment (if you ever worked with the Python programming language you may recognize similarities with pyenv).
To install Rbenv make sure you write on bash:
$ # Prepare your system to install rbenv and ruby-build script $ sudo apt install git curl libssl-dev libreadline-dev zlib1g-dev autoconf bison build-essential libyaml-dev libreadline-dev libncurses5-dev libffi-dev libgdbm-dev $ # Actually install REnv (make sure you are on bash) $ curl -sL https://github.com/rbenv/rbenv-installer/raw/master/bin/rbenv-installer | bash -
You eventually got some error for PATH properly set.
So fix it like (on bash):
$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.bashrc $ echo 'eval "$(rbenv init -)"' >> ~/.bashrc $ source ~/.bashrc $ # As requested in Jekyll docs we install dh-autoreconf $ sudo apt-get install dh-autoreconf
or like that:
$ echo 'export PATH="$HOME/.rbenv/bin:$PATH"' >> ~/.zshrc $ echo 'eval "$(rbenv init -)"' >> ~/.zshrc $ source ~/.zshrc $ # As requested in Jekyll docs we install dh-autoreconf $ sudo apt-get install dh-autoreconf
if you’re using zsh as default shell (we’ll see how to change it in a future article).
Install Ruby via RbEnv
So right now you can finally install Ruby:
$ rbenv install 2.5.0 $ rbenv global 2.5.0 $ rbenv install 2.5.0-dev $ # Now we can install Jekyll via Gem but before we perform a Gem Update $ gem update --system $ bundle install $ # Now you should be able to install jekyll $ gem install jekyll bundler
you should be see an installation of jekyll.
VSCodium as opposed to VSCode
In the recent years VSCode has become very very popular as IDE for the most important 3 OSes (Windows, macOS, GNU/Linux) and using it I must say it’s incredibly versatile and supports a lot of programming languages, such as JS, TypeScript, Python, Go, C/C++, and a ton of other programming languages via an easy-to-install plugins system.
But, altrough VSCode is released under a MIT licence, when distributing binaries, Microsoft clones the repository, adds telemetry and icons and then produces a build which is not released under a non open source licence.
As I try to be very careful on installing unnecessary closed source software on my machine I found VSCodium to perfectly fit my needs. I got the best of two worlds. As in this case I’m using Windows I installed with Chocolatey which is my default package manager on Bill Gates’ preferred platform, run this command in a Adminstrator Powershell:
$ choco install vscodium
If you don’t know Chocolatey, you should definitely check it out, it’s an incredible versatile tool for automate installation of programs.
I’ll made an article about that in the future. Once installed VSCodium to make it productive I had to install some plugins. Click on last icon on the bottom of the sidebar at right of the editor (or press Ctrl+Shift+X on Windows) and search the marketplace for the 2 plugins I installed:
The first shows a preview of rendered markdown files, the second shows icons for every single file and the third is useful for spellcheck of the languages. Keep in mind that if you have Windows Enterprise you can have a bug that prevents you to display non-installed spellchecked languages in Windows and sometimes you cannot install other than the default, if you’re not administrator of your computer.
It sadly happened to me.
But aside from that something more important is to make sure that you can start jekyll from inside terminal console of VSCodium via Windows Linux Subsystem, which is incredible in my opinion. Open a Terminal inside VSCodium and select wsl from top down menu.
You should see the debian bash command line.
From here move youself to the folder that contains a previous installation of a jekyll inside windows. In my case I just cloned a standard installation of Jekyll and pushed to simonekalb.github.io repository.
I will not make a tutorial about that since I just follow the well-done GitHub tutorial. But just in case you don’t want to start from scratch you can just fork my repo and then clone it repo. Firstly hit clone on the repo browsing to the page: https://github.com/simonekalb/simonekalb.github.io. Then clone it after renaming it with your username:
$ # Move to desired folder you keep you software projects $ cd $home $ mkdir Development $ cd Development $ git clone https://github.com/yourusername/yourusername.github.io
Now you can start jekyll from within debian accessing windows file systems through
/mnt/c/ mountpoint, which is very handy.
Setup the development environment with Jekyll and LiveReload
Move to VSCodium Wsl terminal as previously described and start Jekyll test server by typing:
$ bundle exec jekyll serve --livereload Configuration file: /mnt/c/Users/simone.kalb/Development/simonekalb.github.io/_config.yml Source: /mnt/c/Users/simone.kalb/Development/simonekalb.github.io Destination: /mnt/c/Users/simone.kalb/Development/simonekalb.github.io/_site Incremental build: disabled. Enable with --incremental Generating... Jekyll Feed: Generating feed for posts done in 0.431 seconds. Auto-regeneration may not work on some Windows versions. Please see: https://github.com/Microsoft/BashOnWindows/issues/216 If it does not work, please upgrade Bash on Windows or run Jekyll with --no-watch. Auto-regeneration: enabled for '/mnt/c/Users/simone.kalb/Development/simonekalb.github.io' LiveReload address: http://127.0.0.1:35729 Server address: http://127.0.0.1:4000/ Server running... press ctrl-c to stop. Regenerating: 1 file(s) changed at 2019-08-10 14:21:17 _posts/2019-08-03-manage-a-windows-test-environment-jekyll.md Jekyll Feed: Generating feed for posts ...done in 0.2084859 seconds. LiveReload: Browser connected
Seems that autoregeneration’s not working on Windows, but actually it does. One other incredible feature that I really love and I cannot live without as you may already read in the previous logs is the LiveReload feature.
This tool allow you to see in real time all the modification of your page without ever hit reload on your browser, as you just save the Markdown page.
So I’m writing this very guide, hit save and then automatically Jekyll regenerate all the html static pages from Markdown files, the LiveReload service listen at port
35729 and impose a reload of you current page.
And, boy this stuff is FAST.
If you cannot install LiveReload on your computer (or you don’t want) just open a webpage and head it to
http://127.0.0.1:35729/. You then modify a markdown page and you should read
LiveReload: Browser connected on console.
This should be sufficient to make youself confortable and really productive while updating your website. That’s all for now folks. Hope you found it interesting.