This repository has been archived on 2025-06-18. You can view files and clone it, but you cannot make any changes to its state, such as pushing and creating new issues, pull requests or comments.
batmon/vendor/github.com/inconshreveable/mousetrap
2024-01-11 23:37:32 +03:00
..
LICENSE provide vendor dir for nix 2024-01-11 23:37:32 +03:00
README.md provide vendor dir for nix 2024-01-11 23:37:32 +03:00
trap_others.go provide vendor dir for nix 2024-01-11 23:37:32 +03:00
trap_windows.go provide vendor dir for nix 2024-01-11 23:37:32 +03:00

mousetrap

mousetrap is a tiny library that answers a single question.

On a Windows machine, was the process invoked by someone double clicking on the executable file while browsing in explorer?

Motivation

Windows developers unfamiliar with command line tools will often "double-click" the executable for a tool. Because most CLI tools print the help and then exit when invoked without arguments, this is often very frustrating for those users.

mousetrap provides a way to detect these invocations so that you can provide more helpful behavior and instructions on how to run the CLI tool. To see what this looks like, both from an organizational and a technical perspective, see https://inconshreveable.com/09-09-2014/sweat-the-small-stuff/

The interface

The library exposes a single interface:

func StartedByExplorer() (bool)