feat: add syntax replacements using web-features-codemods

package.json

@@ -47,8 +47,10 @@
   "homepage": "https://github.com/e18e/cli#readme",
   "dependencies": {
     "@clack/prompts": "^1.3.0",
+    "@e18e/web-features-codemods": "^0.2.0",
     "fast-wrap-ansi": "^0.2.0",
     "@publint/pack": "^0.1.4",
+    "fast-wrap-ansi": "^0.2.0",
     "fdir": "^6.5.0",
     "gunshi": "^0.29.5",
     "lockparse": "^0.5.0",

src/analyze/core-js.ts

@@ -2,6 +2,7 @@ import {glob} from 'tinyglobby';
 import {minVersion} from 'semver';
 import {relative, join} from 'path';
 import type {AnalysisContext, ReportPluginResult} from '../types.js';
+import {SOURCE_GLOB, SOURCE_IGNORE} from '../utils/source-files.js';
 
 import coreJsCompat from 'core-js-compat';
 
@@ -12,15 +13,6 @@ const BROAD_IMPORTS = new Set([
   'core-js/full'
 ]);
 
-const SOURCE_GLOB = ['**/*.{js,ts,mjs,cjs,jsx,tsx}'];
-const SOURCE_IGNORE = [
-  '**/node_modules/**',
-  '**/dist/**',
-  '**/build/**',
-  '**/coverage/**',
-  '**/lib/**'
-];
-
 const IMPORT_RE =
   /(?:import\s+(?:.*\s+from\s+)?|require\s*\()\s*['"]([^'"]+)['"]/g;
 

src/analyze/report.ts

@@ -17,13 +17,15 @@ import {getPackageJson, detectLockfile} from '../utils/package-json.js';
 import {parse as parseLockfile} from 'lockparse';
 import {runDuplicateDependencyAnalysis} from './duplicate-dependencies.js';
 import {runCoreJsAnalysis} from './core-js.js';
+import {runWebFeaturesCodemodsAnalysis} from './web-features-codemods.js';
 
 const plugins: ReportPlugin[] = [
   runPublint,
   runReplacements,
   runDependencyAnalysis,
   runDuplicateDependencyAnalysis,
-  runCoreJsAnalysis
+  runCoreJsAnalysis,
+  runWebFeaturesCodemodsAnalysis
 ];
 
 async function computeInfo(fileSystem: FileSystem) {

src/analyze/web-features-codemods.ts

@@ -0,0 +1,69 @@
+import {glob} from 'tinyglobby';
+import {join, relative} from 'node:path';
+import * as WebFeatureCodemodExports from '@e18e/web-features-codemods';
+// TODO: change this once CodeMod is exported from @e18e/web-features-codemods
+import type {CodeMod} from '@e18e/web-features-codemods/lib/shared.js';
+import type {AnalysisContext, ReportPluginResult} from '../types.js';
+import {SOURCE_GLOB, SOURCE_IGNORE} from '../utils/source-files.js';
+
+function isWebFeatureCodemod(value: unknown): value is CodeMod {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    'test' in value &&
+    typeof value.test === 'function' &&
+    'apply' in value &&
+    typeof value.apply === 'function'
+  );
+}
+
+const webFeatureCodemods = Object.entries(WebFeatureCodemodExports).filter(
+  (entry): entry is [string, CodeMod] => isWebFeatureCodemod(entry[1])
+);
+
+export async function runWebFeaturesCodemodsAnalysis(
+  context: AnalysisContext
+): Promise<ReportPluginResult> {
+  const messages: ReportPluginResult['messages'] = [];
+
+  const srcGlobs = context.options?.src;
+  const patterns = srcGlobs && srcGlobs.length > 0 ? srcGlobs : SOURCE_GLOB;
+  const allFiles = await glob(patterns, {
+    cwd: context.root,
+    ignore: SOURCE_IGNORE
+  });
+  // filter out any paths that escaped context.root via ../
+  const files = allFiles.filter(
+    (f) => !relative(context.root, join(context.root, f)).startsWith('..')
+  );
+
+  for (const filePath of files) {
+    let source: string;
+    try {
+      source = await context.fs.readFile(filePath);
+    } catch {
+      continue;
+    }
+
+    const matches: string[] = [];
+    for (const [name, codemod] of webFeatureCodemods) {
+      try {
+        if (codemod.test({source})) {
+          matches.push(name);
+        }
+      } catch {
+        continue;
+      }
+    }
+
+    if (matches.length > 0) {
+      messages.push({
+        severity: 'suggestion',
+        score: 0,
+        message: `File "${filePath}" can use newer web features: ${matches.join(', ')}.`
+      });
+    }
+  }
+
+  return {messages};
+}

src/test/analyze/__snapshots__/web-features-codemods.test.ts.snap

@@ -0,0 +1,45 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`runWebFeaturesCodemodsAnalysis > handles a file with multiple matches 1`] = `
+[
+  {
+    "message": "File "index.js" can use newer web features: arrayAt, exponentiation.",
+    "score": 0,
+    "severity": "suggestion",
+  },
+]
+`;
+
+exports[`runWebFeaturesCodemodsAnalysis > handles a file with no matches 1`] = `[]`;
+
+exports[`runWebFeaturesCodemodsAnalysis > handles a file with one match 1`] = `
+[
+  {
+    "message": "File "index.js" can use newer web features: arrayAt.",
+    "score": 0,
+    "severity": "suggestion",
+  },
+]
+`;
+
+exports[`runWebFeaturesCodemodsAnalysis > handles multiple occurrences of the same match in one file 1`] = `
+[
+  {
+    "message": "File "index.js" can use newer web features: arrayAt.",
+    "score": 0,
+    "severity": "suggestion",
+  },
+]
+`;
+
+exports[`runWebFeaturesCodemodsAnalysis > ignores a file path outside of the root 1`] = `[]`;
+
+exports[`runWebFeaturesCodemodsAnalysis > respects the src option 1`] = `
+[
+  {
+    "message": "File "src/index.js" can use newer web features: arrayAt.",
+    "score": 0,
+    "severity": "suggestion",
+  },
+]
+`;