Add a "rushx start" script linking to instructions on debugging Rush.

spring6225 · Jan 3, 2022 · de878f4 · de878f4
1 parent 6370e6f
commit de878f4
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/apps/rush/.npmignore b/apps/rush/.npmignore
@@ -28,5 +28,6 @@
 #--------------------------------------------
 
 /lib/start-dev.*
+/lib/start-dev-docs.*
 
 # (Add your project-specific overrides here)
diff --git a/apps/rush/package.json b/apps/rush/package.json
@@ -24,7 +24,8 @@
   "engineStrict": true,
   "homepage": "https://rushjs.io",
   "scripts": {
-    "build": "heft test --clean"
+    "build": "heft test --clean",
+    "start": "node lib/start-dev-docs.js"
   },
   "bin": {
     "rush": "./bin/rush",

diff --git a/apps/rush/src/start-dev-docs.ts b/apps/rush/src/start-dev-docs.ts
@@ -0,0 +1,6 @@
+import { Colors, ConsoleTerminalProvider, Terminal } from '@rushstack/node-core-library';
+
+const terminal: Terminal = new Terminal(new ConsoleTerminalProvider());
+
+terminal.writeLine('For instructions on debugging Rush, please see this documentation:');
+terminal.writeLine(Colors.bold('https://rushjs.io/pages/contributing/debugging/'));