@types/shell-quote - npm Package Compare versions

Comparing version 1.6.2 to 1.7.0

shell-quote/index.d.ts

@@ -1,19 +0,55 @@
-// Type definitions for shell-quote 1.6
+// Type definitions for shell-quote 1.7
 // Project: https://github.com/substack/node-shell-quote
 // Definitions by: Jason Cheatham <https://github.com/jason0x43>
 //                 Cameron Diver <https://github.com/CameronDiver>
+//                 Opportunity Liu <https://github.com/OpportunityLiu>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.2
 
+export type ControlOperator = '||' | '&&' | ';;' | '|&' | '<(' | '>>' | '>&' | '&' | ';' | '(' | ')' | '|' | '<' | '>';
+
 export type ParseEntry =
     | string
-    | { op: string }
+    | { op: ControlOperator }
     | { op: 'glob'; pattern: string }
     | { comment: string };
 
-export function quote(args: string[]): string;
+export interface ParseOptions {
+    /**
+     * Custom escape character, default value is `\`
+     */
+    escape?: string;
+}
+
+/**
+ * Return a quoted string for the array `args` suitable for using in shell commands.
+ */
+export function quote(args: ReadonlyArray<string>): string;
+
+/**
+ * Return an array of arguments from the quoted string `cmd`.
+ *
+ * Interpolate embedded bash-style `$VARNAME` and `${VARNAME}` variables with the `env` object which like bash will replace undefined variables with `""`.
+ */
 export function parse(
     cmd: string,
-    env?: { [key: string]: string } | ((key: string) => string | object),
-    opts?: { [key: string]: string }
+    env?: { readonly [key: string]: string | undefined },
+    opts?: ParseOptions,
 ): ParseEntry[];
+
+/**
+ * Return an array of arguments from the quoted string `cmd`.
+ *
+ * Interpolate embedded bash-style `$VARNAME` and `${VARNAME}` variables
+ * with the `env` object which like bash will replace undefined variables with `""`.
+ *
+ * @param env
+ *   A function to perform lookups.
+ *   When env(key) returns a string, its result will be output just like env[key] would.
+ *   When env(key) returns an object, it will be inserted into the result array like the operator objects.
+ */
+export function parse<T extends object | string>(
+    cmd: string,
+    env: (key: string) => T | undefined,
+    opts?: ParseOptions,
+): Array<ParseEntry | T>;

shell-quote/package.json

 {
     "name": "@types/shell-quote",
-    "version": "1.6.2",
+    "version": "1.7.0",
     "description": "TypeScript definitions for shell-quote",
@@ -16,2 +16,7 @@ "license": "MIT",
             "githubUsername": "CameronDiver"
+        },
+        {
+            "name": "Opportunity Liu",
+            "url": "https://github.com/OpportunityLiu",
+            "githubUsername": "OpportunityLiu"
         }
@@ -28,4 +33,4 @@ ],
     "dependencies": {},
-    "typesPublisherContentHash": "d6e476c1a556f8e679f2f5292f764d24d7ddaf87122b2dc366ac369b83764cda",
+    "typesPublisherContentHash": "12f731d329d184880ec5f2841ec522d58c6dab78b56da0752420718763fe21de",
     "typeScriptVersion": "3.0"
 }

shell-quote/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Fri, 15 May 2020 13:12:37 GMT
+ * Last updated: Wed, 24 Jun 2020 08:22:58 GMT
  * Dependencies: none
@@ -17,2 +17,2 @@ * Global values: none
 # Credits
-These definitions were written by [Jason Cheatham](https://github.com/jason0x43), and [Cameron Diver](https://github.com/CameronDiver).
+These definitions were written by [Jason Cheatham](https://github.com/jason0x43), [Cameron Diver](https://github.com/CameronDiver), and [Opportunity Liu](https://github.com/OpportunityLiu).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4726

increased by46.04%

Lines of code

49

increased by188.24%

No dependency changes