Replace 3rd-party type definitions (stylelint#4857)

* Replace 3rd-party type definitions This change replaces 3rd-party type definitions under the `types/` directory with the following `@types/*` npm packages. - [@types/balanced-match](https://www.npmjs.com/package/@types/balanced-match) - [@types/imurmurhash](https://www.npmjs.com/package/@types/imurmurhash) - [@types/postcss-safe-parser](https://www.npmjs.com/package/@types/postcss-safe-parser) - [@types/style-search](https://www.npmjs.com/package/@types/style-search) - [@types/svg-tags](https://www.npmjs.com/package/@types/svg-tags) - [@types/write-file-atomic](https://www.npmjs.com/package/@types/write-file-atomic) Note that this change does **not** replace all type definitions under `types/`. We should address the remaining types via other pull requests. Related to stylelint#4399 * Replace with `@types/file-entry-cache`
reumia · Jul 12, 2020 · 909063d · 909063d
1 parent b1187b6
commit 909063d
Show file tree

Hide file tree

Showing 15 changed files with 80 additions and 74 deletions.
diff --git a/lib/rules/function-calc-no-unspaced-operator/index.js b/lib/rules/function-calc-no-unspaced-operator/index.js
@@ -36,7 +36,13 @@ function rule(actual) {
 					return;
 				}
 
-				const parensMatch = balancedMatch('(', ')', valueParser.stringify(node));
+				const nodeText = valueParser.stringify(node);
+				const parensMatch = balancedMatch('(', ')', nodeText);
+
+				if (!parensMatch) {
+					throw new Error(`No parens match: "${nodeText}"`);
+				}
+
 				const rawExpression = parensMatch.body;
 				const expressionIndex =
 					decl.source.start.column +

diff --git a/lib/utils/FileCache.js b/lib/utils/FileCache.js
@@ -8,6 +8,8 @@ const path = require('path');
 const DEFAULT_CACHE_LOCATION = './.stylelintcache';
 const DEFAULT_HASH = '';
 
+/** @typedef {import('file-entry-cache').FileDescriptor["meta"] & { hashOfConfig?: string }} CacheMetadata */
+
 /**
  * @param {string} [cacheLocation]
  * @param {string} [hashOfConfig]
@@ -30,6 +32,7 @@ class FileCache {
 		// Get file descriptor compares current metadata against cached
 		// one and stores the result to "changed" prop.w
 		const descriptor = this._fileCache.getFileDescriptor(absoluteFilepath);
+		/** @type {CacheMetadata} */
 		const meta = descriptor.meta || {};
 		const changed = descriptor.changed || meta.hashOfConfig !== this._hashOfConfig;
 

diff --git a/lib/utils/blurFunctionArguments.js b/lib/utils/blurFunctionArguments.js
@@ -33,8 +33,13 @@ module.exports = function (source, functionName, blurChar = '`') {
 	while (lowerCaseSource.includes(nameWithParen, searchStartIndex)) {
 		const openingParenIndex =
 			lowerCaseSource.indexOf(nameWithParen, searchStartIndex) + functionNameLength;
-		const closingParenIndex =
-			balancedMatch('(', ')', lowerCaseSource.slice(openingParenIndex)).end + openingParenIndex;
+		const parensMatch = balancedMatch('(', ')', lowerCaseSource.slice(openingParenIndex));
+
+		if (!parensMatch) {
+			throw new Error(`No parens match: "${source}"`);
+		}
+
+		const closingParenIndex = parensMatch.end + openingParenIndex;
 		const argumentsLength = closingParenIndex - openingParenIndex - 1;
 
 		result =

diff --git a/lib/utils/functionArgumentsSearch.js b/lib/utils/functionArgumentsSearch.js
@@ -31,6 +31,10 @@ module.exports = function (source, functionName, callback) {
 
 			const parensMatch = balancedMatch('(', ')', source.substr(match.startIndex));
 
+			if (!parensMatch) {
+				throw new Error(`No parens match: "${source}"`);
+			}
+
 			callback(parensMatch.body, match.endIndex + 1);
 		},
 	);

diff --git a/lib/writeOutputFile.js b/lib/writeOutputFile.js
@@ -7,7 +7,7 @@ const writeFileAtomic = require('write-file-atomic');
 /**
  * @param {string} content
  * @param {string} filePath
- * @returns {Promise<Error | undefined>}
+ * @returns {Promise<void>}
  */
 module.exports = (content, filePath) =>
 	writeFileAtomic(path.normalize(filePath), stripAnsi(content));
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -162,12 +162,19 @@
   "devDependencies": {
     "@stylelint/prettier-config": "^2.0.0",
     "@stylelint/remark-preset": "^1.0.0",
+    "@types/balanced-match": "^1.0.1",
     "@types/browserslist": "^4.8.0",
     "@types/debug": "^4.1.5",
+    "@types/file-entry-cache": "^5.0.1",
     "@types/global-modules": "^2.0.0",
     "@types/globjoin": "^0.1.0",
+    "@types/imurmurhash": "^0.1.1",
     "@types/lodash": "^4.14.155",
     "@types/micromatch": "^4.0.1",
+    "@types/postcss-safe-parser": "^4.0.0",
+    "@types/style-search": "^0.1.1",
+    "@types/svg-tags": "^1.0.0",
+    "@types/write-file-atomic": "^3.0.1",
     "benchmark": "^2.1.4",
     "common-tags": "^1.8.0",
     "del": "^5.1.0",

diff --git a/types/balanced-match/index.d.ts b/types/balanced-match/index.d.ts
diff --git a/types/file-entry-cache/index.d.ts b/types/file-entry-cache/index.d.ts
diff --git a/types/imurmurhash/index.d.ts b/types/imurmurhash/index.d.ts
diff --git a/types/postcss/extensions.d.ts b/types/postcss/extensions.d.ts
diff --git a/types/style-search/index.d.ts b/types/style-search/index.d.ts
diff --git a/types/svg-tags/index.d.ts b/types/svg-tags/index.d.ts
diff --git a/types/svg-tags/postcss-safe-parser.ts b/types/svg-tags/postcss-safe-parser.ts
diff --git a/types/write-file-atomic/index.d.ts b/types/write-file-atomic/index.d.ts