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

Enable better ESM compatibility #45

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
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
10 changes: 9 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,12 @@ node_modules
.DS_Store
coverage
.rpt2_cache
dist
.idea
.yarn

/dist/*.js
/dist/**/*.js
/dist/*.ts
/dist/**/*.ts
/dist/*.map
/dist/**/*.map
3 changes: 3 additions & 0 deletions benchmark/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"type": "commonjs"
}
3 changes: 3 additions & 0 deletions dist/umd/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"type": "commonjs"
}
7 changes: 4 additions & 3 deletions jest.config.js → jest.config.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,11 @@ module.exports = {
globals: {
"ts-jest": {
tsConfig: {
target: "es3",
module: "commonjs",
rootDir: "./src"
}
}
}
},
testMatch: [
'<rootDir>/tests/**/*.[jt]s?(x)',
],
};
59 changes: 35 additions & 24 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,45 +13,56 @@
"bugs": "https://github.com/ckknight/random-js/issues",
"license": "MIT",
"repository": "git://github.com/ckknight/random-js",
"main": "dist/random-js.umd.js",
"module": "dist/random-js.esm.js",
"unpkg": "dist/random-js.umd.min.js",
"types": "dist/index.d.ts",
"main": "./dist/umd/random-js.js",
"module": "./dist/esm/random-js.js",
"unpkg": "./dist/umd/random-js.min.js",
"types": "./dist/esm/index.d.ts",
"files": [
"dist"
],
"readmeFilename": "README.md",
"devDependencies": {
"@types/jest": "^24.0.5",
"@types/node": "^11.9.4",
"@rollup/plugin-terser": "^0.4.3",
"@rollup/plugin-typescript": "^11.1.1",
"@types/jest": "^29.5.2",
"@types/node": "^20.3.1",
"benchmark": "^2.1.4",
"jest": "^24.1.0",
"prettier": "^1.16.4",
"rimraf": "^2.6.3",
"rollup": "^1.2.1",
"rollup-plugin-typescript": "^1.0.0",
"rollup-plugin-typescript2": "^0.19.2",
"terser": "^3.16.1",
"ts-jest": "^23.10.5",
"tslint": "^5.12.1",
"jest": "^29.5.0",
"prettier": "^2.8.8",
"rimraf": "^5.0.1",
"rollup": "^3.25.1",
"ts-jest": "^29.1.0",
"tslib": "^2.5.3",
"tslint": "^6.1.3",
"tslint-config-prettier": "^1.18.0",
"typescript": "^3.3.3"
"typescript": "^5.1.3"
},
"scripts": {
"clean": "rimraf dist",
"build:umd": "rollup -c rollup.config.es3.js --format umd -o dist/random-js.umd.js --name Random -m",
"build:esm": "rollup -c rollup.config.js --format esm --sourcemap true -o dist/random-js.esm.js",
"clean": "rimraf dist/**/*.js dist/**/*.ts dist/**/*.map",
"build:umd": "rollup --c --environment BUILD:prod",
"build:dev": "rollup --c --environment BUILD:dev",
"prebuild": "yarn clean",
"build": "yarn build:umd && yarn build:esm",
"minify": "terser --source-map content=dist/random-js.umd.js.map --compress --mangle --output dist/random-js.umd.min.js dist/random-js.umd.js",
"postbuild": "yarn minify",
"benchmark": "for k in benchmark/*.js; do node $k; done",
"build": "yarn build:dev && yarn build:prod",
"watch": "yarn build:dev -- -w",
"benchmark": "for k in benchmark/*.cjs; do node $k; done",
"test": "jest",
"lint": "tslint --project .",
"prepublish": "yarn clean && yarn lint && yarn test && yarn build"
},
"testling": {
"files": "spec/*.js"
},
"sideEffects": false
"sideEffects": false,
"type": "module",
"exports": {
".": {
"import": "./dist/esm/random-js.js",
"require": "./dist/umd/random-js.js"
},
"./dist": "./dist",
"./package.json": "./package.json"
},
"engines": {
"node": ">=18.0"
}
}
8 changes: 5 additions & 3 deletions rollup.config.es3.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
import typescript from "rollup-plugin-typescript2";
import typescript from 'rollup-plugin-typescript2';

const inputPath = './src/index.ts';

