Merge pull request #2065 from NullVoxPopuli/type-tests

v3: Maximize compatibility

packages/qunit-dom/lib/assertions.ts

@@ -1,17 +1,17 @@
-import exists from './assertions/exists';
-import focused from './assertions/focused';
-import notFocused from './assertions/not-focused';
-import isChecked from './assertions/is-checked';
-import isNotChecked from './assertions/is-not-checked';
-import isRequired from './assertions/is-required';
-import isNotRequired from './assertions/is-not-required';
-import isValid from './assertions/is-valid';
-import isVisible from './assertions/is-visible';
-import isDisabled from './assertions/is-disabled';
-import matchesSelector from './assertions/matches-selector';
-import elementToString from './helpers/element-to-string';
-import collapseWhitespace from './helpers/collapse-whitespace';
-import { toArray } from './helpers/node-list';
+import exists from './assertions/exists.js';
+import focused from './assertions/focused.js';
+import notFocused from './assertions/not-focused.js';
+import isChecked from './assertions/is-checked.js';
+import isNotChecked from './assertions/is-not-checked.js';
+import isRequired from './assertions/is-required.js';
+import isNotRequired from './assertions/is-not-required.js';
+import isValid from './assertions/is-valid.js';
+import isVisible from './assertions/is-visible.js';
+import isDisabled from './assertions/is-disabled.js';
+import matchesSelector from './assertions/matches-selector.js';
+import elementToString from './helpers/element-to-string.js';
+import collapseWhitespace from './helpers/collapse-whitespace.js';
+import { toArray } from './helpers/node-list.js';
 
 export interface AssertionResult {
   result: boolean;

packages/qunit-dom/lib/assertions/exists.ts

@@ -1,4 +1,4 @@
-import { ExistsOptions } from '../assertions';
+import type { ExistsOptions } from '../assertions.js';
 
 export default function exists(options?: ExistsOptions | string, message?: string) {
   let expectedCount: number | null = null;

packages/qunit-dom/lib/assertions/focused.ts

@@ -1,4 +1,4 @@
-import elementToString from '../helpers/element-to-string';
+import elementToString from '../helpers/element-to-string.js';
 
 export default function focused(message?: string) {
   let element = this.findTargetElement();

packages/qunit-dom/lib/assertions/is-checked.ts

@@ -1,4 +1,4 @@
-import elementToString from '../helpers/element-to-string';
+import elementToString from '../helpers/element-to-string.js';
 
 export default function checked(message?: string) {
   let element = this.findTargetElement();

packages/qunit-dom/lib/assertions/is-not-checked.ts

@@ -1,4 +1,4 @@
-import elementToString from '../helpers/element-to-string';
+import elementToString from '../helpers/element-to-string.js';
 
 export default function notChecked(message?: string) {
   let element = this.findTargetElement();

packages/qunit-dom/lib/assertions/is-not-required.ts

@@ -1,4 +1,4 @@
-import elementToString from '../helpers/element-to-string';
+import elementToString from '../helpers/element-to-string.js';
 
 export default function notRequired(message?: string) {
   let element = this.findTargetElement();

packages/qunit-dom/lib/assertions/is-required.ts

@@ -1,4 +1,4 @@
-import elementToString from '../helpers/element-to-string';
+import elementToString from '../helpers/element-to-string.js';
 
 export default function required(message?: string) {
   let element = this.findTargetElement();

packages/qunit-dom/lib/assertions/is-valid.ts

@@ -1,4 +1,4 @@
-import elementToString from '../helpers/element-to-string';
+import elementToString from '../helpers/element-to-string.js';
 
 export default function isValid(message?: string, options: { inverted?: boolean } = {}) {
   let element = this.findTargetElement();

packages/qunit-dom/lib/assertions/is-visible.ts

@@ -1,5 +1,5 @@
-import visible from '../helpers/visible';
-import { ExistsOptions } from '../assertions';
+import visible from '../helpers/visible.js';
+import type { ExistsOptions } from '../assertions.js';
 
 export default function isVisible(options?: string | ExistsOptions, message?: string) {
   let expectedCount: number | null = null;

packages/qunit-dom/lib/helpers/test-assertions.ts

@@ -1,4 +1,4 @@
-import DOMAssertions, { AssertionResult } from '../assertions';
+import DOMAssertions, { type AssertionResult } from '../assertions.js';
 
 export default class TestAssertions {
   public results: AssertionResult[] = [];

packages/qunit-dom/lib/install.ts

@@ -1,5 +1,5 @@
-import DOMAssertions from './assertions';
-import { getRootElement } from './root-element';
+import DOMAssertions from './assertions.js';
+import { getRootElement } from './root-element.js';
 
 declare global {
   interface Assert {

packages/qunit-dom/lib/qunit-dom-modules.ts

@@ -1,7 +1,7 @@
-import install from './install';
-import { overrideRootElement } from './root-element';
+import install from './install.js';
+import { overrideRootElement } from './root-element.js';
 
-export { default as install } from './install';
+export { default as install } from './install.js';
 
 interface SetupOptions {
   getRootElement?: () => Element | null;

packages/qunit-dom/lib/qunit-dom.ts

@@ -1,6 +1,6 @@
 /* global QUnit */
-import install from './install';
+import install from './install.js';
 
-export { setup } from './qunit-dom-modules';
+export { setup } from './qunit-dom-modules.js';
 
 install(QUnit.assert);

packages/qunit-dom/package.json

@@ -20,11 +20,6 @@
       "default": "./dist/es/index.js"
     }
   },
-  "typesVersions": {
-    "*": {
-      "*": "dist/es/qunit-dom.d.ts"
-    }
-  },
   "types": "dist/es/qunit-dom.d.ts",
   "files": [
     "dist"
@@ -35,7 +30,7 @@
     "lint": "concurrently 'npm:lint:*(!fix)' --names 'lint:'",
     "lint:fix": "concurrently 'npm:lint:*:fix' --names 'fix:'",
     "lint:package": "publint",
-    "lint:published-types": "attw --pack --ignore-rules no-resolution cjs-resolves-to-esm internal-resolution-error",
+    "lint:published-types": "attw --pack --ignore-rules cjs-resolves-to-esm internal-resolution-error",
     "lint:js": "eslint . --cache",
     "lint::js:fix": "eslint . --fix",
     "prepublish": "rollup -c",

packages/qunit-dom/tsconfig.json

@@ -2,6 +2,16 @@
   "compilerOptions": {
     "noImplicitAny": true,
     "declaration": true,
+    // Forces import type when imports are only used as types.
+    "verbatimModuleSyntax": true,
+    // We build to ESM, so we need to tell TS that we build to ESM
+    // otherwise TS uses fake ESM (you use imports, but it assumes the compilation is to CJS)
+    // These are also required when using 
+    // verbatimModuleSyntax, because it's an 
+    // ESM-only feature
+    "target": "esnext",
+    "module": "esnext",
+
     "lib": [
       "ES6",
       "DOM"

packages/test-types-resolution-node/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "type-tests-resolution-node",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "start": "tsc --noEmit --watch",
+    "test": "echo 'run pnpm lint' instead"
+  },
+  "devDependencies": {
+    "@types/qunit": "2.19.6",
+    "expect-type": "^0.17.3",
+    "typescript": "5.2.2"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "dependencies": {
+    "qunit": "^2.20.0",
+    "qunit-dom": "workspace:*"
+  }
+}

packages/test-types-resolution-node/test.ts

@@ -0,0 +1,10 @@
+import QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import { expectTypeOf } from 'expect-type'
+
+setup(QUnit.assert);
+
+expectTypeOf(QUnit.assert.dom).parameter(0).toEqualTypeOf<string | Element | null | undefined>();
+// @ts-expect-error - there is only one parameter
+expectTypeOf(QUnit.assert.dom).parameter(1).toEqualTypeOf<never>();
+

packages/test-types-resolution-node/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    // Settings needed for test
+    "target": "esnext",
+    // using qunit-dom with node would require jsdom or happydom
+    // but these use cases are currently untested.
+    // But some older packagers set up TS this way because they 
+    // haven't moved to the newer "bundler" resolution mode yet.
+    "module": "esnext",
+    "moduleResolution": "node",
+    "allowSyntheticDefaultImports": true,
+
+    /////////////////////////
+    // Settings to help us type check effectively.
+    // Unrelated to the above.
+
+    // Strictness settings (one day default?)
+    "strict": true,
+
+    // Don't implicitly pull in declarations from `@types` packages unless we
+    // actually import from them AND the package in question doesn't bring its
+    // own types. 
+    "types": []
+  }
+}

packages/test-types-resolution-node16/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "type-tests-resolution-node16",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "start": "tsc --noEmit --watch",
+    "test": "echo 'run pnpm lint' instead"
+  },
+  "devDependencies": {
+    "@types/qunit": "2.19.6",
+    "expect-type": "^0.17.3",
+    "typescript": "5.2.2"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "dependencies": {
+    "qunit": "^2.20.0",
+    "qunit-dom": "workspace:*"
+  }
+}

packages/test-types-resolution-node16/test.ts

@@ -0,0 +1,10 @@
+import QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import { expectTypeOf } from 'expect-type'
+
+setup(QUnit.assert);
+
+expectTypeOf(QUnit.assert.dom).parameter(0).toEqualTypeOf<string | Element | null | undefined>();
+// @ts-expect-error - there is only one parameter
+expectTypeOf(QUnit.assert.dom).parameter(1).toEqualTypeOf<never>();
+

packages/test-types-resolution-node16/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    // Settings needed for test
+    "target": "esnext",
+    // using qunit-dom with node would require jsdom or happydom
+    // but these use cases are currently untested.
+    // Node16+ requires file extensions
+    "module": "Node16",
+    "moduleResolution": "node16",
+
+    /////////////////////////
+    // Settings to help us type check effectively.
+    // Unrelated to the above.
+
+    // Strictness settings (one day default?)
+    "strict": true,
+
+    // Don't implicitly pull in declarations from `@types` packages unless we
+    // actually import from them AND the package in question doesn't bring its
+    // own types. 
+    "types": []
+  }
+}

packages/test-types/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "type-tests",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "lint": "tsc --noEmit",
+    "start": "tsc --noEmit --watch",
+    "test": "echo 'run pnpm lint' instead"
+  },
+  "devDependencies": {
+    "@types/qunit": "2.19.6",
+    "expect-type": "^0.17.3",
+    "typescript": "5.2.2"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  },
+  "dependencies": {
+    "qunit": "^2.20.0",
+    "qunit-dom": "workspace:*"
+  }
+}

packages/test-types/test.ts

@@ -0,0 +1,10 @@
+import QUnit from 'qunit';
+import { setup } from 'qunit-dom';
+import { expectTypeOf } from 'expect-type'
+
+setup(QUnit.assert);
+
+expectTypeOf(QUnit.assert.dom).parameter(0).toEqualTypeOf<string | Element | null | undefined>();
+// @ts-expect-error - there is only one parameter
+expectTypeOf(QUnit.assert.dom).parameter(1).toEqualTypeOf<never>();
+

packages/test-types/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    // Settings needed for test
+    "target": "esnext",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+
+    /////////////////////////
+    // Settings to help us type check effectively.
+    // Unrelated to the above.
+
+    // Strictness settings (one day default?)
+    "strict": true,
+
+    // Don't implicitly pull in declarations from `@types` packages unless we
+    // actually import from them AND the package in question doesn't bring its
+    // own types. 
+    "types": []
+  }
+}