npmpackage.info

Gathering detailed insights and metrics for shellwords-ts

shellwords-ts - 3.0.1 | npmpackage.info

shellwords-ts

Manipulate strings according to the word parsing rules of the UNIX Bourne shell.

3.0.1

MIT

TypeScript

10.78 kB

2.8

Installations

npm install shellwords-ts

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

19.1.0

NPM Version

8.19.3 Pull Requests

Open

5

Total

55

Closed

50

Issues

Open

0

Total

0

Closed

0

Releases

v3.0.1

Updated on Nov 23, 2022

View All 1 releases

Languages

TypeScript

JavaScript

TypeScript (70.59%)

JavaScript (29.41%)

Developer

marques-work

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

2 Stars

43 Commits

2 Watchers

6 Branches

1 Contributors

Updated on Dec 20, 2022

Maintainers

View All 1 Contributors

Package Meta Information

Latest Version

3.0.1

Package Id

shellwords-ts@3.0.1

Unpacked Size

10.78 kB

Size

4.29 kB

File Count

NPM Version

8.19.3

Node Version

19.1.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@types/chai @types/mocha @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser chai eslint mocha ts-node typescript typescript-formatter

Shellwords-TS

A JavaScript port of the Ruby module of the same name, with TypeScript typings. Shellwords provides functions to manipulate strings according to the word parsing rules of the UNIX Bourne shell. Originally forked from jimmycuadra/shellwords, this package is updated to be at parity with a modern reference implementation (Ruby 3.1.2 at the time of writing) and implements Shellwords.join(), which was missing from the original package. The goal of this is to maintain parity with the Ruby Shellwords module, so if there is a discrepancy, please file a bug (or even better, a PR).

Installation

Add "shellwords-ts" to your package.json file and run npm install.

Example

1import Shellwords from "shellwords-ts";
2
3Shellwords.split("foo 'bar baz'"); // ["foo", "bar baz"]
4Shellwords.escape("What's up?"); // "What\\'s\\ up\\?"
5Shellwords.join(["find", "~/Library/Application Support", "-name", "*.plist"]); // "find \\~/Library/Application\\ Support -name \\*.plist"
6
7Shellwords.split("foo 'bar baz' quu", (rawPart) => {
8  // have access to the chunks of the raw string as it is scanned
9});

Breaking changes as of 3.0.0:

Shellwords.escape() no longer escapes +; see this commit in the GitHub Ruby repo.

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

3

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

1

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

2.8

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More