Adds a way to import danger

Author: orta

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.0.4
+
+- Added TypeScript type declarations for `import { danger } from "danger"`. Opt in by adding `"types": ["risk"]` in your `tsconfig.json`.
+
 ## 0.0.1
 
 It's the initial launch: `danger ci` and `danger pr` are added.

README.md

@@ -29,7 +29,15 @@ if (bigPR) {
 message(`This PR modifies ${danger.git.modified_files.length} file(s).`)
 ```
 
-Existing Dangerfiles that `import { danger } from "danger"` will also work — a built-in ESM loader handles the redirect.
+Existing Dangerfiles that `import { danger } from "danger"` will also work — a built-in ESM loader handles the redirect at runtime. To get TypeScript support for the `"danger"` import, add `"risk"` to the `types` array in your `tsconfig.json`:
+
+```jsonc
+{
+  "compilerOptions": {
+    "types": ["risk"]
+  }
+}
+```
 
 ### Commands
 

danger.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Ambient module declaration that allows `import { danger } from "danger"`
+ * to resolve types when only `risk` is installed.
+ *
+ * At runtime, the ESM loader in danger-loader.ts redirects the import.
+ */
+declare module "danger" {
+  export * from "risk"
+}

index.d.ts

@@ -0,0 +1,2 @@
+/// <reference path="./danger.d.ts" />
+export * from "./dist/index.js"

package.json

@@ -23,15 +23,17 @@
   "type": "module",
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./index.d.ts",
       "import": "./dist/index.js"
     }
   },
   "bin": {
     "danger": "./dist/cli/danger.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "index.d.ts",
+    "danger.d.ts"
   ],
   "packageManager": "yarn@4.12.0",
   "engines": {