Sundial

Marvin Heilemann

|
101 installs
|
312 downloads
| (1) | Free
Change your VS Code theme based on your sunset and sunrise!
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

☀️ Sundial ☀️

Change your VS Code theme based on your sunset and sunrise!

Visual Studio Marketplace Visual Studio Marketplace Visual Studio Marketplace Maintainability Total alerts Language grade: JavaScript Greenkeeper

Installation • Extension Keybindings • Extension Commands • Extension Settings • Automation • Development

Sundial changes your theme based on your day and night cycle. It is inspired by the OSX Mojave dynamic backgrounds and Night Owl for Mac. It should reduce eye pain when working in the night or on the day. Humans should not strain their eyes too much, it's not recommended to have a light theme in the night and vice versa.

Whenever you have ideas for this project, things you would like to add or you found a bug, feel free to create an issue or start contributing! 😇

Buy Me A Coffee

VSCode Sundial

:desert_island: Installation

You can simply install any VS Code extension via the VS Code Marketplace:

Install Sundial Extension

:keyboard: Extension Keybindings

Sundial contributes the following keybindings:

Platform Keybinding Action
Windows ctrl+alt+t sundial.toggleDayNightTheme
Mac ctrl+cmd+t sundial.toggleDayNightTheme

:bellhop_bell: Extension commands

Sundial contributes the following commands:

Command Action Description
Sundial: Night Theme sundial.switchToNightTheme Switch to your night theme.
Sundial: Day Theme sundial.switchToDayTheme Switch to your day theme.
Sundial: Toggle Day/Night Theme sundial.toggleDayNightTheme Toggle between your day/night theme.
Sundial: Continue switching day/night theme automatically sundial.continueAutomation Continue to use the sundial configured automation script.

Note that whenever you use one of this commands Sundial will disable the automation process of changing your theme on day night basis. To continue using that feature you need to reactivate it with sundial.continueAutomation. If you thing you know a better implementation please contribute!

:gear: Extension Settings

Sundial contributes the following settings:

Setting Default Description
sundial.dayTheme Light+ Name of the theme of choice for your day work.
sundial.nightTheme Dark+ Name of the theme of choice for your night work.
sundial.sunrise 07:00 Set a time when your day starts in 24 hours format.
sundial.sunset 19:00 Set a time when your night starts in 24 hours format.
sundial.interval 5 Set a interval in which sundial should check the time.
sundial.useHTTPS false Use some services with HTTPS instead of HTTP. (Please note that this is slower!)

If you set the interval to zero (0) sundial will not periodically check the time but still when VS Code triggers the events ChangeWindowState, ChangeActiveTextEditor and ChangeTextEditorViewColumn.

Automatically get sunrise and sunset

To get your sunrise and sunset automatically you can either set latitude and longitude or set autoLocale to true.

On autoLocale set to true Sundial will pull you public IP Address with the node package public-ip and then pass it to ipapi to get you locationstring.

It is recommended to set your latitude and longitude manually for better a stability because autoLocale, which uses ipapi, has limited API calls (free plan includes 10.000 requests per month). You can get your latitude and longitude from ipapi website (the box on the right).

Setting Default Description
sundial.autoLocale false Only updates location when your public IP changes
sundial.latitude ⊘ e.g. "50.110924"
sundial.longitude ⊘ e.g. "8.682127"

:hammer_and_wrench: Development

We are working with webpack to bundle Sundial to the smallest possible size to increase the load time in VSCode.

  1. Install packages via npm install
  2. Set sundial.debug to true (not necessary but recommended)
  3. Run debugger => Extension
  4. Go into the extensionHost and adjust settings to test
  5. Change a file and save it, let webpack compile
  6. Reload the debugger (⇧⌘F5)

Please note that while sundial.debug is set to true Sundial will always pull your IP again. So keep that in mind before using it because we have a request limit.

⚠️ Don't forget to change the version and include a detailed changelog of the changes you made!

Tools

To make it easier for you, I have added two scripts to create a new version and tag faster then doing it manually.

  • Run npm run version to interactively create a new version (based on the awesome np-package from @sindresorhus)
  • Run npm run tag to tag the current package.json version to your latest commit