TS-check and Prettier #22

TomJo2000 · 2025-07-04T04:03:29Z

This is a JSON object corresponding to https://github.com/termux/termux-packages/blob/master/repo.json

Thanks! I had replaced the any by unknown because there's no absolute guarantee that the input repo.json honors the schema. But I guess it's fine to make some assumptions there

TomJo2000 · 2025-07-04T04:05:35Z

That seems like a messy way to express that type annotation.

IDK how to do non-nullish asserts in JSDoc 😅

-Original file line number
+Diff line change
@@ -1,3 +1,6 @@
+    # NPM
+    node_modules/
     # Python
     __pycache__
@@ Expand Down @@

-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,7 @@ import { glob, readFile, writeFile } from "node:fs/promises"; @@
     import { gunzip } from "node:zlib";
     import { join } from "node:path";
     import { promisify } from "node:util";
+    import assert from "node:assert/strict";
     const gunzipAsync = promisify(gunzip);
@@ Expand All / @@ -21,9 +22,11 @@ if (!TERMUX_ARCH) { @@
     }
     const binPrefix = TERMUX_PREFIX.substring(1) + "/bin/";
+    /**@type {unknown}*/
     const repos = JSON.parse(
-      await readFile(join(TERMUX_SCRIPTDIR, "repo.json")),
+      await readFile(join(TERMUX_SCRIPTDIR, "repo.json"), "utf8"),
     );
