Code Monkey home page Code Monkey logo

nightenv's Introduction

๐ŸŒ™ nightenv npm

nightenv can be configured to change your editor themes, OS themes, and more based on the time of day.

Table of Contents

Requirements

  • node >= 6.11

Installation

npm i -g nightenv
nightenv

nightenv can be run multiple times without side effects. To uninstall, find the entry in your crontab via crontab -e and remove it, followed by npm rm -g nightenv.

Usage

nightenv can be configured via ~/.nightenv.json. Add a new entry based on sample configuration provided by your plugins.

nightenv plugins

Terminals

Editors/IDEs

Productivity

OS

Create your own plugin

To create your own plugin, create a JavaScript file that exports a execute function, like so:

module.exports.execute = function(config, isNight) {

  // config is an object that contains configuration arbitrarily
  // defined by your plugin

  // isNight is a boolean that represents whether it is night time

  // this function should return a promise with the configuration
  // containing any updates if there are any, giving your plugin
  // the ability to maintain state

};

About

After many days of switching between dark and light themes to reduce eye strain, I needed an automated solution, hence nightenv. This is not meant to be a state of the art piece of software, but instead it was meant to be a quick and easy tool that could be easily extended. Feel free to contribute new plugins or update the already existing ones if you have any issues.

Credits to themer and mjswensen for the inspiration to whip this together.

Roadmap

Will probably declare v1 after the following items are compeleted, not in any particular order:

  • tests / coverage
  • tmux
  • vim
  • slack
  • Windows 10
  • Linux
  • ?

nightenv's People

Contributors

tamzinselvi avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.