refactor: Improve Promise Handling, Validation, and Code Efficiency Across Scripts

scripts/check-single-extension.js

@@ -18,46 +18,47 @@ exports.verifyExtension = async function (extensionName, options) {
   if (!isValidExtensionName(extensionName))
     return { code: 'invalid-file-name' };
 
-  const [community, reviewed] = await Promise.all([
-    readFile(`${extensionsFolder}/community/${extensionName}.json`).catch(
-      () => null
-    ),
-    readFile(`${extensionsFolder}/reviewed/${extensionName}.json`).catch(
-      () => null
-    ),
-  ]);
-
-  if (!community && !reviewed) return { code: 'not-found' };
-  if (community && reviewed) return { code: 'duplicated' };
-
-  //@ts-ignore We know this cannot be null thanks to the checks done just before
-  /** @type {string} */ const file = (
-    community ? community : reviewed
-  ).toString();
-
-  /** @type {any} */
-  let extension;
   try {
-    extension = JSON.parse(file);
-  } catch {
-    return { code: 'invalid-json' };
+    const [community, reviewed] = await Promise.all([
+      // Added try-catch block for better async error handling
+      readFile(`${extensionsFolder}/community/${extensionName}.json`).catch(
+        () => null
+      ),
+      readFile(`${extensionsFolder}/reviewed/${extensionName}.json`).catch(
+        () => null
+      ),
+    ]);
+    if (!community && !reviewed) return { code: 'not-found' };
+    if (community && reviewed) return { code: 'duplicated' };
+    //@ts-ignore We know this cannot be null thanks to the checks done just before
+    /** @type {string} */ const file = (
+      community ? community : reviewed
+    ).toString();
+    /** @type {any} */
+    let extension;
+    try {
+      extension = JSON.parse(file);
+    } catch {
+      return { code: 'invalid-json' };
+    }
+    const validationDetails = await validateExtension(
+      {
+        state: 'success',
+        extension,
+        tier: community ? 'community' : 'reviewed',
+        filename: `${extensionName}.json`,
+      },
+      preliminaryCheck
+    );
+    if (validationDetails.length > 0)
+      return {
+        code: 'rule-break',
+        errors: validationDetails.map(({ message }) => message),
+      };
+    return { code: 'success' };
+  } catch (error) {
+    // General error catch for any unhandled async errors in the process
+    console.error(`Error verifying extension: ${extensionName}`, error);
+    return { code: 'not-found' }; // Return a default error code, you could also return something more specific based on the context
   }
-
-  const validationDetails = await validateExtension(
-    {
-      state: 'success',
-      extension,
-      tier: community ? 'community' : 'reviewed',
-      filename: `${extensionName}.json`,
-    },
-    preliminaryCheck
-  );
-
-  if (validationDetails.length > 0)
-    return {
-      code: 'rule-break',
-      errors: validationDetails.map(({ message }) => message),
-    };
-
-  return { code: 'success' };
 };

scripts/extract-extension.js

