chore: Low-hanging issues caught by tsserver

preactjs · Feb 1, 2022 · 8deb57d · 8deb57d
1 parent 0e1555e
commit 8deb57d
Show file tree

Hide file tree

Showing 12 changed files with 92 additions and 47 deletions.
diff --git a/.eslintignore b/.eslintignore
@@ -1,2 +1,3 @@
 **/node_modules
 **/tests/output
+**/*.d.ts
diff --git a/.eslintrc b/.eslintrc
@@ -40,13 +40,5 @@
     "react/jsx-no-undef": 2,
     "react/jsx-uses-react": 2,
     "react/jsx-uses-vars": 2
-  },
-  "overrides": [
-    {
-      "files": ["**/*.ts"],
-      "rules": {
-        "no-undef": "off"
-      }
-    }
-  ]
+  }
 }
diff --git a/jsconfig.json b/jsconfig.json
@@ -0,0 +1,15 @@
+{
+	"compilerOptions": {
+		"target": "ESNext",
+		"moduleResolution": "Node",
+		"allowJs": true,
+		"checkJs": true,
+		"noEmit": true,
+		"resolveJsonModule": true,
+		"allowSyntheticDefaultImports": true,
+		"jsx": "react",
+		"jsxFactory": "h",
+		"jsxFragmentFactory": "Fragment"
+	},
+	"include": ["packages/**/*"]
+}
diff --git a/packages/cli/global.d.ts b/packages/cli/global.d.ts
@@ -0,0 +1,10 @@
+declare const __webpack_public_path__: string;
+
+declare global {
+	namespace jest {
+		interface Matchers<R> {
+			toBeCloseInSize(receivedSize: number, expectedSize: number): R;
+			toFindMatchingKey(receivedKey: string): R;
+		}
+	}
+}
diff --git a/packages/cli/lib/index.js b/packages/cli/lib/index.js
@@ -3,7 +3,7 @@ const envinfo = require('envinfo');
 const sade = require('sade');
 const notifier = require('update-notifier');
 const { error } = require('./util');
-const pkg = require('../package');
+const pkg = require('../package.json');
 
 const ver = process.version;
 const min = pkg.engines.node;
