@suseejs/check 0.1.0 → 0.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suseejs/check",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Types check",
   "type": "module",
   "main": "dist/index.cjs",
@@ -46,5 +46,11 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ]
 }

package/.vscode/settings.json

@@ -1,6 +0,0 @@
-{
-    "cSpell.words": [
-        "suseejs",
-        "tcolor"
-    ]
-}

package/src/index.cts

@@ -1,244 +0,0 @@
-// cSpell:disable
-import path = require("node:path");
-import ts = require("typescript");
-
-interface DepsFile {
-  file: string;
-  content: string;
-}
-
-const jsesm_exts = [".js", ".mjs"];
-const jscjs_exts = [".cjs"];
-const tsesm_exts = [".ts", ".mts"];
-const tscjs_exts = [".cts"];
-const jsx_exts = [".jsx", ".tsx"];
-const all_exts = [
-  ...jscjs_exts,
-  ...jsesm_exts,
-  ...tscjs_exts,
-  ...tsesm_exts,
-  ...jsx_exts,
-];
-
-/**
- * Check types of given files and exit process if any errors are found.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @param compilerOptions TypeScript compiler options.
- * @returns True if no errors are found, false otherwise.
- */
-function checkTypes(deps: DepsFile[], compilerOptions: ts.CompilerOptions) {
-  if (!compilerOptions.noCheck) {
-    console.time("types checked");
-    const filePaths = deps.map((i) => i.file);
-    let _err = false;
-    // Create program
-    const program = ts.createProgram(filePaths, compilerOptions);
-    // Check each file individually for immediate feedback
-    for (const filePath of filePaths) {
-      const sourceFile = program.getSourceFile(filePath);
-      if (!sourceFile) {
-        console.error(
-          `File not found: ${path.relative(process.cwd(), filePath)}`,
-        );
-        process.exit(1);
-      }
-
-      const diagnostics = [
-        ...program.getSyntacticDiagnostics(sourceFile),
-        ...program.getSemanticDiagnostics(sourceFile),
-        ...program.getDeclarationDiagnostics(sourceFile),
-      ];
-
-      if (diagnostics.length > 0) {
-        const formatHost: ts.FormatDiagnosticsHost = {
-          getCurrentDirectory: () => process.cwd(),
-          getCanonicalFileName: (fileName) => fileName,
-          getNewLine: () => ts.sys.newLine,
-        };
-        console.error(
-          ts.formatDiagnosticsWithColorAndContext(diagnostics, formatHost),
-        );
-        _err = true;
-      }
-    }
-    if (_err) {
-      process.exit(1);
-    } else {
-      console.timeEnd("types checked");
-      return true;
-    }
-  }
-}
-
-/**
- * Check if all files in the given list have the same file extension.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @returns An object with the following properties:
- *          - `isNone`: True if none of the files have any of the supported
- *            extensions (i.e., not .js, .jsx, .ts, .tsx, .cts, .mts,
- *            .cjs).
- *          - `isJsx`: True if all files have .jsx or .tsx extensions.
- *          - `isCjs`: True if all files have .js or .cjs extensions.
- *          - `isBoth`: True if all files have both .js and .ts extensions.
- *          - `isJs`: True if all files have .js or .jsx extensions.
- *          - `isTs`: True if all files have .ts or .tsx extensions.
- */
-function checkExtGroup(deps: DepsFile[]) {
-  const exts = deps.map((dep) => {
-    return path.extname(dep.file);
-  });
-  const jsesmSet = new Set(jsesm_exts);
-  const jscjsSet = new Set(jscjs_exts);
-  const tsesmSet = new Set(tsesm_exts);
-  const tscjsSet = new Set(tscjs_exts);
-  const jsxSet = new Set(jsx_exts);
-  const allSet = new Set(all_exts);
-  const isCjs =
-    exts.every((i) => jscjsSet.has(i)) || exts.every((i) => tscjsSet.has(i));
-  const isJsx = exts.every((i) => jsxSet.has(i));
-  const isJs = exts.every((i) => jsesmSet.has(i));
-  const isTs = exts.every((i) => tsesmSet.has(i));
-  const isBoth = isJs && isTs;
-  const isNone = !exts.every((i) => allSet.has(i));
-  return {
-    isNone,
-    isJsx,
-    isCjs,
-    isBoth,
-    isJs,
-    isTs,
-  };
-}
-
-/**
- * Check the module format of all the given files.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @returns An object with the following properties:
- *          - `unknowCount`: Number of files that could not be checked due to
- *            errors.
- *          - `cjsCount`: Number of files that have CommonJS module syntax.
- */
-function checkModuleFormat(deps: DepsFile[]) {
-  let _esmCount = 0;
-  let cjsCount = 0;
-  let unknowCount = 0;
-  for (const dep of deps) {
-    try {
-      // Create a TypeScript source file
-      const sourceFile = ts.createSourceFile(
-        dep.file,
-        dep.content,
-        ts.ScriptTarget.Latest,
-        true,
-      );
-
-      let hasESMImports = false;
-      let hasCommonJS = false;
-      // Walk through the AST to detect module syntax
-      function walk(node: ts.Node) {
-        // Check for ESM import/export syntax
-        if (
-          ts.isImportDeclaration(node) ||
-          ts.isImportEqualsDeclaration(node) ||
-          ts.isExportDeclaration(node) ||
-          ts.isExportSpecifier(node) ||
-          ts.isExportAssignment(node)
-        ) {
-          hasESMImports = true;
-        }
-
-        // Check for export modifier on declarations
-        if (
-          (ts.isVariableStatement(node) ||
-            ts.isFunctionDeclaration(node) ||
-            ts.isInterfaceDeclaration(node) ||
-            ts.isTypeAliasDeclaration(node) ||
-            ts.isEnumDeclaration(node) ||
-            ts.isClassDeclaration(node)) &&
-          node.modifiers?.some(
-            (mod) => mod.kind === ts.SyntaxKind.ExportKeyword,
-          )
-        ) {
-          hasESMImports = true;
-        }
-
-        // Check for CommonJS require/exports
-        if (ts.isCallExpression(node)) {
-          if (
-            ts.isIdentifier(node.expression) &&
-            node.expression.text === "require" &&
-            node.arguments.length > 0
-          ) {
-            hasCommonJS = true;
-          }
-        }
-
-        // Check for module.exports or exports.xxx
-        if (ts.isPropertyAccessExpression(node)) {
-          const text = node.getText(sourceFile);
-          if (
-            text.startsWith("module.exports") ||
-            text.startsWith("exports.")
-          ) {
-            hasCommonJS = true;
-          }
-        }
-
-        // Continue walking the AST
-        ts.forEachChild(node, walk);
-      }
-      walk(sourceFile);
-
-      // Determine the module format based on what we found
-      if (hasESMImports && !hasCommonJS) {
-        _esmCount++;
-      } else if (hasCommonJS && !hasESMImports) {
-        cjsCount++;
-      } else if (hasESMImports && hasCommonJS) {
-        // Mixed - probably ESM with dynamic imports or similar
-        _esmCount++;
-      }
-    } catch (error) {
-      console.error(
-        `Error checking module format for ${dep.file} : \n ${error}`,
-      );
-      unknowCount++;
-    }
-  } // loop
-  //
-  return { unknowCount, cjsCount };
-}
-
-/**
- * Check TypeScript files for errors and determine their module format.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @param compilerOptions TypeScript compiler options.
- * @returns An object with the following properties:
- *          - `isNone`: True if none of the files have any of the supported
- *            extensions (i.e., not .js, .jsx, .ts, .tsx, .cts, .mts, .cjs).
- *          - `isJsx`: True if all files have .jsx or .tsx extensions.
- *          - `isCjs`: True if all files have .js or .cjs extensions.
- *          - `isBoth`: True if all files have both .js and .ts extensions.
- *          - `isJs`: True if all files have .js or .jsx extensions.
- *          - `isTs`: True if all files have .ts or .tsx extensions.
- *          - `unknowCount`: The number of files that could not be checked.
- *          - `cjsCount`: The number of files that use CommonJS modules.
- *          - `esmCount`: The number of files that use ES modules.
- */
-const check = (deps: DepsFile[], compilerOptions: ts.CompilerOptions) => {
-  try {
-    checkTypes(deps, compilerOptions);
-  } catch (err) {
-    if (err) throw new Error("Error when type checking");
-  }
-
-  const ce = checkExtGroup(deps);
-  const cm = checkModuleFormat(deps);
-  return { ...ce, ...cm };
-};
-
-export = check;

