copy-to-clipboard

#!/usr/bin/env bash

# MIT License
#
# Copyright (c) 2024 John Karahalis
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.

# Use "strict mode."
#
# http://redsymbol.net/articles/unofficial-bash-strict-mode/
set -euo pipefail

COMMAND_NAME=$(basename "$0")

eval "$(docopts --help=- -A ARGS : "$@" <<EOF
Copy the contents of the given file to the clipboard.

This script only supports systems with "xclip" installed. In the future, it
could be extended to support Windows and other systems.

Usage:
  $COMMAND_NAME [--include-final-newline] FILE
  $COMMAND_NAME -h | --help

Options:
  -n, --include-final-newline
      Include the final newline of the file, if one is present at all.
  -h, --help
      Show this documentation
EOF
)"

# NOTE: If other platforms are supported in the future, xclip might not be a
# dependency in all cases.
DEPENDENCIES=(
  xclip
)

for DEPENDENCY in "${DEPENDENCIES[@]}"; do
  if ! command -v "$DEPENDENCY" > /dev/null; then
    >&2 echo "Error: \"$DEPENDENCY\" is not installed."
    exit 1
  fi
done

XCLIP_ADDITIONAL_ARGS=''
if ! ${ARGS[--include-final-newline]}; then
  XCLIP_ADDITIONAL_ARGS='-rmlastnl '
fi

# Leaving "$XCLIP_ADDITIONAL_ARGS" unquoted here appears to be required for
# reasons I don't fully understand.
#
# shellcheck disable=SC2086
xclip -selection clipboard $XCLIP_ADDITIONAL_ARGS "${ARGS[FILE]}"