Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ESM/CJS double-publishing #28

Merged
merged 8 commits into from
Feb 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions build.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default {
entries: ['./index.js'],
rollup: {
emitCJS: true,
},
failOnWarn: false,
};
35 changes: 35 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/// <reference types="node" />

/**
* These definitions were written by BendingBender (https://github.com/BendingBender)
*/

export = crc32;

declare function crc32(input: string | Buffer, partialCrc?: Buffer | number): Buffer;

declare namespace crc32 {
/**
* Convenience method that returns a signed int instead of a `Buffer`.
*
* @example
* import crc32 = require('buffer-crc32');
*
* // works with buffers
* const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
* crc32.signed(buf); // -> -1805997238
*/
function signed(buffer: string | Buffer, partialCrc?: Buffer | number): number;

/**
* Convenience method that returns an unsigned int instead of a `Buffer`.
*
* @example
* import crc32 = require('buffer-crc32');
*
* // works with buffers
* const buf = Buffer.from([0x00, 0x73, 0x75, 0x70, 0x20, 0x62, 0x72, 0x6f, 0x00]);
* crc32.unsigned(buf); // -> 2488970058
*/
function unsigned(buffer: string | Buffer, partialCrc?: Buffer | number): number;
}
18 changes: 15 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@
"type": "git",
"url": "git://github.com/brianloveswords/buffer-crc32.git"
},
"main": "index.js",
"scripts": {
"test": "tap tests/*.test.js --reporter classic",
"build": "npx [email protected] && npx cpy-cli index.d.ts dist --rename=index.d.cts && npx cpy-cli index.d.ts dist --rename=index.d.mts",
"prepublishOnly": "npm run build",
"format": "prettier --write --log-level warn \"**/*.{json,md,js}\""
},
"type": "commonjs",
Copy link
Collaborator Author

@kibertoad kibertoad Jan 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed explicit type, because it can actually be either ESM or CommonJS, but we can't default it to ESM, because otherwise tests break, as older TAP does not support CJS format, and older Node versions don't support ESM

"dependencies": {},
"devDependencies": {
"prettier": "^3.2.4",
Expand All @@ -36,7 +36,19 @@
"node": ">=8.0.0"
},
"license": "MIT",
"type": "commonjs",
"exports": {
".": {
"import": "./dist/index.mjs",
"require": "./dist/index.cjs"
}
},
"main": "./dist/index.cjs",
"types": "./index.d.ts",
"files": [
"index.js"
"dist",
"index.d.ts",
"LICENSE",
"README.md"
]
}