Skip to content

Commit c68d3ac

Browse files
committed
chore: add note explaining module choice to CommonJS export
1 parent c185ce3 commit c68d3ac

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/index.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ import {plugin} from './plugin.js';
33
/**
44
* Export single object, according to the CommonJS model. The CommonJS module is
55
* explicitly used here as that's the kind of module commitlint requires for
6-
* plugins.
6+
* shareable configurations. This project is an ES module for ease of
7+
* development, and thus requires the error for an export assignment to be
8+
* disabled.
79
*/
8-
// @ts-expect-error TS1203 Export assignment cannot be used when targeting
9-
// ECMAScript modules. Consider using 'export default' or another module format
10-
// instead.
10+
// @ts-expect-error TS1203
1111
export = plugin;

0 commit comments

Comments
 (0)