🤖 Merge PR DefinitelyTyped#74110 feat(shelljs): update types to match latest version by @viceice

Co-authored-by: George Kalpakas <[email protected]>

Author: viceice

types/shelljs/global.d.ts

@@ -0,0 +1,35 @@
+import shelljs = require("./index");
+
+declare global {
+    const cat: typeof shelljs.cat;
+    const cd: typeof shelljs.cd;
+    const chmod: typeof shelljs.chmod;
+    const cmd: typeof shelljs.cmd;
+    const config: typeof shelljs.config;
+    const cp: typeof shelljs.cp;
+    const dirs: typeof shelljs.dirs;
+    const echo: typeof shelljs.echo;
+    const env: typeof shelljs.env;
+    const error: typeof shelljs.error;
+    const exec: typeof shelljs.exec;
+    const exit: typeof shelljs.exit;
+    const find: typeof shelljs.find;
+    const grep: typeof shelljs.grep;
+    const head: typeof shelljs.head;
+    const ln: typeof shelljs.ln;
+    const ls: typeof shelljs.ls;
+    const mkdir: typeof shelljs.mkdir;
+    const mv: typeof shelljs.mv;
+    const popd: typeof shelljs.popd;
+    const pushd: typeof shelljs.pushd;
+    const pwd: typeof shelljs.pwd;
+    const rm: typeof shelljs.rm;
+    const sed: typeof shelljs.sed;
+    const set: typeof shelljs.set;
+    const sort: typeof shelljs.sort;
+    const tail: typeof shelljs.tail;
+    const tempdir: typeof shelljs.tempdir;
+    const touch: typeof shelljs.touch;
+    const uniq: typeof shelljs.uniq;
+    const ShellString: typeof shelljs.ShellString;
+}

types/shelljs/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node"/>
 
 import child = require("child_process");
-import glob = require("glob");
+import glob = require("fast-glob");
 
 /**
  * Changes the current working directory dir for the duration of the script.
@@ -1240,7 +1240,7 @@ export interface ShellConfig {
     /**
      * Passed to glob.sync() instead of the default options ({}).
      */
-    globOptions: glob.GlobOptions;
+    globOptions: glob.Options;
 
     /**
      * Absolute path of the Node binary. Default is null (inferred).

types/shelljs/make.d.ts

@@ -1,4 +1,5 @@
-import shelljs = require("./index");
+import "./global";
+
 declare global {
     interface Target {
         (...args: any[]): void;
@@ -7,38 +8,6 @@ declare global {
     }
     const target: {
         all?: Target;
-        [s: string]: Target;
+        [s: string]: Target | undefined;
     };
-
-    const cat: typeof shelljs.cat;
-    const cd: typeof shelljs.cd;
-    const chmod: typeof shelljs.chmod;
-    const cmd: typeof shelljs.cmd;
-    const config: typeof shelljs.config;
-    const cp: typeof shelljs.cp;
-    const dirs: typeof shelljs.dirs;
-    const echo: typeof shelljs.echo;
-    const env: typeof shelljs.env;
-    const error: typeof shelljs.error;
-    const exec: typeof shelljs.exec;
-    const exit: typeof shelljs.exit;
-    const find: typeof shelljs.find;
-    const grep: typeof shelljs.grep;
-    const head: typeof shelljs.head;
-    const ln: typeof shelljs.ln;
-    const ls: typeof shelljs.ls;
-    const mkdir: typeof shelljs.mkdir;
-    const mv: typeof shelljs.mv;
-    const popd: typeof shelljs.popd;
-    const pushd: typeof shelljs.pushd;
-    const pwd: typeof shelljs.pwd;
-    const rm: typeof shelljs.rm;
-    const sed: typeof shelljs.sed;
-    const set: typeof shelljs.set;
-    const sort: typeof shelljs.sort;
-    const tail: typeof shelljs.tail;
-    const tempdir: typeof shelljs.tempdir;
-    const touch: typeof shelljs.touch;
-    const uniq: typeof shelljs.uniq;
-    const ShellString: typeof shelljs.ShellString;
 }

types/shelljs/package.json

@@ -1,13 +1,24 @@
 {
     "private": true,
     "name": "@types/shelljs",
-    "version": "0.8.9999",
+    "version": "0.10.9999",
     "projects": [
         "http://shelljs.org",
         "https://github.com/shelljs/shelljs"
     ],
+    "exports": {
+        ".": "./index.d.ts",
+        "./global": "./global.d.ts",
+        "./global.js": "./global.d.ts",
+        "./make": "./make.d.ts",
+        "./make.js": "./make.d.ts",
+        "./package": "./package.json",
+        "./package.json": "./package.json",
+        "./plugin": "./plugin.d.ts",
+        "./plugin.js": "./plugin.d.ts"
+    },
     "dependencies": {
-        "glob": "^11.0.3",
+        "fast-glob": "^3.3.2",
         "@types/node": "*"
     },
     "devDependencies": {

types/shelljs/plugin.d.ts

@@ -0,0 +1,3 @@
+// TODO: proper typing
+// https://github.com/shelljs/shelljs/wiki/Using-ShellJS-Plugins#pluginregister-options
+export function register(...args: unknown[]): void;

types/shelljs/shelljs-tests.ts

@@ -148,8 +148,6 @@ shell.chmod("u+x", "/Users/brandon");
 shell.chmod("-cR", 755, "/Users/brandon");
 shell.chmod("-Rv", "u+x", "/Users/brandon");
 
-shell.exit(0);
-
 shell.touch("/Users/brandom/test1");
 shell.touch("/Users/brandom/test1", "/Users/brandom/test2");
 
@@ -206,3 +204,13 @@ const farr = new shell.ShellString(["hello", "world"]);
 
 const boo = shell.ShellString("hello world");
 const barr = shell.ShellString(["hello", "world"]);
+
+require("shelljs/make");
+
+// global works
+cp("some/path", "/tmp/dst/");
+target.all = () => {
+    ln("-sf", "some/path", "/tmp/dst");
+};
+
+shell.exit(0);

types/shelljs/tsconfig.json

@@ -14,6 +14,9 @@
     },
     "files": [
         "index.d.ts",
+        "global.d.ts",
+        "make.d.ts",
+        "plugin.d.ts",
         "shelljs-tests.ts"
     ]
 }