☀️ Sundial ☀️

Change your VS Code theme and settings based on your sunset and sunrise with options!

• Installation
• Keybindings
• Commands
• Settings
  • Automatically get sunrise and sunset
  • Automatically get dark mode from macOS
  • Automatically set dark mode based on ambient light
  • Order
  • Examples
• Events
• Development
  • Tools
  • Tests

Sundial changes your theme and VS Code settings (if needed) based on your day and night cycle or other options, you choose. 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! 😇

Installation

You can simply install any VS Code extension via the VS Code Marketplace or download the VSIX file and install it manually.

Keybindings

Sundial contributes the following keybindings:

Note that whenever you use one of this keybindings, 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 the command sundial.continueAutomation.

Commands

Sundial contributes the following commands:

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.

Settings

Sundial contributes the following settings:

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.

On both daySettings and nightSettings they will override your Workbench VSCode settings. Please make sure both have the same properties otherwise they will not change since Sundial is not remembering the settings you have set before!

Automatically get sunrise and sunset

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

If autoLocale is set to true, Sundial will get your geolocation from https://freegeoip.app/. You can get your latitude and longitude manually from the same page.

Automatically get dark mode from macOS

Sundial provides a method to get the current operating system appearance preference value. This works on OSX only at the moment. To use this set sundial.systemTheme to true and Sundial will ignore all other options.

This options works very good with Night Owl for Mac or Starlight.

Successfully tested on: MacBook Pro (15-inch, 2017) with macOS 10.14.5

Automatically set dark mode based on ambient light

!!!WORK IN PROGRESS!!!

Sundial will check access to your computers ambient light sensor and will use it to determine if dark mode is needed in your environment. To use this set sundial.ambientLight to true.

If you don't know what the ambient light sensor is, you might know it from your smartphone where the display gets brighter or darken depending on the light around it. Most Laptops have this nowdays so we can take use of it.

Sundial will ignore all other options.

Order

Settings will be applied in this order (first one overrides all after):

1. sundial.systemTheme
2. sundial.ambientLight (WIP)
3. sundial.latitude and sundial.longitude
4. sundial.autoLocale
5. sundial.sunrise and sundial.sunset

Examples

{
  "sundial.dayTheme": "Cloudy Mountain",
  "sundial.nightTheme": "Atom One Dark",
  "sundial.interval": 20,
  "sundial.autoLocale": true
}

{
  "sundial.dayTheme": "Cloudy Mountain",
  "sundial.nightTheme": "Atom One Dark",
  "sundial.sunrise": "05:12"
}

{
  "sundial.dayTheme": "Cloudy Mountain",
  "sundial.nightTheme": "Atom One Dark",
  "sundial.dayVariable": 43,
  "sundial.latitude": "50.110924",
  "sundial.longitude": "8.682127",
  "sundial.daySettings": {
    "editor.fontSize": 13
  },
  "sundial.nightSettings": {
    "editor.fontSize": 15
  }
}

Events

Sundial performs checks for a few VS Code events to check in certain situations if it should change your theme. Here is a list of events which will Sundial perform by default.

• window.onDidChangeWindowState
• window.onDidChangeActiveTextEditor
• window.onDidChangeTextEditorViewColumn
• workspace.onDidChangeConfiguration
• workspace.onDidChangeTextDocument
• Sundial.automater

If you want to customize those, you just need to add these configs:

{
  "sundial.windowEvents": [
    "onDidChangeWindowState",
    "onDidChangeActiveTextEditor",
    "onDidChangeTextEditorViewColumn"
  ],
  "sundial.workspaceEvents": ["onDidChangeConfiguration", "onDidChangeTextDocument"]
}

You can find a full list of available events here:

• Workspace: https://code.visualstudio.com/api/references/vscode-api#workspace
• Window: https://code.visualstudio.com/api/references/vscode-api#window

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)
7. Run tests with npm test
8. Create a new version
9. Add a detailed description to the changelog
10. Create a pull request

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

Tools

• npm run version: Interactively create a new version (based on semver).
• npm run tag: Tag the current package.json version to the latest commit.
• npm run release: Create a new GitHub release draft.

Tests

All tests that are running with npm test:

1. setContext
2. updateConfig
3. checkConfig
4. useLatitudeLongitude
5. useAutoLocale
6. setVariable
7. automater
8. applySettings
9. toggleTheme
10. disablePolos