package/src/index.ts

@@ -1,244 +0,0 @@
-// cSpell:disable
-import path from "node:path";
-import ts from "typescript";
-
-interface DepsFile {
-  file: string;
-  content: string;
-}
-
-const jsesm_exts = [".js", ".mjs"];
-const jscjs_exts = [".cjs"];
-const tsesm_exts = [".ts", ".mts"];
-const tscjs_exts = [".cts"];
-const jsx_exts = [".jsx", ".tsx"];
-const all_exts = [
-  ...jscjs_exts,
-  ...jsesm_exts,
-  ...tscjs_exts,
-  ...tsesm_exts,
-  ...jsx_exts,
-];
-
-/**
- * Check types of given files and exit process if any errors are found.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @param compilerOptions TypeScript compiler options.
- * @returns True if no errors are found, false otherwise.
- */
-function checkTypes(deps: DepsFile[], compilerOptions: ts.CompilerOptions) {
-  if (!compilerOptions.noCheck) {
-    console.time("types checked");
-    const filePaths = deps.map((i) => i.file);
-    let _err = false;
-    // Create program
-    const program = ts.createProgram(filePaths, compilerOptions);
-    // Check each file individually for immediate feedback
-    for (const filePath of filePaths) {
-      const sourceFile = program.getSourceFile(filePath);
-      if (!sourceFile) {
-        console.error(
-          `File not found: ${path.relative(process.cwd(), filePath)}`,
-        );
-        process.exit(1);
-      }
-
-      const diagnostics = [
-        ...program.getSyntacticDiagnostics(sourceFile),
-        ...program.getSemanticDiagnostics(sourceFile),
-        ...program.getDeclarationDiagnostics(sourceFile),
-      ];
-
-      if (diagnostics.length > 0) {
-        const formatHost: ts.FormatDiagnosticsHost = {
-          getCurrentDirectory: () => process.cwd(),
-          getCanonicalFileName: (fileName) => fileName,
-          getNewLine: () => ts.sys.newLine,
-        };
-        console.error(
-          ts.formatDiagnosticsWithColorAndContext(diagnostics, formatHost),
-        );
-        _err = true;
-      }
-    }
-    if (_err) {
-      process.exit(1);
-    } else {
-      console.timeEnd("types checked");
-      return true;
-    }
-  }
-}
-
-/**
- * Check if all files in the given list have the same file extension.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @returns An object with the following properties:
- *          - `isNone`: True if none of the files have any of the supported
- *            extensions (i.e., not .js, .jsx, .ts, .tsx, .cts, .mts,
- *            .cjs).
- *          - `isJsx`: True if all files have .jsx or .tsx extensions.
- *          - `isCjs`: True if all files have .js or .cjs extensions.
- *          - `isBoth`: True if all files have both .js and .ts extensions.
- *          - `isJs`: True if all files have .js or .jsx extensions.
- *          - `isTs`: True if all files have .ts or .tsx extensions.
- */
-function checkExtGroup(deps: DepsFile[]) {
-  const exts = deps.map((dep) => {
-    return path.extname(dep.file);
-  });
-  const jsesmSet = new Set(jsesm_exts);
-  const jscjsSet = new Set(jscjs_exts);
-  const tsesmSet = new Set(tsesm_exts);
-  const tscjsSet = new Set(tscjs_exts);
-  const jsxSet = new Set(jsx_exts);
-  const allSet = new Set(all_exts);
-  const isCjs =
-    exts.every((i) => jscjsSet.has(i)) || exts.every((i) => tscjsSet.has(i));
-  const isJsx = exts.every((i) => jsxSet.has(i));
-  const isJs = exts.every((i) => jsesmSet.has(i));
-  const isTs = exts.every((i) => tsesmSet.has(i));
-  const isBoth = isJs && isTs;
-  const isNone = !exts.every((i) => allSet.has(i));
-  return {
-    isNone,
-    isJsx,
-    isCjs,
-    isBoth,
-    isJs,
-    isTs,
-  };
-}
-
-/**
- * Check the module format of all the given files.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @returns An object with the following properties:
- *          - `unknowCount`: Number of files that could not be checked due to
- *            errors.
- *          - `cjsCount`: Number of files that have CommonJS module syntax.
- */
-function checkModuleFormat(deps: DepsFile[]) {
-  let _esmCount = 0;
-  let cjsCount = 0;
-  let unknowCount = 0;
-  for (const dep of deps) {
-    try {
-      // Create a TypeScript source file
-      const sourceFile = ts.createSourceFile(
-        dep.file,
-        dep.content,
-        ts.ScriptTarget.Latest,
-        true,
-      );
-
-      let hasESMImports = false;
-      let hasCommonJS = false;
-      // Walk through the AST to detect module syntax
-      function walk(node: ts.Node) {
-        // Check for ESM import/export syntax
-        if (
-          ts.isImportDeclaration(node) ||
-          ts.isImportEqualsDeclaration(node) ||
-          ts.isExportDeclaration(node) ||
-          ts.isExportSpecifier(node) ||
-          ts.isExportAssignment(node)
-        ) {
-          hasESMImports = true;
-        }
-
-        // Check for export modifier on declarations
-        if (
-          (ts.isVariableStatement(node) ||
-            ts.isFunctionDeclaration(node) ||
-            ts.isInterfaceDeclaration(node) ||
-            ts.isTypeAliasDeclaration(node) ||
-            ts.isEnumDeclaration(node) ||
-            ts.isClassDeclaration(node)) &&
-          node.modifiers?.some(
-            (mod) => mod.kind === ts.SyntaxKind.ExportKeyword,
-          )
-        ) {
-          hasESMImports = true;
-        }
-
-        // Check for CommonJS require/exports
-        if (ts.isCallExpression(node)) {
-          if (
-            ts.isIdentifier(node.expression) &&
-            node.expression.text === "require" &&
-            node.arguments.length > 0
-          ) {
-            hasCommonJS = true;
-          }
-        }
-
-        // Check for module.exports or exports.xxx
-        if (ts.isPropertyAccessExpression(node)) {
-          const text = node.getText(sourceFile);
-          if (
-            text.startsWith("module.exports") ||
-            text.startsWith("exports.")
-          ) {
-            hasCommonJS = true;
-          }
-        }
-
-        // Continue walking the AST
-        ts.forEachChild(node, walk);
-      }
-      walk(sourceFile);
-
-      // Determine the module format based on what we found
-      if (hasESMImports && !hasCommonJS) {
-        _esmCount++;
-      } else if (hasCommonJS && !hasESMImports) {
-        cjsCount++;
-      } else if (hasESMImports && hasCommonJS) {
-        // Mixed - probably ESM with dynamic imports or similar
-        _esmCount++;
-      }
-    } catch (error) {
-      console.error(
-        `Error checking module format for ${dep.file} : \n ${error}`,
-      );
-      unknowCount++;
-    }
-  } // loop
-  //
-  return { unknowCount, cjsCount };
-}
-
-/**
- * Check TypeScript files for errors and determine their module format.
- * @param deps List of files to check, where each file is an object with
- *          `file` and `content` properties.
- * @param compilerOptions TypeScript compiler options.
- * @returns An object with the following properties:
- *          - `isNone`: True if none of the files have any of the supported
- *            extensions (i.e., not .js, .jsx, .ts, .tsx, .cts, .mts, .cjs).
- *          - `isJsx`: True if all files have .jsx or .tsx extensions.
- *          - `isCjs`: True if all files have .js or .cjs extensions.
- *          - `isBoth`: True if all files have both .js and .ts extensions.
- *          - `isJs`: True if all files have .js or .jsx extensions.
- *          - `isTs`: True if all files have .ts or .tsx extensions.
- *          - `unknowCount`: The number of files that could not be checked.
- *          - `cjsCount`: The number of files that use CommonJS modules.
- *          - `esmCount`: The number of files that use ES modules.
- */
-const check = (deps: DepsFile[], compilerOptions: ts.CompilerOptions) => {
-  try {
-    checkTypes(deps, compilerOptions);
-  } catch (err) {
-    if (err) throw new Error("Error when type checking");
-  }
-
-  const ce = checkExtGroup(deps);
-  const cm = checkModuleFormat(deps);
-  return { ...ce, ...cm };
-};
-
-export default check;

