feat: export version

codsen · Apr 10, 2022 · bac85cf · bac85cf
1 parent 6a0c87c
commit bac85cf
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 3 deletions.
diff --git a/packages/bitbucket-slug/README.md b/packages/bitbucket-slug/README.md
@@ -26,12 +26,14 @@
 
 ## Install
 
-The latest version is **ESM only**: Node 12+ is needed to use it and it must be `import`ed instead of `require`d. If your project is not on ESM yet and you want to use `require`, use an older version of this program, `2.1.0`.
+This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required:
 
 ```bash
 npm i bitbucket-slug
 ```
 
+If you need a legacy version which works with `require`, use version 2.1.0
+
 ## Quick Take
 
 ```js

diff --git a/packages/bitbucket-slug/src/main.ts b/packages/bitbucket-slug/src/main.ts
@@ -1,4 +1,7 @@
 import deburr from "lodash.deburr";
+import { version as v } from "../package.json";
+
+const version: string = v;
 
 /**
  * Generate BitBucket readme header anchor slug URLs
@@ -19,4 +22,4 @@ function bSlug(str: string): string {
     .replace(/ /g, "-")}`; // replace spaces with dashes
 }
 
-export { bSlug };
+export { bSlug, version };
diff --git a/packages/bitbucket-slug/types/index.d.ts b/packages/bitbucket-slug/types/index.d.ts
@@ -1,6 +1,7 @@
+declare const version: string;
 /**
  * Generate BitBucket readme header anchor slug URLs
  */
 declare function bSlug(str: string): string;
 
-export { bSlug };
+export { bSlug, version };