fix(deps): replace string-similarity with fastest-levenshtein (#5759)

* fix(deps): replace string-similarity with fastest-levenshtein

string-similarity is no longer maintained and deprecated, resulting in
another warning when installing Netlify CLI.

While the algorithm is different (Levenshtein distance instead of Dice's
coefficient), the difference shouldn't be big enough to matter as this
is only used for suggestion after a typo.

* chore(main): add tests for typo suggestion

* fix(recipes): suggest a replacement on typo again

When the user specifies a recipe that doesn't exist, the recipes command
is supposed to suggest a replacement. The way it detects this scenario
is to catch the module not found error, but it was catching
MODULE_NOT_FOUND, which is only thrown for CommonJS modules:

> MODULE_NOT_FOUND
>
> A module file could not be resolved by the CommonJS modules loader
> while attempting a require() operation or when loading the program entry
> point.
>
> --- https://nodejs.org/api/errors.html#module_not_found

For ESM modules, when a module isn't found, the ERR_MODULE_NOT_FOUND
error is thrown instead:

> ERR_MODULE_NOT_FOUND
>
> A module file could not be resolved by the ECMAScript modules loader
> while attempting an import operation or when loading the program entry
> point.
>
> --- https://nodejs.org/api/errors.html#err_module_not_found

This commit makes it catch ERR_MODULE_NOT_FOUND instead.

---------

Co-authored-by: Simon Knott <[email protected]>

Author: kisaragi-hiu

package-lock.json

@@ -117,6 +117,7 @@
     "express": "4.18.2",
     "express-logging": "1.1.1",
     "extract-zip": "2.0.1",
+    "fastest-levenshtein": "1.0.16",
     "fastify": "4.17.0",
     "find-up": "6.3.0",
     "flush-write-stream": "2.0.0",
@@ -167,7 +168,6 @@
     "read-pkg-up": "9.1.0",
     "semver": "7.5.1",
     "source-map-support": "0.5.21",
-    "string-similarity": "4.0.4",
     "strip-ansi-control-characters": "2.0.0",
     "tabtab": "3.0.2",
     "tempy": "3.0.0",

package.json

@@ -2,8 +2,8 @@
 import process from 'process'
 
 import { Option } from 'commander'
+import { closest } from 'fastest-levenshtein'
 import inquirer from 'inquirer'
-import { findBestMatch } from 'string-similarity'
 
 import { BANG, chalk, error, exit, log, NETLIFY_CYAN, USER_AGENT, warn } from '../utils/command-helpers.mjs'
 import execa from '../utils/execa.mjs'
@@ -118,9 +118,7 @@ const mainCommand = async function (options, command) {
   warn(`${chalk.yellow(command.args[0])} is not a ${command.name()} command.`)
 
   const allCommands = command.commands.map((cmd) => cmd.name())
-  const {
-    bestMatch: { target: suggestion },
-  } = findBestMatch(command.args[0], allCommands)
+  const suggestion = closest(command.args[0], allCommands)
 
   const applySuggestion = await new Promise((resolve) => {
     const prompt = inquirer.prompt({

src/commands/main.mjs

@@ -1,8 +1,8 @@
 // @ts-check
 import { basename } from 'path'
 
+import { closest } from 'fastest-levenshtein'
 import inquirer from 'inquirer'
-import { findBestMatch } from 'string-similarity'
 
 import { NETLIFYDEVERR, chalk, log } from '../../utils/command-helpers.mjs'
 
@@ -28,17 +28,18 @@ const recipesCommand = async (recipeName, options, command) => {
   try {
     return await runRecipe({ config, recipeName: sanitizedRecipeName, repositoryRoot })
   } catch (error) {
-    if (error.code !== 'MODULE_NOT_FOUND') {
+    if (
+      // The ESM loader throws this instead of MODULE_NOT_FOUND
+      error.code !== 'ERR_MODULE_NOT_FOUND'
+    ) {
       throw error
     }
 
     log(`${NETLIFYDEVERR} ${chalk.yellow(recipeName)} is not a valid recipe name.`)
 
     const recipes = await listRecipes()
     const recipeNames = recipes.map(({ name }) => name)
-    const {
-      bestMatch: { target: suggestion },
-    } = findBestMatch(recipeName, recipeNames)
+    const suggestion = closest(recipeName, recipeNames)
     const applySuggestion = await new Promise((resolve) => {
       const prompt = inquirer.prompt({
         type: 'confirm',

src/commands/recipes/recipes.mjs

@@ -139,3 +139,9 @@ test('Handles JSON with comments', async (t) => {
     t.deepEqual([...settings['deno.enablePaths']], ['/some/path', 'netlify/edge-functions'])
   })
 })
+
+test('Suggests closest matching recipe on typo', async (t) => {
+  const cliResponse = await callCli(['recipes', 'vsc'])
+
+  t.snapshot(normalize(cliResponse))
+})

tests/integration/640.command.recipes.test.cjs

@@ -0,0 +1,17 @@
+const test = require('ava')
+
+const callCli = require('./utils/call-cli.cjs')
+const { normalize } = require('./utils/snapshots.cjs')
+
+test('suggests closest matching command on typo', async (t) => {
+  // failures are expected since we effectively quit out of the prompts
+  const errors = await Promise.all([
+    t.throwsAsync(() => callCli(['sta'])),
+    t.throwsAsync(() => callCli(['opeen'])),
+    t.throwsAsync(() => callCli(['hel'])),
+    t.throwsAsync(() => callCli(['versio'])),
+  ])
+  errors.forEach((error) => {
+    t.snapshot(normalize(error.stdout, { duration: true, filePath: true }))
+  })
+})

tests/integration/didyoumean.test.cjs

@@ -15,3 +15,10 @@ Generated by [AVA](https://avajs.dev).
     |--------|-------------------------------------------------------------------------|␊
     | vscode | Create VS Code settings for an optimal experience with Netlify projects |␊
     '----------------------------------------------------------------------------------'`
+
+## Suggests closest matching recipe on typo
+
+> Snapshot 1
+
+    `◈ vsc is not a valid recipe name.␊
+    ? Did you mean vscode (y/N) `

tests/integration/snapshots/640.command.recipes.test.cjs.md

@@ -0,0 +1,27 @@
+# Snapshot report for `tests/integration/didyoumean.test.cjs`
+
+The actual snapshot is saved in `didyoumean.test.cjs.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## suggests closest matching command on typo
+
+> Snapshot 1
+
+    `›   Warning: sta is not a netlify command.␊
+    ? Did you mean api (y/N) `
+
+> Snapshot 2
+
+    `›   Warning: opeen is not a netlify command.␊
+    ? Did you mean open (y/N) `
+
+> Snapshot 3
+
+    `›   Warning: hel is not a netlify command.␊
+    ? Did you mean dev (y/N) `
+
+> Snapshot 4
+
+    `›   Warning: versio is not a netlify command.␊
+    ? Did you mean serve (y/N) `