Add vscode devcontainer

[cotes2020]

Type of change

• New feature (non-breaking change which adds functionality)

Description

Improve the experience of developing on cross-platform with vscode Dev Container.

Usage

Prerequisites

Refer to the VS Code docs to complete the following installation:

• Docker Engine
• Extension Dev Containers

Container environment

• Ruby, Bundler and Jekyll
• NVM, NPM and Node.js
• Shell using Zsh and Oh-My-Zsh with Git plugin enabled.
• A set of extensions for syntax check and formatting of code.

Suggestions for macOS/Windows users

Please use Clone Repository in Container Volume to build for better disk I/O performance.

Additional context

• Discussed in Fix build on Windows (restore tzinfo dependency) #1767

[cotes2020]

@kungfux You can test this PR on Windows now. But the prerequisite is that the local machine needs to have Docker installed first, please let me know if you have any problems, thanks.

[kungfux]

Thanks for the effort. It will be great to use the same development environment for all contributors.

I was able to spin up devcontainer and have Chirpy running in my browser.

However, I discovered a few things:

• I had to use bundle exec jekyll s instead of ./tools/run as it produces an error:

vscode ➜ /workspaces/jekyll-theme-chirpy (feature/devcontainer) $ ./tools/run
/usr/bin/env: ‘bash\r’: No such file or directory

This happens due to CRLF line endings, so you may want to adjust .gitattributes. There are tips for that problem available in documentation you were referring to.

• Watch mode does not work (I see no updates when modify posts) and this seems to be a general issue with containers

vscode ➜ /workspaces/jekyll-theme-chirpy (feature/devcontainer) $ ./tools/run

> bundle exec jekyll s -l -H 127.0.0.1

/usr/local/rvm/gems/default/gems/jekyll-4.3.3/lib/jekyll.rb:28: warning: csv was loaded from the standard library, but will no longer be part of the default gems since Ruby 3.4.0. Add csv to your Gemfile or gemspec. Also contact author of jekyll-4.3.3 to add csv into its gemspec.
/usr/local/rvm/gems/default/gems/safe_yaml-1.0.5/lib/safe_yaml/transform.rb:1: warning: base64 was loaded from the standard library, but will no longer be part of the default gems since Ruby 3.4.0. Add base64 to your Gemfile or gemspec. Also contact author of safe_yaml-1.0.5 to add base64 into its gemspec.
Configuration file: /workspaces/jekyll-theme-chirpy/_config.yml
 Theme Config file: /workspaces/jekyll-theme-chirpy/_config.yml
            Source: /workspaces/jekyll-theme-chirpy
       Destination: /workspaces/jekyll-theme-chirpy/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 3.703 seconds.
 Auto-regeneration: enabled for '/workspaces/jekyll-theme-chirpy'
LiveReload address: http://127.0.0.1:35729
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.
        LiveReload: Browser connected

bundle exec jekyll s --verbose does not give me any useful info. The only workaround I found so far is to use --force_polling flag.

[cotes2020]

I had to use bundle exec jekyll s instead of ./tools/run as it produces an error: ...

I removed the suffix from the script file ( tools/* ), so the repo settings is not working.

jekyll-theme-chirpy/.gitattributes

Line 6 in 0102aba

*.sh text eol=lf

Watch mode does not work ... The only workaround I found so far is to use --force_polling flag.

That's true, I'll still improve the script to adapt to docker.

P.S. If you clone the repository in the container you don't run into these problems and get better disk performance.

[kungfux]

P.S. If you clone the repository in the container you don't run into these problems and get better disk performance.

Thank you for mentioning this! It makes a huge difference. 😊

[kungfux]

LGTM

Thanks.

[kungfux]

In case you find this useful. Make bash autocompletion work for Git commands:

"postCreateCommand": "echo \"source /usr/share/bash-completion/completions/git\" >> ~/.bashrc"

[cotes2020]

In case you find this useful. Make bash autocompletion work for Git commands:

"postCreateCommand": "echo \"source /usr/share/bash-completion/completions/git\" >> ~/.bashrc"

After digging deeper, I realized that instead of setting up git in bash, it's better to enable the more powerful OMZ.

[kungfux]

Seems to work as expected.
Thank you.

[github-actions]

🎉 This issue has been resolved in version 7.1.0 🎉

The release is available on:

• v7.1.0
• GitHub release

Your semantic-release bot 📦🚀