test: enable typecheck for _config files (#4954)

* chore: init

* chore: basic

* chore: revert vscode config

* chore: fix syntax error

* chore: improve typecheck

* feat: different types based on dirs

* chore: update

* chore: update

* fix: fix some type error

* chore: disable check js for now

* chore: update

* chore: update

* chore: fix emission issue in WebStorm

* Fix some type issues

* Use correct properties per test type

---------

Co-authored-by: Lukas Taegert-Atkinson <[email protected]>

Author: antfu

.eslintrc.js

@@ -66,6 +66,12 @@ module.exports = {
 				'no-undef': 'off',
 				'unicorn/prevent-abbreviations': 'off'
 			}
+		},
+		{
+			files: ['test/**/_config.js'],
+			rules: {
+				'no-undef': 'off'
+			}
 		}
 	],
 	parser: '@typescript-eslint/parser',

.gitignore

@@ -18,3 +18,4 @@ perf/
 .github_token
 .temp
 docs/.vitepress/graphs
+*.tsbuildinfo

.vscode/settings.json

@@ -4,5 +4,7 @@
   "typescript.format.enable": true,
   "editor.codeActionsOnSave": {
     "source.fixAll.eslint": true
-  }
+  },
+  "references.preferredLocation": "peek",
+  "vue.features.codeActions.enable": false
 }

package-lock.json

@@ -81,6 +81,7 @@
     "@rollup/plugin-typescript": "^11.1.0",
     "@rollup/pluginutils": "^5.0.2",
     "@types/estree": "1.0.1",
+    "@types/mocha": "^10.0.1",
     "@types/node": "^14.18.42",
     "@types/yargs-parser": "^21.0.0",
     "@typescript-eslint/eslint-plugin": "^5.59.1",

package.json