package/tsconfig.json

@@ -1,44 +0,0 @@
-{
-  // Visit https://aka.ms/tsconfig to read more about this file
-  "compilerOptions": {
-    // File Layout
-    "rootDir": "./src",
-    "outDir": "./dist",
-
-    // Environment Settings
-    // See also https://aka.ms/tsconfig/module
-    "module": "nodenext",
-    "target": "esnext",
-    //"types": [],
-    // For nodejs:
-    "lib": ["esnext"],
-    "types": ["node"],
-    // and npm install -D @types/node
-
-    // Other Outputs
-    "sourceMap": true,
-    "declaration": true,
-    "declarationMap": true,
-
-    // Stricter Typechecking Options
-    "noUncheckedIndexedAccess": true,
-    "exactOptionalPropertyTypes": true,
-
-    // Style Options
-    // "noImplicitReturns": true,
-    // "noImplicitOverride": true,
-    // "noUnusedLocals": true,
-    // "noUnusedParameters": true,
-    // "noFallthroughCasesInSwitch": true,
-    // "noPropertyAccessFromIndexSignature": true,
-
-    // Recommended Options
-    "strict": true,
-    "jsx": "react-jsx",
-    "verbatimModuleSyntax": true,
-    "isolatedModules": true,
-    "noUncheckedSideEffectImports": true,
-    "moduleDetection": "force",
-    "skipLibCheck": true
-  }
-}