+    assert(typeof repos == "object" && repos);
     /**
      * Parses an alternative file and returns an array of alternative entries.
@@ Expand All / @@ -38,6 +41,7 @@ const repos = JSON.parse( @@
      * - `priority`: The priority of the alternative.
      *
      * Note that both the name and path do not start with TERMUX_PREFIX, but instead start with the relative path from TERMUX_PREFIX.
+     * @param {string} filePath
      */
     async function parseAlternativeFile(filePath) {
       const content = await readFile(filePath, "utf8");
@@ Expand All / @@ -56,7 +60,6 @@ async function parseAlternativeFile(filePath) { @@
         let match = line.match(/\s*#.*/);
         line = line.substring(0, match === null ? line.length : match.index);
         if (line.startsWith("Name: ")) {
           if (parsingDependents) {
             parsingDependents = false;
@@ Expand Down Expand Up / @@ -138,6 +141,15 @@ async function parseAlternativeFile(filePath) { @@
       return alternatives;
     }
+    /**
+    @param {{
+      name: string,
+      url: URL,
+      distribution: string
+    }} repo
+    @param {string} repoPath
+    @param {string} arch
+    */
     async function processRepo(repo, repoPath, arch) {
       // Fetch the Contents.gz file for the given architecture from the apt mirror
       const url = `${repo.url}/dists/${repo.distribution}/Contents-${arch}.gz`;
@@ Expand All / @@ -157,14 +169,20 @@ async function processRepo(repo, repoPath, arch) { @@
       // is the name of the package that provides this file.
       const lines = data.toString().split("\n");
-      // Stores mappings of binary names to package names
-      // The key is the binary name, and the value is an array of package names
-      // that provide this binary
+      /**
+       * Stores mappings of binary names to package names
+       * The key is the binary name, and the value is an array of package names
+       * that provide this binary
+       * @type {Map<string, string[]>}
+       */
       const binMap = new Map();
-      // Stores mappings of file paths to package names
-      // This is needed to resolve the package names for binaries that are setup
-      // using the alternatives system
+      /**
+       * Stores mappings of file paths to package names
+       * This is needed to resolve the package names for binaries that are setup
+       * using the alternatives system
+       * @type {Map<string, string>}
+       */
       const fileMap = new Map();
       // Populate the fileMap
       lines.forEach((line) => {
@@ Expand All / @@ -185,13 +203,13 @@ async function processRepo(repo, repoPath, arch) { @@
             if (!binMap.has(packageName)) {
               binMap.set(packageName, []);
             }
-            binMap.get(packageName).push(binary);
+            /**@type {string[]}*/ (binMap.get(packageName)).push(binary);
           });
         });
       // Now go through all the *.alternatives files in the repository and parse
       // them to find the alternatives and their dependents
-      repoPath = join(TERMUX_SCRIPTDIR, repoPath);
+      repoPath = join(/**@type {string}*/ (TERMUX_SCRIPTDIR), repoPath);
       for await (const file of glob(`${repoPath}/*/*.alternatives`, {
         nodir: true,
       })) {
@@ Expand All / @@ -214,7 +232,7 @@ async function processRepo(repo, repoPath, arch) { @@
             if (!binMap.has(packageName)) {
               binMap.set(packageName, []);
             }
-            binMap.get(packageName).push(binary);
+            /**@type {string[]}*/ (binMap.get(packageName)).push(binary);
             alternativeEntry.dependents.forEach(({ link, name: _, path }) => {
               if (link.startsWith("bin/")) {
                 const depPackageName = fileMap.get(
@@ Expand All / @@ -224,7 +242,7 @@ async function processRepo(repo, repoPath, arch) { @@
                 if (!binMap.has(depPackageName)) {
                   binMap.set(depPackageName, []);
                 }
-                binMap.get(depPackageName).push(depBinary);
+                /**@type {string[]}*/ (binMap.get(depPackageName)).push(depBinary);
               }
               // Register the link in the fileMap for the package
               // This is used by vim.alternatives where bin/vim is a link with alternative libexec/vim/vim
@@ Expand All / @@ -233,7 +251,7 @@ async function processRepo(repo, repoPath, arch) { @@
               if (!binMap.has(packageName)) {
                 binMap.set(packageName, []);
               }
-              binMap.get(packageName).push(binary);
+              /**@type {string[]}*/ (binMap.get(packageName)).push(binary);
             });
           }
           // Register the link in the fileMap for the package
@@ Expand All / @@ -250,8 +268,7 @@ async function processRepo(repo, repoPath, arch) { @@
       const header = Array.from(binMap.keys())
         .sort()
         .map((packageName) => {
-          const binaries = binMap
-            .get(packageName)
+          const binaries = /**@type {string[]}*/ (binMap.get(packageName))
             .sort()
             .map((bin) => `" ${bin}",`);
           return `"${packageName}",\n${binaries.join("\n")}`;
@@ Expand All / @@ -261,12 +278,32 @@ async function processRepo(repo, repoPath, arch) { @@
       await writeFile(headerFile, header);
     }
+    /**
+    @type {Promise<void>[]}
+    */
     const promises = [];
     for (const path in repos) {
       if (path === "pkg_format") continue;
+      //@ts-expect-error
       const repo = repos[path];
-      promises.push(processRepo(repo, path, TERMUX_ARCH));
+      assert(typeof repo == "object" && repo);
+      assert("name" in repo && typeof repo.name == "string");
+      assert("url" in repo && typeof repo.url == "string");
+      assert("distribution" in repo && typeof repo.distribution == "string");
+      promises.push(
+        processRepo(
+          {
+            name: repo.name,
+            url: new URL(repo.url),
+            distribution: repo.distribution,
+          },
+          path,
+          TERMUX_ARCH,
+        ),
+      );
     }
     await Promise.all(promises);

-Original file line number
+Diff line change
@@ -0,0 +1,21 @@
+    /* https://aka.ms/tsconfig */
+    {
+      "compilerOptions": {
+        "target": "ESNext",
+        "module": "ESNext",
+        "allowJs": true,
+        "checkJs": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "exactOptionalPropertyTypes": true,
+        "noImplicitReturns": true,
+        "noFallthroughCasesInSwitch": true,
+        "noUncheckedIndexedAccess": true,
+        "noImplicitOverride": true,
+        "noPropertyAccessFromIndexSignature": true,
+        "allowUnreachableCode": false,
+        "skipLibCheck": true
+      }
+    }

-Original file line number
+Diff line change
@@ -1,4 +1,13 @@
     {
+      "name": "cmd-not-found-gen-db",
       "type": "module",
-      "private": true
+      "private": true,
+      "version": "0.1.0",
+      "bugs": "https://github.com/termux/command-not-found/issues",
+      "repository": "github:termux/command-not-found",
+      "devDependencies": {
+        "@types/node": "^24.0.10",
+        "prettier": "^3.6.2",
+        "typescript": "^5.8.3"
+      }
     }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

TS-check and Prettier #22

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

TomJo2000 Jul 4, 2025

Uh oh!

Rudxain Jul 4, 2025

Uh oh!

TomJo2000 Jul 4, 2025

Uh oh!

Rudxain Jul 4, 2025

Uh oh!

Uh oh!

TS-check and Prettier #22

Are you sure you want to change the base?

Uh oh!

TS-check and Prettier #22

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

TomJo2000 Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

Rudxain Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

TomJo2000 Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!

Rudxain Jul 4, 2025

Choose a reason for hiding this comment

Uh oh!