@@ -519,7 +519,7 @@ export type InputPluginOption = MaybePromise<Plugin | NullValue | false | InputP
 
 export interface InputOptions {
 	acorn?: Record<string, unknown>;
-	acornInjectPlugins?: (() => unknown)[] | (() => unknown);
+	acornInjectPlugins?: ((...arguments_: any[]) => unknown)[] | ((...arguments_: any[]) => unknown);
 	cache?: boolean | RollupCache;
 	context?: string;
 	experimentalCacheExpiry?: number;

src/rollup/types.d.ts

@@ -0,0 +1,5 @@
+import type { TestConfigBrowser } from '../types';
+
+declare global {
+	function defineTest(config: TestConfigBrowser): TestConfigBrowser;
+}

test/browser/define.d.ts

@@ -1,67 +1,80 @@
 // since we don't run the browser tests in an actual browser, we need to make `performance`
 // globally accessible same as in the browser. this can be removed once `performance` is
 // available globally in all supported platforms. [currently global for node.js v16+].
+// @ts-expect-error ignore
 global.performance = require('node:perf_hooks').performance;
 
 const { basename, resolve } = require('node:path');
 const fixturify = require('fixturify');
+
+/**
+ * @type {import('../../src/rollup/types')} Rollup
+ */
 const { rollup } = require('../../browser/dist/rollup.browser.js');
 const { assertFilesAreEqual, runTestSuiteWithSamples, compareError } = require('../utils.js');
 
-runTestSuiteWithSamples('browser', resolve(__dirname, 'samples'), (directory, config) => {
-	(config.skip ? it.skip : config.solo ? it.only : it)(
-		basename(directory) + ': ' + config.description,
-		async () => {
-			let bundle;
-			try {
-				bundle = await rollup({
-					input: 'main',
-					onwarn: warning => {
-						if (!(config.expectedWarnings && config.expectedWarnings.includes(warning.code))) {
-							throw new Error(
-								`Unexpected warnings (${warning.code}): ${warning.message}\n` +
-									'If you expect warnings, list their codes in config.expectedWarnings'
-							);
-						}
-					},
-					strictDeprecations: true,
-					...config.options
-				});
-			} catch (error) {
+runTestSuiteWithSamples(
+	'browser',
+	resolve(__dirname, 'samples'),
+	/**
+	 * @param {import('../types').TestConfigBrowser} config
+	 */
+	(directory, config) => {
+		(config.skip ? it.skip : config.solo ? it.only : it)(
+			basename(directory) + ': ' + config.description,
+			async () => {
+				let bundle;
+				try {
+					bundle = await rollup({
+						input: 'main',
+						onwarn: warning => {
+							if (!(config.expectedWarnings && config.expectedWarnings.includes(warning.code))) {
+								throw new Error(
+									`Unexpected warnings (${warning.code}): ${warning.message}\n` +
+										'If you expect warnings, list their codes in config.expectedWarnings'
+								);
+							}
+						},
+						strictDeprecations: true,
+						...config.options
+					});
+				} catch (error) {
+					if (config.error) {
+						compareError(error, config.error);
+						return;
+					} else {
+						throw error;
+					}
+				}
 				if (config.error) {
-					compareError(error, config.error);
-					return;
-				} else {
-					throw error;
+					throw new Error('Expected an error while rolling up');
+				}
+				let output;
+				try {
+					({ output } = await bundle.generate({
+						exports: 'auto',
+						format: 'es',
+						...(config.options || {}).output
+					}));
+				} catch (error) {
+					if (config.generateError) {
+						compareError(error, config.generateError);
+						return;
+					} else {
+						throw error;
+					}
 				}
-			}
-			if (config.error) {
-				throw new Error('Expected an error while rolling up');
-			}
-			let output;
-			try {
-				({ output } = await bundle.generate({
-					exports: 'auto',
-					format: 'es',
-					...(config.options || {}).output
-				}));
-			} catch (error) {
 				if (config.generateError) {
-					compareError(error, config.generateError);
-					return;
-				} else {
-					throw error;
+					throw new Error('Expected an error while generating output');
 				}
+				assertOutputMatches(output, directory);
 			}
-			if (config.generateError) {
-				throw new Error('Expected an error while generating output');
-			}
-			assertOutputMatches(output, directory);
-		}
-	);
-});
+		);
+	}
+);
 
 function assertOutputMatches(output, directory) {
+	/** @type any */
 	const actual = {};
 	for (const file of output) {
 		const filePath = file.fileName.split('/');

test/browser/index.js

@@ -1,6 +1,6 @@
 const { loader } = require('../../../utils.js');
 
-module.exports = {
+module.exports = defineTest({
 	description: 'bundles files for the browser',
 	options: {
 		plugins: loader({
@@ -9,4 +9,4 @@ console.log(foo);`,
 			dep: `export const foo = 42;`
 		})
 	}
-};
+});

test/browser/samples/basic/_config.js

@@ -1,6 +1,6 @@
 const { loader } = require('../../../utils.js');
 
-module.exports = {
+module.exports = defineTest({
 	description: 'fails if a dependency cannot be resolved',
 	options: {
 		plugins: loader({
@@ -15,4 +15,4 @@ console.log(foo);`
 		url: 'https://rollupjs.org/plugin-development/#a-simple-example',
 		watchFiles: ['main']
 	}
-};
+});

test/browser/samples/missing-dependency-resolution/_config.js

@@ -1,9 +1,9 @@
-module.exports = {
+module.exports = defineTest({
 	description: 'fails if an entry cannot be resolved',
 	error: {
 		code: 'NO_FS_IN_BROWSER',
 		message:
 			'Cannot access the file system (via "path.resolve") when using the browser build of Rollup. Make sure you supply a plugin with custom resolveId and load hooks to Rollup.',
 		url: 'https://rollupjs.org/plugin-development/#a-simple-example'
 	}
-};
+});

test/browser/samples/missing-entry-resolution/_config.js

@@ -1,7 +1,8 @@
-module.exports = {
+module.exports = defineTest({
 	description: 'fails if a file cannot be loaded',
 	options: {
 		plugins: {
+			name: 'test',
 			resolveId(source) {
 				return source;
 			}
@@ -14,4 +15,4 @@ module.exports = {
 		url: 'https://rollupjs.org/plugin-development/#a-simple-example',
 		watchFiles: ['main']
 	}
-};
+});

test/browser/samples/missing-load/_config.js

@@ -1,13 +1,14 @@
 const { join, dirname } = require('node:path').posix;
 
-module.exports = {
+module.exports = defineTest({
 	description: 'renormalizes external paths if possible',
 	options: {
 		input: ['/main.js', '/nested/entry.js'],
 		external(id) {
 			return id.endsWith('ext');
 		},
 		plugins: {
+			name: 'test-plugin',
 			resolveId(source, importer) {
 				if (source.endsWith('ext.js')) {
 					return false;
@@ -44,4 +45,4 @@ import './nested-ext.js';`;
 			}
 		}
 	}
-};
+});

test/browser/samples/renormalizes-external-paths/_config.js

@@ -1,6 +1,6 @@
 const { loader } = require('../../../utils.js');
 
-module.exports = {
+module.exports = defineTest({
 	description: 'bundles files for the browser',
 	options: {
 		input: ['main', 'dep'],
@@ -13,4 +13,4 @@ console.log(foo);`,
 			entryFileNames: '[name]-[hash].js'
 		}
 	}
-};
+});

test/browser/samples/supports-hashes/_config.js

@@ -0,0 +1,8 @@
+{
+  "extends": "../tsconfig.base.json",
+  "include": [
+    "**/_config.js",
+    "./index.js",
+    "./define.d.ts"
+  ]
+}

test/browser/tsconfig.json

@@ -0,0 +1,5 @@
+import type { TestConfigChunkingForm } from '../types';
+
+declare global {
+	function defineTest(config: TestConfigChunkingForm): TestConfigChunkingForm;
+}

test/chunking-form/define.d.ts

@@ -1,5 +1,8 @@
 const { basename, resolve } = require('node:path');
 const { chdir } = require('node:process');
+/**
+ * @type {import('../../src/rollup/types')} Rollup
+ */
 const { rollup } = require('../../dist/rollup');
 const { runTestSuiteWithSamples, assertDirectoriesAreEqual } = require('../utils.js');
 
@@ -63,6 +66,7 @@ async function generateAndTestBundle(bundle, outputOptions, expectedDirectory, c
 	if (outputOptions.format === 'amd' && config.runAmd) {
 		try {
 			const exports = await new Promise((resolve, reject) => {
+				// @ts-expect-error global
 				global.assert = require('node:assert');
 				const requirejs = require('requirejs');
 				requirejs.config({ baseUrl: outputOptions.dir });
@@ -73,7 +77,9 @@ async function generateAndTestBundle(bundle, outputOptions, expectedDirectory, c
 			}
 		} finally {
 			delete require.cache[require.resolve('requirejs')];
+			// @ts-expect-error global
 			delete global.requirejsVars;
+			// @ts-expect-error global
 			delete global.assert;
 		}
 	}

test/chunking-form/index.js

@@ -1,6 +1,6 @@
-module.exports = {
+module.exports = defineTest({
 	description: 'chunk aliasing with extensions',
 	options: {
 		input: ['main1', 'main2', 'main3.ts']
 	}
-};
+});

test/chunking-form/samples/aliasing-extensions/_config.js

@@ -1,4 +1,4 @@
-module.exports = {
+module.exports = defineTest({
 	description: "allows to use amd.autoId with amd.basePath and works when concat'd into one file",
 	options: {
 		input: ['main'],
@@ -31,4 +31,4 @@ module.exports = {
 			return exports.getA();
 		}
 	}
-};
+});

test/chunking-form/samples/amd-id-auto-base-path-concat/_config.js

@@ -1,4 +1,4 @@
-module.exports = {
+module.exports = defineTest({
 	description: 'allows to use amd.autoId with amd.basePath, and chunks folder',
 	options: {
 		input: ['main'],
@@ -16,4 +16,4 @@ module.exports = {
 			return exports.getA();
 		}
 	}
-};
+});

test/chunking-form/samples/amd-id-auto-base-path/_config.js

@@ -1,4 +1,4 @@
-module.exports = {
+module.exports = defineTest({
 	description: 'allows to use amd.autoId',
 	options: {
 		input: ['main'],
@@ -13,4 +13,4 @@ module.exports = {
 			return exports.getA();
 		}
 	}
-};
+});