@@ -12,7 +12,7 @@ if (
 		.substring(1)
 		.localeCompare(min.match(/\d+/g).join('.'), 'en', { numeric: true }) === -1
 ) {
-	return error(
+	error(
 		`You are using Node ${ver} but preact-cli requires Node ${min}. Please upgrade Node to continue!`,
 		1
 	);

diff --git a/packages/cli/lib/lib/entry.js b/packages/cli/lib/lib/entry.js
@@ -13,16 +13,13 @@ if (process.env.NODE_ENV === 'development') {
 
 	// only add a debug sw if webpack service worker is not requested.
 	if (process.env.ADD_SW === undefined && 'serviceWorker' in navigator) {
-		// eslint-disable-next-line no-undef
 		navigator.serviceWorker.register(__webpack_public_path__ + 'sw-debug.js');
 	} else if (process.env.ADD_SW && 'serviceWorker' in navigator) {
-		// eslint-disable-next-line no-undef
 		navigator.serviceWorker.register(
 			__webpack_public_path__ + (process.env.ES_BUILD ? 'sw-esm.js' : 'sw.js')
 		);
 	}
 } else if (process.env.ADD_SW && 'serviceWorker' in navigator) {
-	// eslint-disable-next-line no-undef
 	navigator.serviceWorker.register(
 		__webpack_public_path__ + (process.env.ES_BUILD ? 'sw-esm.js' : 'sw.js')
 	);
@@ -57,7 +54,7 @@ if (typeof app === 'function') {
 			hydrate &&
 			currentURL === normalizeURL(location.pathname);
 		const doRender = canHydrate ? hydrate : render;
-		root = doRender(h(app, { CLI_DATA }), document.body, root);
+		doRender(h(app, { CLI_DATA }), document.body, root);
 	};
 
 	if (module.hot) module.hot.accept('preact-cli-entrypoint', init);

diff --git a/packages/cli/lib/lib/webpack/run-webpack.js b/packages/cli/lib/lib/webpack/run-webpack.js
@@ -17,22 +17,6 @@ async function devBuild(env) {
 
 	let compiler = webpack(config);
 	return new Promise((res, rej) => {
-		compiler.hooks.emit.tapAsync('CliDevPlugin', (compilation, callback) => {
-			let missingDeps = compilation.missingDependencies;
-			let nodeModulesPath = resolve(__dirname, '../../../node_modules');
-
-			// ...tell webpack to watch node_modules recursively until they appear.
-			if (
-				Array.from(missingDeps).some(
-					file => file.indexOf(nodeModulesPath) !== -1
-				)
-			) {
-				compilation.contextDependencies.push(nodeModulesPath);
-			}
-
-			callback();
-		});
-
 		compiler.hooks.beforeCompile.tap('CliDevPlugin', () => {
 			if (env['clear']) clear(true);
 		});

diff --git a/packages/cli/lib/lib/webpack/webpack-base-config.js b/packages/cli/lib/lib/webpack/webpack-base-config.js
@@ -16,21 +16,10 @@ const PnpWebpackPlugin = require(`pnp-webpack-plugin`);
 
 function readJson(file) {
 	try {
-		return JSON.parse(readFileSync(file));
+		return JSON.parse(readFileSync(file, 'utf8'));
 	} catch (e) {}
 }
 
-// attempt to resolve a dependency, giving $CWD/node_modules priority:
-// function resolveDep(dep, cwd) {
-// 	try {
-// 		return requireRelative.resolve(dep, cwd || process.cwd());
-// 	} catch (e) {}
-// 	try {
-// 		return require.resolve(dep);
-// 	} catch (e) {}
-// 	return dep;
-// }
-
 function findAllNodeModules(startDir) {
 	let dir = path.resolve(startDir);
 	let dirs = [];
@@ -70,6 +59,9 @@ function getSassConfiguration(...includePaths) {
 	return config;
 }
 
+/**
+ * @returns {import('webpack').Configuration}
+ */
 module.exports = function createBaseConfig(env) {
 	const { cwd, isProd, isWatch, src, source } = env;
 	const babelConfigFile = env.babelConfig || '.babelrc';
@@ -331,7 +323,7 @@ module.exports = function createBaseConfig(env) {
 					? '[name].chunk.[contenthash:5].css'
 					: '[name].chunk.css',
 			}),
-			new ProgressBarPlugin({
+			ProgressBarPlugin({
 				format:
 					'\u001b[97m\u001b[44m Build \u001b[49m\u001b[39m [:bar] \u001b[32m\u001b[1m:percent\u001b[22m\u001b[39m (:elapseds) \u001b[2m:msg\u001b[22m',
 				renderThrottle: 100,
@@ -388,5 +380,3 @@ module.exports = function createBaseConfig(env) {
 		},
 	};
 };
-
-module.exports.readJson = readJson;
diff --git a/packages/cli/lib/lib/webpack/webpack-client-config.js b/packages/cli/lib/lib/webpack/webpack-client-config.js
@@ -25,6 +25,9 @@ const cleanFilename = name =>
 		''
 	);
 
+/**
+ * @returns {Promise<import('webpack').Configuration>}
+ */
 async function clientConfig(env) {
 	const { isProd, source, src, cwd /*, port? */ } = env;
 	const IS_SOURCE_PREACT_X_OR_ABOVE = isInstalledVersionPreactXOrAbove(cwd);
@@ -190,6 +193,9 @@ function getBabelEsmPlugin(config) {
 	return esmPlugins;
 }
 
+/**
+ * @returns {import('webpack').Configuration}
+ */
 function isProd(config) {
 	let limit = 200 * 1000; // 200kb
 	const prodConfig = {
@@ -274,6 +280,9 @@ function isProd(config) {
 	return prodConfig;
 }
 
+/**
+ * @returns {import('webpack').Configuration}
+ */
 function isDev(config) {
 	const { cwd, src, refresh } = config;
 

diff --git a/packages/cli/lib/lib/webpack/webpack-server-config.js b/packages/cli/lib/lib/webpack/webpack-server-config.js
@@ -2,6 +2,9 @@ const { resolve } = require('path');
 const { merge } = require('webpack-merge');
 const baseConfig = require('./webpack-base-config');
 
+/**
+ * @returns {import('webpack').Configuration}
+ */
 function serverConfig(env) {
 	return {
 		entry: {

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -33,6 +33,8 @@
   "bugs": "https://github.com/preactjs/preact-cli/issues",
   "homepage": "https://github.com/preactjs/preact-cli",
   "devDependencies": {
+    "@types/express": "^4.17.13",
+    "@types/jest": "^27.4.0",
     "html-looks-like": "^1.0.2",
     "jest": "^27.0.1",
     "less": "^4.1.1",

diff --git a/yarn.lock b/yarn.lock
@@ -2482,7 +2482,7 @@
     "@types/qs" "*"
     "@types/range-parser" "*"
 
-"@types/express@*":
+"@types/express@*", "@types/express@^4.17.13":
   version "4.17.13"
   resolved "https://registry.yarnpkg.com/@types/express/-/express-4.17.13.tgz#a76e2995728999bab51a33fabce1d705a3709034"
   integrity sha512-6bSZTPaTIACxn48l50SR+axgrqm6qXFIxrdAKaG6PaJk3+zuUr35hBlgT7vOmJcum+OEaIBLtHV/qloEAFITeA==
@@ -2525,6 +2525,14 @@
   dependencies:
     "@types/istanbul-lib-report" "*"
 
+"@types/jest@^27.4.0":
+  version "27.4.0"
+  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-27.4.0.tgz#037ab8b872067cae842a320841693080f9cb84ed"
+  integrity sha512-gHl8XuC1RZ8H2j5sHv/JqsaxXkDDM9iDOgu0Wp8sjs4u/snb2PVehyWXJPr+ORA0RPpgw231mnutWI1+0hgjIQ==
+  dependencies:
+    jest-diff "^27.0.0"
+    pretty-format "^27.0.0"
+
 "@types/json-schema@^7.0.5", "@types/json-schema@^7.0.6":
   version "7.0.7"
   resolved "https://registry.yarnpkg.com/@types/json-schema/-/json-schema-7.0.7.tgz#98a993516c859eb0d5c4c8f098317a9ea68db9ad"
@@ -3112,6 +3120,11 @@ ansi-regex@^5.0.0:
   resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.0.tgz#388539f55179bf39339c81af30a654d69f87cb75"
   integrity sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==
 
+ansi-regex@^5.0.1:
+  version "5.0.1"
+  resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-5.0.1.tgz#082cb2c89c9fe8659a311a53bd6a4dc5301db304"
+  integrity sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==
+
 ansi-regex@^6.0.1:
   version "6.0.1"
   resolved "https://registry.yarnpkg.com/ansi-regex/-/ansi-regex-6.0.1.tgz#3183e38fae9a65d7cb5e53945cd5897d0260a06a"
@@ -5534,6 +5547,11 @@ diff-sequences@^27.0.1:
   resolved "https://registry.yarnpkg.com/diff-sequences/-/diff-sequences-27.0.1.tgz#9c9801d52ed5f576ff0a20e3022a13ee6e297e7c"
   integrity sha512-XPLijkfJUh/PIBnfkcSHgvD6tlYixmcMAn3osTk6jt+H0v/mgURto1XUiD9DKuGX5NDoVS6dSlA23gd9FUaCFg==
 
+diff-sequences@^27.4.0:
+  version "27.4.0"
+  resolved "https://registry.yarnpkg.com/diff-sequences/-/diff-sequences-27.4.0.tgz#d783920ad8d06ec718a060d00196dfef25b132a5"
+  integrity sha512-YqiQzkrsmHMH5uuh8OdQFU9/ZpADnwzml8z0O5HvRNda+5UZsaX/xN+AAxfR2hWq1Y7HZnAzO9J5lJXOuDz2Ww==
+
 diffie-hellman@^5.0.0:
   version "5.0.3"
   resolved "https://registry.yarnpkg.com/diffie-hellman/-/diffie-hellman-5.0.3.tgz#40e8ee98f55a2149607146921c63e1ae5f3d2875"
@@ -8309,6 +8327,16 @@ jest-config@^27.0.1:
     micromatch "^4.0.4"
     pretty-format "^27.0.1"
 
+jest-diff@^27.0.0:
+  version "27.4.6"
+  resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-27.4.6.tgz#93815774d2012a2cbb6cf23f84d48c7a2618f98d"
+  integrity sha512-zjaB0sh0Lb13VyPsd92V7HkqF6yKRH9vm33rwBt7rPYrpQvS1nCvlIy2pICbKta+ZjWngYLNn4cCK4nyZkjS/w==
+  dependencies:
+    chalk "^4.0.0"
+    diff-sequences "^27.4.0"
+    jest-get-type "^27.4.0"
+    pretty-format "^27.4.6"
+
 jest-diff@^27.0.1:
   version "27.0.1"
   resolved "https://registry.yarnpkg.com/jest-diff/-/jest-diff-27.0.1.tgz#021beb29fe9f07e83c809a4f7a1ce807b229c4ab"
@@ -8367,6 +8395,11 @@ jest-get-type@^27.0.1:
   resolved "https://registry.yarnpkg.com/jest-get-type/-/jest-get-type-27.0.1.tgz#34951e2b08c8801eb28559d7eb732b04bbcf7815"
   integrity sha512-9Tggo9zZbu0sHKebiAijyt1NM77Z0uO4tuWOxUCujAiSeXv30Vb5D4xVF4UR4YWNapcftj+PbByU54lKD7/xMg==
 
+jest-get-type@^27.4.0:
+  version "27.4.0"
+  resolved "https://registry.yarnpkg.com/jest-get-type/-/jest-get-type-27.4.0.tgz#7503d2663fffa431638337b3998d39c5e928e9b5"
+  integrity sha512-tk9o+ld5TWq41DkK14L4wox4s2D9MtTpKaAVzXfr5CUKm5ZK2ExcaFE0qls2W71zE/6R2TxxrK9w2r6svAFDBQ==
+
 jest-haste-map@^27.0.1:
   version "27.0.1"
   resolved "https://registry.yarnpkg.com/jest-haste-map/-/jest-haste-map-27.0.1.tgz#653c4ba59309a86499ad7bf663176e7f97478191"
@@ -12051,6 +12084,15 @@ pretty-error@^2.0.2:
     lodash "^4.17.20"
     renderkid "^2.0.4"
 
+pretty-format@^27.0.0, pretty-format@^27.4.6:
+  version "27.4.6"
+  resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-27.4.6.tgz#1b784d2f53c68db31797b2348fa39b49e31846b7"
+  integrity sha512-NblstegA1y/RJW2VyML+3LlpFjzx62cUrtBIKIWDXEDkjNeleA7Od7nrzcs/VLQvAeV4CgSYhrN39DRN88Qi/g==
+  dependencies:
+    ansi-regex "^5.0.1"
+    ansi-styles "^5.0.0"
+    react-is "^17.0.1"
+
 pretty-format@^27.0.1:
   version "27.0.1"
   resolved "https://registry.yarnpkg.com/pretty-format/-/pretty-format-27.0.1.tgz#c4094621dfbd3e8ab751964d1cf01edc6f88474d"