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.

Sign up for GitHub

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

Jump to bottom

feat: migrate to typescript #1567

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

feat: migrate to typescript #1567

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
ccd7706
feat: migrate to typescript
43081j Dec 30, 2023
4beb6f5
fix: use `never` for method args
43081j Dec 31, 2023
7e614bd
feat: make assertion type generic
43081j Dec 31, 2023
5c0e656
feat: add a crazy amount of types
43081j Dec 31, 2023
c8c24a1
feat: strongly typed property assertions
43081j Jan 1, 2024
9b98008
fix: clean up change types
43081j Jan 1, 2024
133e05c
feat: strongly type keys of change assertions
43081j Jan 1, 2024
50ded4d
feat: strong assertions of properties
43081j Jan 1, 2024
e175899
feat: strongly typed typeof hints
43081j Jan 6, 2024
941cbe8
feat: add a few negated assertions
43081j Jan 8, 2024
2e165b2
feat: assert iterable types
43081j Feb 25, 2024
aedefa2
chore: reset package lock
43081j Aug 31, 2024
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ test/auth/*

/chai.js
/chai.cjs
/lib
1 change: 0 additions & 1 deletion index.js
View file
Open in desktop

This file was deleted.

164 changes: 0 additions & 164 deletions lib/chai/assertion.js
View file
Open in desktop

This file was deleted.

55 changes: 0 additions & 55 deletions lib/chai/interface/expect.js
View file
Open in desktop

This file was deleted.

33 changes: 0 additions & 33 deletions lib/chai/utils/flag.js
View file
Open in desktop

This file was deleted.

38 changes: 37 additions & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

20 changes: 15 additions & 5 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
"name": "chai",
"type": "module",
"description": "BDD/TDD assertion library for node.js and the browser. Test framework agnostic.",
"files": [
"lib",
"/chai.js",
"/register-*"
],
"keywords": [
"test",
"assertion",
Expand All @@ -29,14 +34,15 @@
"main": "./chai.js",
"scripts": {
"prebuild": "npm run clean",
"build": "npm run build:esm",
"build:esm": "esbuild --bundle --format=esm --keep-names --outfile=chai.js index.js",
"build": "npm run build:ts && npm run build:esm",
Copy link
Member

Choose a reason for hiding this comment

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

Why are we doing both? Is it to check for type errors? If yes, can we create a "lint:types": "tsc --noEmit" task and run that in the existing lint task?

"build:ts": "tsc",
"build:esm": "esbuild --bundle --format=esm --keep-names --outfile=chai.js src/chai.ts",
"pretest": "npm run lint && npm run build",
"test": "npm run test-node && npm run test-chrome",
"test-node": "mocha --require ./test/bootstrap/index.js --reporter dot test/*.js",
"test-chrome": "web-test-runner --playwright",
"lint": "eslint lib/",
"clean": "rm -f chai.js coverage"
"clean": "rm -rf chai.js coverage lib"
},
"engines": {
"node": ">=12"
Expand All @@ -46,7 +52,10 @@
"check-error": "^2.1.1",
"deep-eql": "^5.0.1",
"loupe": "^3.1.0",
"pathval": "^2.0.0"
"pathval": "^2.0.0",
"@types/check-error": "^1.0.3",
"@types/deep-eql": "^4.0.2",
"@types/pathval": "^1.1.2"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

if you're curious: these are prod dependencies since we export some of them in our public interface. so typescript consumers need to pull these types down too

},
"devDependencies": {
"@rollup/plugin-commonjs": "^25.0.7",
Expand All @@ -56,6 +65,7 @@
"esbuild": "^0.19.10",
"eslint": "^8.56.0",
"eslint-plugin-jsdoc": "^48.0.4",
"mocha": "^10.2.0"
"mocha": "^10.2.0",
"typescript": "^5.3.3"
Copy link
Member

Choose a reason for hiding this comment

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

What do you think about changing this to a tilde since TypeScript doesn't follow semver?

Suggested change
"typescript": "^5.3.3"
"typescript": "~5.3.3"

microsoft/TypeScript#14116

}
}
2 changes: 1 addition & 1 deletion register-assert.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
import {assert} from './index.js';
import {assert} from './lib/chai.js';

globalThis.assert = assert;
Loading