Git Product home page Git Product logo

pkg-update-checker's Introduction

pkg-update-checker for Emacs

pkg-update-checker is an Emacs package designed to asynchronously check for package updates and notify the user through both an Emacs buffer and system notifications. This allows Emacs users to stay informed about available updates for their installed packages without interrupting their workflow. The package leverages the async package to ensure that the update check runs in the background, avoiding any disruption to the user's current tasks.

Features

  • Asynchronous Update Checks: Uses the async package to check for package updates without blocking Emacs.
  • User Notifications: Notifies the user of available package updates through system notifications and an interactive buffer.
  • Customizable Check Interval: Users can define how frequently (in hours) the update check should occur, with a default setting of every 24 hours.
  • Interactive Package List: The upgradable packages are listed in a special Emacs buffer, where each package name is a clickable button that brings up the package description.

Requirements

  • Emacs 27.2 or higher
  • async 1.9

Installation

To install pkg-update-checker, clone this repository to your local machine and add the directory to your Emacs load-path. Then, require the package in your Emacs configuration:

(add-to-list 'load-path "/path/to/pkg-update-checker")
(require 'pkg-update-checker)

Replace "/path/to/pkg-update-checker" with the actual path to where you have cloned or placed the pkg-update-checker package.

Usage

To start the package updater timer, ensuring it only runs when Emacs is operating in server mode, add the following to your Emacs initialization file:

(start-pkg-update-checker-timer)

This function checks if server-mode is active before starting the timer. If Emacs is not in server mode, it will output a message indicating that the package updater timer will not start.

use-package:

(use-package pkg-update-checker
  :defer 30 ;; start first update check 10+30s later after emacs start, default is 10
  :load-path "site-lisp/pkg-update-checker" 
  :config
  (start-pkg-update-checker-timer))

Customization

You can customize the interval at which pkg-update-checker checks for updates by setting the pkg-update-checker-interval-hour variable before (start-package-updater-timer):

(setq pkg-update-checker-interval-hour 12) ; Check for updates every 12 hours
(start-pkg-update-checker-timer)

pkg-update-checker's People

Contributors

metaescape 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.