feat: export defaults

codsen · Apr 10, 2022 · 4bc7c0f · 4bc7c0f
1 parent ac9dac8
commit 4bc7c0f
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/packages/lerna-clean-changelogs/README.md b/packages/lerna-clean-changelogs/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 lerna-clean-changelogs
 ```
 
+If you need a legacy version which works with `require`, use version 2.1.0
+
 ## Quick Take
 
 ```js

diff --git a/packages/lerna-clean-changelogs/src/main.ts b/packages/lerna-clean-changelogs/src/main.ts
@@ -175,4 +175,4 @@ function cleanChangelogs(
   };
 }
 
-export { cleanChangelogs, version };
+export { cleanChangelogs, defaults, version };
diff --git a/packages/lerna-clean-changelogs/types/index.d.ts b/packages/lerna-clean-changelogs/types/index.d.ts
@@ -2,6 +2,7 @@ declare const version: string;
 interface Opts {
   extras: boolean;
 }
+declare const defaults: Opts;
 declare function cleanChangelogs(
   changelogContents: string,
   originalOpts?: Partial<Opts>
@@ -10,4 +11,4 @@ declare function cleanChangelogs(
   res: string;
 };
 
-export { cleanChangelogs, version };
+export { cleanChangelogs, defaults, version };