ref: plain js types + js esm

.jshintrc

@@ -1,4 +1,5 @@
 {
+  "module": true,
   "browser": true,
   "node": true,
   "esversion": 11,
@@ -16,7 +17,6 @@
   "plusplus": true,
   "undef": true,
   "unused": "vars",
-  "strict": true,
   "maxdepth": 4,
   "maxstatements": 100,
   "maxcomplexity": 20

build-classifier.js

@@ -0,0 +1,6 @@
+let BuildClassifier = {};
+
+BuildClassifier._empty = true;
+
+export let _empty = BuildClassifier._empty;
+export default BuildClassifier;

host-targets.js

@@ -1,11 +1,10 @@
-'use strict';
-
 /** @typedef {import('./types.js').OsString} OsString */
 /** @typedef {import('./types.js').LibcString} LibcString */
 /** @typedef {import('./types.js').ArchString} ArchString */
 /** @typedef {import('./types.js').TargetTriplet} TargetTriplet */
+/** @typedef {import('./types.js').TargetMatcher} TargetMatcher */
 
-var HostTargets = module.exports;
+let HostTargets = {};
 
 let reVersionOnly = /^[\d\.]+(-RELEASE)?$/;
 let reLeadingVer = /^\d([\d\.\-\+_])+/;
@@ -64,6 +63,7 @@ let T = {
 };
 
 // OS, Arch, Libc
+/** @type {Object.<String, import('./types.js').TargetMatcher>}  */
 HostTargets.TERMS = {
   // agent
   webi: {},
@@ -137,19 +137,21 @@ HostTargets._MATCHERS = {
 };
 
 /**
- * @param {Object.<"os"|"arch"|"libc", String>} target
+ * @param {Object.<"os"|"arch"|"libc", String>} targetIsh
  * @param {Array<String>} terms
  */
-HostTargets.termsToTarget = function (target, terms) {
+HostTargets.termsToTarget = function (targetIsh, terms) {
   let bogoTerms = [];
 
-  Object.assign(target, { errors: [] });
+  let target = Object.assign(targetIsh, { errors: [] });
 
   for (let term of terms) {
     let lterm = term.toLowerCase();
     let hints = HostTargets.TERMS[lterm];
     if (hints) {
-      upsertHints(target, terms, term, hints);
+      let debugUa = terms.join(',');
+      let debugTerms = [term];
+      upsertHints(target, debugUa, debugTerms, hints);
       continue;
     }
 
@@ -199,15 +201,26 @@ HostTargets.termsToTarget = function (target, terms) {
   return bogoTerms;
 };
 
+/**
+ * @param {TargetTriplet} target
+ * @param {String} ua
+ * @param {Array<String>} terms
+ * @param {TargetMatcher} hints
+ */
 function upsertHints(target, ua, terms, hints) {
   if (!hints) {
     throw new Error("[SANITY FAIL] 'hints' not provided");
   }
 
+  // TODO maybe use utility type 'keyof'
+  /** @type {["os","arch","libc","vendor"]} */ //@ts-expect-error
   let keys = Object.keys(hints);
   for (let key of keys) {
     if (!target[key]) {
-      target[key] = hints[key];
+      if (hints[key]) {
+        //@ts-expect-error TODO
+        target[key] = hints[key];
+      }
     }
     if (target[key] !== hints[key]) {
       let msg = `'${key}' already set to '${target[key]}', not updated to '${hints[key]}'`;
@@ -222,19 +235,30 @@ function upsertHints(target, ua, terms, hints) {
           ignore = true;
         } else if (hints[key] === 'musl') {
           // musl can be installed on a GNU system
+          //@ts-expect-error - TODO find out if we depend on this libs vs libcs typo (we probably do)
           target.libs = [target.libc, 'musl'];
           ignore = true;
         }
       }
       if (!ignore) {
+        //@ts-expect-error
         target.errors.push({ [key]: hints[key], message: msg, terms: terms });
         throw new Error(`${msg} for '${ua}' / '${terms}'`);
       }
     }
   }
 }
 
-// Workaround for current (2023-q4) Android misclassification
+/**
+ * @typedef HasErrors
+ * @prop {Array<any>} errors
+ */
+
+/**
+ * Workaround for current (2023-q4) Android misclassification
+ * @param {TargetTriplet & HasErrors} target
+ * @param {Array<String>} terms
+ */
 function upsertAndroidTerms(target, terms) {
   if (!target.android) {
     return;
@@ -268,3 +292,9 @@ function upsertAndroidTerms(target, terms) {
     }
   }
 }
+
+export let TERMS = HostTargets.TERMS;
+export let WATERFALL = HostTargets.WATERFALL;
+export let _MATCHERS = HostTargets._MATCHERS;
+export let termsToTarget = HostTargets.termsToTarget;
+export default HostTargets;

jsconfig.json

@@ -0,0 +1,122 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2024",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "nodenext",                                /* Specify what module code is generated. */
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    "moduleResolution": "nodenext",                      /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    "paths": {
+      "build-classifier": ["./build-classifier.js"],
+      "build-classifier/*": ["./*"]
+    },                                                   /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    "typeRoots": ["./typings","./node_modules/@types"],  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "rewriteRelativeImportExtensions": true,          /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "noUncheckedSideEffectImports": true,             /* Check side effect imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true,                                     /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    "checkJs": true,                                     /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    "noEmit": true,                                      /* Disable emitting files from a compilation. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                               /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    "alwaysStrict": true,                                /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": [
+    "*.js",
+    "bin/**/*.js",
+    "lib/**/*.js",
+    "src/**/*.js",
+    "tests/**/*.js"
+  ],
+  "exclude": ["node_modules"]
+}

lexver-test.js

@@ -1,6 +1,6 @@
 'use strict';
 
-let Lexver = require('./lexver.js');
+import Lexver from './lexver.js';
 
 async function main() {
   let matchVer = process.argv[2];
@@ -77,6 +77,7 @@ async function main() {
   let knownKeys = Object.keys(known);
 
   for (let key of knownKeys) {
+    //@ts-expect-error - ignore dynamic key errors in test
     if (selected[key].toString() !== known[key].toString()) {
       console.error('Expected:');
       console.error(known);

lexver.js

@@ -1,6 +1,4 @@
-'use strict';
-
-var Lexver = module.exports;
+let Lexver = {};
 
 // hotfix is post-stable
 let channels = ['alpha', 'beta', 'dev', 'pre', 'preview', 'rc', 'hotfix'];
@@ -12,6 +10,12 @@ let channelsRePost;
   channelsRePost = new RegExp(`(${channelsOr})([\\.\\-\\+]?)(\\d+)`);
 }
 let channelsPrePlacer = '$1-$2';
+/**
+ * @param {unknown} _
+ * @param {String} chan
+ * @param {String} sep
+ * @param {String} ver
+ */
 let channelsPostPlacer = function (_, chan, sep, ver) {
   ver = ver.padStart(2, '0');
 
@@ -23,6 +27,11 @@ let digitsOnlyRe = /^\d+$/;
 // this is a special case, but if it gets complicated in the future, we'll drop it
 // and just treat it like a build hash and open an issue for to the maintainer
 let channelsReB = /(\.\d+b)(\d+)$/;
+/**
+ * @param {unknown} _
+ * @param {String} sep
+ * @param {String} ver
+ */
 let channelsBPlacer = function (_, sep, ver) {
   ver = ver.padStart(2, '0');
   let rel = `${sep}${ver}`;
@@ -75,8 +84,8 @@ Lexver.sortedToTags = function (descVersions) {
 /**
  * Parse a semver or non-standard version and return a lexical version
  * Ex: 1.2beta-3 =>  0001.0002.0000.0000-beta-03
- * @param {String} version - a semver or other version
- * @param {Object} _opts - no public options
+ * @param {String} fullVersion - a semver or other version
+ * @param {Object} [_opts] - no public options
  * @param {Boolean} _opts._asPrefix - don't expand 1.0 to 1.0.0, etc
  * @returns {String}
  */
@@ -89,9 +98,11 @@ Lexver.parseVersion = function (fullVersion, _opts) {
   // 1.2beta1 => 1.2beta1
   let rels = fullVersion.split('-');
 
+  /** @type {String} */ //@ts-expect-error - even an empty string splits
   let version = rels.shift();
   if (version.includes('+')) {
     let parts = version.split('+');
+    /** @type {String} */ //@ts-expect-error - even an empty string splits
     version = parts.shift();
     let build = parts.join(`${sortSuffixBuild}`);
     rels.unshift(`${sortSuffixBuild}${build}`);
@@ -105,6 +116,7 @@ Lexver.parseVersion = function (fullVersion, _opts) {
 
   // 1.2-beta1-a => 1.2, beta1, a
   let subparts = version.split('-');
+  /** @type {String} */ //@ts-expect-error - even an empty string splits
   version = subparts.shift();
 
   // beta1, a => beta1-a
@@ -117,6 +129,7 @@ Lexver.parseVersion = function (fullVersion, _opts) {
   let levels = version.split('.');
   let digits = [];
   for (; levels.length; ) {
+    /** @type {String} */ //@ts-expect-error - even an empty string splits
     let level = levels.shift();
     if (!digitsOnlyRe.test(level)) {
       levels.unshift(level);
@@ -247,3 +260,10 @@ Lexver.matchSorted = function (versions, prefix) {
   };
   return matchInfo;
 };
+
+export let toTags = Lexver.toTags;
+export let sortedToTags = Lexver.sortedToTags;
+export let parseVersion = Lexver.parseVersion;
+export let parsePrefix = Lexver.parsePrefix;
+export let matchSorted = Lexver.matchSorted;
+export default Lexver;