Files
fish-config/functions/joplin.fish
T
rootiest e651566e14 docs(functions): split RETURNS into EXIT STATUS and stdout RETURNS
RETURNS previously conflated fish's $status exit code with genuine
stdout/printed output, e.g. rm listing "0/1" as if they were print
values rather than exit codes. Rename RETURNS to EXIT STATUS across
all 83 documented functions, and reintroduce RETURNS as a distinct
label reserved for the 15 functions that actually print to stdout.

Update build-manual.py's ENTRY_HEADS to render Exit Status before
Returns, manualtools.py's SECTIONS constant, and AGENTS.md's label
order and label-usage guidance to match. Add two verify-manual.py
regression tests: EXIT STATUS bodies must never contain stray
stdout/printed language, and Returns: must always render after
Exit Status: when both are present. Regenerate docs/fish-config.md.
2026-07-26 16:41:57 -04:00

32 lines
753 B
Fish

# Copyright (C) 2026 Rootiest
# SPDX-License-Identifier: AGPL-3.0-or-later
# CATEGORY
# 14-miscellaneous
#
# SYNOPSIS
# joplin [args...]
#
# DESCRIPTION
# Runs the Joplin CLI with Node deprecation warnings suppressed via
# NODE_OPTIONS=--no-deprecation.
#
# ARGUMENTS
# args... Arguments forwarded to the joplin command
#
# EXIT STATUS
# 0 Joplin ran successfully
# 1 joplin binary not found in PATH
#
# EXAMPLE
# joplin ls
function joplin --description 'Run Joplin CLI without Node deprecation warnings'
set -l joplin_path (command -v joplin)
if test -n "$joplin_path"
NODE_OPTIONS="--no-deprecation" $joplin_path $argv
else
echo "Error: joplin binary not found in PATH" >&2
return 1
end
end