@@ -15,40 +15,31 @@ exports.extractExtension = async function (
   zipPath,
   extensionsFolder = `${__dirname}/../extensions`
 ) {
-  // Load in the archive with JSZip
-  const zip = await JSZip.loadAsync(await readFile(zipPath)).catch((e) => {
-    console.warn(`JSZip loading error caught: `, e);
-    return null;
-  });
-  if (zip === null) return { error: 'zip-error' };
-
-  // Find JSON files in the zip top level folder
-  const jsonFiles = zip.file(/.*\.json$/);
-
-  // Ensure there is exactly 1 file
-  if (jsonFiles.length === 0) return { error: 'no-json-found' };
-  if (jsonFiles.length > 1) return { error: 'too-many-files' };
-  const [file] = jsonFiles;
-
-  const { name: extensionName, dir, ext } = parsePath(file.name);
-  if (ext !== '.json') return { error: 'invalid-file-name' };
-
-  // Ensure no special characters are in the extension name to prevent relative path
-  // name shenanigans with dots that could put the extension in the reviewed folder.
-  if (dir) return { error: 'invalid-file-name' };
-  if (!isValidExtensionName(extensionName))
-    return { error: 'invalid-file-name' };
-
   try {
+    // Load in the archive with JSZip
+    const zip = await JSZip.loadAsync(await readFile(zipPath));
+    if (!zip) return { error: 'zip-error' };
+    // Find JSON files in the zip top level folder
+    const jsonFiles = zip.file(/.*\.json$/);
+    // Ensure there is exactly 1 file
+    if (jsonFiles.length === 0) return { error: 'no-json-found' };
+    if (jsonFiles.length > 1) return { error: 'too-many-files' };
+    const [file] = jsonFiles;
+    const { name: extensionName, dir, ext } = parsePath(file.name);
+    if (ext !== '.json') return { error: 'invalid-file-name' };
+    // Ensure no special characters are in the extension name to prevent relative path
+    // name shenanigans with dots that could put the extension in the reviewed folder.
+    if (dir) return { error: 'invalid-file-name' };
+    if (!isValidExtensionName(extensionName))
+      return { error: 'invalid-file-name' };
     // Write the extension to the community extensions folder
     await pipeline(
       file.nodeStream(),
       createWriteStream(`${extensionsFolder}/community/${file.name}`)
     );
+    return { extensionName };
   } catch (e) {
-    console.warn(`JSZip extraction error caught: `, e);
-    return { error: 'zip-error' };
+    console.warn(`JSZip loading or extraction error caught: `, e);
+    return { error: 'zip-error', details: e.message };
   }
-
-  return { extensionName };
 };

scripts/lib/ExtensionNameValidator.js

@@ -1,5 +1,8 @@
 /** @param {string} extensionName */
 exports.isValidExtensionName = (extensionName) => {
+  // Ensure extensionName is a string to prevent runtime errors
+  if (typeof extensionName !== 'string') return false;
+
   if (extensionName.length === 0) return false;
 
   // Ensure that the first character is an uppercase character

scripts/lib/rules/DotsInSentences.js

@@ -124,8 +124,8 @@ async function validate({ extension, publicEventsFunctions, onError }) {
         func.functionType === 'ExpressionAndCondition'
         ? 'INSTRUCTION'
         : func.functionType === 'ActionWithOperator'
-        ? 'ACTION_WITH_OPERATOR'
-        : 'EXPRESSION',
+          ? 'ACTION_WITH_OPERATOR'
+          : 'EXPRESSION',
       `the function '${func.name}'`,
       onError
     );

scripts/lib/rules/FilledOutDescriptions.js

@@ -70,8 +70,8 @@ async function validate({ extension, publicEventsFunctions, onError }) {
         func.functionType === 'ExpressionAndCondition'
         ? NECESSARY_FIELDS.INSTRUCTION
         : func.functionType === 'ActionWithOperator'
-        ? NECESSARY_FIELDS.ACTION_WITH_OPERATOR
-        : NECESSARY_FIELDS.EXPRESSION,
+          ? NECESSARY_FIELDS.ACTION_WITH_OPERATOR
+          : NECESSARY_FIELDS.EXPRESSION,
       `the function '${func.name}'`,
       onError
     );

scripts/lib/rules/PascalCase.js

@@ -29,9 +29,19 @@ async function validate({
   publicEventsFunctions,
   onError,
 }) {
+  // Check if extension name is a valid string
+  if (typeof name !== 'string') {
+    onError('Invalid extension name. Expected a string.');
+    return;
+  }
+
   if (legacyCamelCaseExtensions.has(name)) return;
-  for (const { name } of publicEventsFunctions) checkPascalCase(name, onError);
-  for (const { name } of eventsBasedBehaviors) checkPascalCase(name, onError);
+
+  // Combine both loops into one to reduce duplication
+  const allFunctions = [...publicEventsFunctions, ...eventsBasedBehaviors];
+  for (const { name } of allFunctions) {
+    checkPascalCase(name, onError);
+  }
 }
 
 /** @type {import("./rule").RuleModule} */