shq

Quote a string for safe use as a shell argument. Strips null characters.

ISC 4 个版本
安装
npm install shq
yarn add shq
pnpm add shq
bun add shq
README



shq

Quote a string for safe use as a shell argument. Strips null characters.

API

This module ESM-exports one function that holds some methods:

shq(x)

  • Stringify x,
  • remove all U+0000 null characters, because all too often, some C program in the pipeline will screw it up even if properly quoted,
  • and in case it contains special characters, quote it.

shq.cfg(opt)

Return a customized quoting function. opt is an optional options object that supports these keys:

  • empty: How to represent the empty string. Default: A pair of single quotes.
  • gratuitous: What string to put on both sides of a non-empty input that doesn't need to be quoted.

shq.always

A quoting function that adds gratuitous single quotes (cf. .cfg).

Usage

see test/usage.mjs.

Known issues

  • Needs more/better tests and docs.

 

License

ISC

版本列表
1.0.3 2024-01-07
1.0.2 2020-06-27
1.0.1 2020-06-27
1.0.0 2020-06-27