export default {
input: "./src/index.ts",
input: inputPath,
plugins: [
typescript({
tsconfigOverride: {
Expand All @@ -10,7 +12,7 @@ export default {
declaration: false,
declarationMap: false
},
exclude: ["dist/**", "src/**/*.test.ts"]
exclude: ["dist/**", "**/*.test.ts"]
}
})
]
Expand Down
47 changes: 36 additions & 11 deletions rollup.config.js
Original file line number Diff line number Diff line change
@@ -1,12 +1,37 @@
import typescript from "rollup-plugin-typescript2";
import typescript from "@rollup/plugin-typescript";
import terser from '@rollup/plugin-terser';

export default {
input: "./src/index.ts",
plugins: [
typescript({
tsconfigOverride: {
exclude: ["dist/**", "src/**/*.test.ts"]
}
})
]
};
const production = !process.env.BUILD || (process.env.BUILD === 'prod');
const inputPath = './src/index.ts';
const outputPath = (format, minify = false) => `dist/${format}/random-js${minify ? '.min' : ''}.js`;
const packageName = 'Random';

const plugins = (isProduction = false) => [
typescript(),
// minify for production
//isProduction ? terser({ keep_classnames: true }) : null,
];

export default [
// ESM
{
input: inputPath,
output: {
file: outputPath('esm', production),
format: 'esm',
sourcemap: true,
},
plugins: plugins(production),
},
// UMD
{
input: inputPath,
output: {
file: outputPath('umd', production),
format: 'umd',
name: packageName,
sourcemap: true,
},
plugins: plugins(production),
},
];
88 changes: 44 additions & 44 deletions src/Random.test.ts → tests/Random.test.ts
Original file line number Diff line number Diff line change
@@ -1,47 +1,47 @@
import { bool } from "./distribution/bool";
import { date } from "./distribution/date";
import { dice } from "./distribution/dice";
import { die } from "./distribution/die";
import { hex } from "./distribution/hex";
import { int32 } from "./distribution/int32";
import { int53 } from "./distribution/int53";
import { int53Full } from "./distribution/int53Full";
import { integer } from "./distribution/integer";
import { pick } from "./distribution/pick";
import { real } from "./distribution/real";
import { realZeroToOneExclusive } from "./distribution/realZeroToOneExclusive";
import { realZeroToOneInclusive } from "./distribution/realZeroToOneInclusive";
import { sample } from "./distribution/sample";
import { shuffle } from "./distribution/shuffle";
import { string } from "./distribution/string";
import { uint32 } from "./distribution/uint32";
import { uint53 } from "./distribution/uint53";
import { uint53Full } from "./distribution/uint53Full";
import { uuid4 } from "./distribution/uuid4";
import { nativeMath } from "./engine/nativeMath";
import { Random } from "./Random";
import { Distribution, Engine } from "./types";

jest.mock("./distribution/integer");
jest.mock("./distribution/real");
jest.mock("./distribution/bool");
jest.mock("./distribution/pick");
jest.mock("./distribution/shuffle");
jest.mock("./distribution/sample");
jest.mock("./distribution/die");
jest.mock("./distribution/dice");
jest.mock("./distribution/uuid4");
jest.mock("./distribution/string");
jest.mock("./distribution/hex");
jest.mock("./distribution/date");
jest.mock("./distribution/int32");
jest.mock("./distribution/int53");
jest.mock("./distribution/int53Full");
jest.mock("./distribution/realZeroToOneExclusive");
jest.mock("./distribution/realZeroToOneInclusive");
jest.mock("./distribution/uint32");
jest.mock("./distribution/uint53");
jest.mock("./distribution/uint53Full");
import { bool } from "../src/distribution/bool";
import { date } from "../src/distribution/date";
import { dice } from "../src/distribution/dice";
import { die } from "../src/distribution/die";
import { hex } from "../src/distribution/hex";
import { int32 } from "../src/distribution/int32";
import { int53 } from "../src/distribution/int53";
import { int53Full } from "../src/distribution/int53Full";
import { integer } from "../src/distribution/integer";
import { pick } from "../src/distribution/pick";
import { real } from "../src/distribution/real";
import { realZeroToOneExclusive } from "../src/distribution/realZeroToOneExclusive";
import { realZeroToOneInclusive } from "../src/distribution/realZeroToOneInclusive";
import { sample } from "../src/distribution/sample";
import { shuffle } from "../src/distribution/shuffle";
import { string } from "../src/distribution/string";
import { uint32 } from "../src/distribution/uint32";
import { uint53 } from "../src/distribution/uint53";
import { uint53Full } from "../src/distribution/uint53Full";
import { uuid4 } from "../src/distribution/uuid4";
import { nativeMath } from "../src/engine/nativeMath";
import { Random } from "../src/Random";
import { Distribution, Engine } from "../src/types";

jest.mock("../src/distribution/integer");
jest.mock("../src/distribution/real");
jest.mock("../src/distribution/bool");
jest.mock("../src/distribution/pick");
jest.mock("../src/distribution/shuffle");
jest.mock("../src/distribution/sample");
jest.mock("../src/distribution/die");
jest.mock("../src/distribution/dice");
jest.mock("../src/distribution/uuid4");
jest.mock("../src/distribution/string");
jest.mock("../src/distribution/hex");
jest.mock("../src/distribution/date");
jest.mock("../src/distribution/int32");
jest.mock("../src/distribution/int53");
jest.mock("../src/distribution/int53Full");
jest.mock("../src/distribution/realZeroToOneExclusive");
jest.mock("../src/distribution/realZeroToOneInclusive");
jest.mock("../src/distribution/uint32");
jest.mock("../src/distribution/uint53");
jest.mock("../src/distribution/uint53Full");

describe("Random", () => {
describe("constructor", () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
import { bool } from "./bool";
import { int32 } from "./int32";
import { integer } from "./integer";
import { uint53 } from "./uint53";

jest.mock("./int32");
jest.mock("./uint53");
jest.mock("./integer");
import { bool } from "../../src/distribution/bool";
import { int32 } from "../../src/distribution/int32";
import { integer } from "../../src/distribution/integer";
import { uint53 } from "../../src/distribution/uint53";

jest.mock("../../src/distribution/int32");
jest.mock("../../src/distribution/uint53");
jest.mock("../../src/distribution/integer");

describe("bool distribution", () => {
describe("when passed no arguments", () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { date } from "./date";
import { integer } from "./integer";
import { date } from "../../src/distribution/date";
import { integer } from "../../src/distribution/integer";

jest.mock("./integer");
jest.mock("../../src/distribution/integer");

describe("date distribution", () => {
it("returns a wrapped integer distribution from start time to end time", () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { dice } from "./dice";
import { die } from "./die";
import { dice } from "../../src/distribution/dice";
import { die } from "../../src/distribution/die";

jest.mock("./die");
jest.mock("../../src/distribution/die");

describe("dice", () => {
function makeReturner<T>(input: ReadonlyArray<T>): () => T {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { die } from "./die";
import { integer } from "./integer";
import { die } from "../../src/distribution/die";
import { integer } from "../../src/distribution/integer";

jest.mock("./integer");
jest.mock("../../src/distribution/integer");

describe("die", () => {
it("returns an integer distribution from 1 to sideCount", () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { nativeMath } from "../engine/nativeMath";
import { hex } from "./hex";
import { nativeMath } from "../../src/engine/nativeMath";
import { hex } from "../../src/distribution/hex";

describe("hex", () => {
const owns = Object.prototype.hasOwnProperty;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import { MersenneTwister19937 } from "../engine/MersenneTwister19937";
import { Distribution, Engine } from "../types";
import { int32 } from "./int32";
import { int53 } from "./int53";
import { int53Full } from "./int53Full";
import { integer } from "./integer";
import { uint32 } from "./uint32";
import { uint53 } from "./uint53";
import { uint53Full } from "./uint53Full";
import { MersenneTwister19937 } from "../../src/engine/MersenneTwister19937";
import { Distribution, Engine } from "../../src/types";
import { int32 } from "../../src/distribution/int32";
import { int53 } from "../../src/distribution/int53";
import { int53Full } from "../../src/distribution/int53Full";
import { integer } from "../../src/distribution/integer";
import { uint32 } from "../../src/distribution/uint32";
import { uint53 } from "../../src/distribution/uint53";
import { uint53Full } from "../../src/distribution/uint53Full";

describe("integer distribution", () => {
[-Math.pow(2, 53) - 2, -Infinity, NaN, Infinity].forEach(min => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { integer } from "./integer";
import { pick } from "./pick";
import { integer } from "../../src/distribution/integer";
import { pick } from "../../src/distribution/pick";

jest.mock("./integer");
jest.mock("../../src/distribution/integer");

describe("pick", () => {
describe("with an empty array", () => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
// import { integer } from "./integer";
import { integer } from "./integer";
import { picker } from "./picker";
import { integer } from "../../src/distribution/integer";
import { picker } from "../../src/distribution/picker";

jest.mock("./integer");
jest.mock("../../src/distribution/integer");

describe("picker", () => {
it("throws when passed an empty array", () => {
Expand Down
Loading