feat: annotations

oclif · May 9, 2018 · 343fc79 · 343fc79
1 parent b305f41
commit 343fc79
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -68,3 +68,14 @@ cli.action.stop('custom message') // shows 'starting a process... custom message
 This degrades gracefully when not connected to a TTY. It queues up any writes to stdout/stderr so they are displayed above the spinner.
 
 ![action demo](assets/action.gif)
+
+# annotation
+
+Shows an iterm annotation
+
+```typescript
+// start the spinner
+cli.annotation('sometest', 'annotated with this text')
+```
+
+![annotation demo](assets/annotation.png)
diff --git a/assets/annotation.png b/assets/annotation.png
diff --git a/examples/annotation.ts b/examples/annotation.ts
@@ -0,0 +1,3 @@
+import ux from '../src'
+
+ux.annotation('sometext', 'annotated with this text')
diff --git a/src/index.ts b/src/index.ts
@@ -56,7 +56,17 @@ export const cli = {
     } else {
       this.log(uri)
     }
-  }
+  },
+
+  annotation(text: string, annotation: string) {
+    const supports = require('supports-hyperlinks')
+    if (supports.stdout) {
+      //\u001b]8;;https://google.com\u0007sometext\u001b]8;;\u0007
+      this.log(`\u001b]1337;AddAnnotation=${text.length}|${annotation}\u0007${text}`)
+    } else {
+      this.log(text)
+    }
+  },
 }
 export default cli
 

diff --git a/tsconfig.json b/tsconfig.json
@@ -4,8 +4,6 @@
     "forceConsistentCasingInFileNames": true,
     "importHelpers": true,
     "module": "commonjs",
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
     "outDir": "./lib",
     "pretty": true,
     "rootDirs": [
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		import ux from '../src'

		ux.annotation('sometext', 'annotated with this text')