@ff-labs/fff-node 0.11.0 → 0.11.1-nightly.012980d

package/dist/index.d.ts

@@ -40,7 +40,7 @@
  */
 export { binaryExists, findBinary } from "./binary.js";
 export { closeLibrary } from "./ffi.js";
-export type { DbHealth, DirItem, DirSearchOptions, DirSearchResult, FileFinderApi, FileItem, GrepCursor, GrepMatch, GrepMode, GrepOptions, GrepResult, HealthCheck, InitOptions, Location, MixedItem, MixedSearchResult, MultiGrepOptions, Result, ScanProgress, Score, SearchOptions, SearchResult, WatchBatchCallback, WatchEvent, WatchEventKind, WatchOptions, WatchUnsubscribe, } from "./fff-api.js";
+export type { DbHealth, DirItem, DirSearchOptions, DirSearchResult, FileFinderApi, FileItem, GrepCursor, GrepMatch, GrepMode, DefinitionMode, GrepOptions, GrepResult, HealthCheck, InitOptions, Location, MixedItem, MixedSearchResult, MultiGrepOptions, Result, ScanProgress, Score, SearchOptions, SearchResult, WatchBatchCallback, WatchEvent, WatchEventKind, WatchOptions, WatchUnsubscribe, } from "./fff-api.js";
 export { err, ok } from "./fff-api.js";
 export { FileFinder } from "./finder.js";
 export { getLibExtension, getLibFilename, getNpmPackageName, getTriple, } from "./platform.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,YAAY,EACV,QAAQ,EACR,OAAO,EACP,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,QAAQ,EACR,UAAU,EACV,SAAS,EACT,QAAQ,EACR,WAAW,EACX,UAAU,EACV,WAAW,EACX,WAAW,EACX,QAAQ,EACR,SAAS,EACT,iBAAiB,EACjB,gBAAgB,EAChB,MAAM,EACN,YAAY,EACZ,KAAK,EACL,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,YAAY,EACZ,gBAAgB,GACjB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,SAAS,GACV,MAAM,eAAe,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AAEH,OAAO,EAAE,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,YAAY,EACV,QAAQ,EACR,OAAO,EACP,gBAAgB,EAChB,eAAe,EACf,aAAa,EACb,QAAQ,EACR,UAAU,EACV,SAAS,EACT,QAAQ,EACR,cAAc,EACd,WAAW,EACX,UAAU,EACV,WAAW,EACX,WAAW,EACX,QAAQ,EACR,SAAS,EACT,iBAAiB,EACjB,gBAAgB,EAChB,MAAM,EACN,YAAY,EACZ,KAAK,EACL,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,YAAY,EACZ,gBAAgB,GACjB,MAAM,cAAc,CAAC;AAEtB,OAAO,EAAE,GAAG,EAAE,EAAE,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EACL,eAAe,EACf,cAAc,EACd,iBAAiB,EACjB,SAAS,GACV,MAAM,eAAe,CAAC"}

package/dist/index.js

@@ -18,6 +18,8 @@ function getTriple() {
     osName = detectLinuxLibc();
   } else if (platform === "win32") {
     osName = "pc-windows-msvc";
+  } else if (platform === "freebsd") {
+    osName = "unknown-freebsd";
   } else {
     throw new Error(`Unsupported platform: ${platform}`);
   }
@@ -121,7 +123,12 @@ function binaryExists() {
   return findBinary() !== null;
 }
 function resolveFromNpmPackage() {
-  const packageName = getNpmPackageName();
+  let packageName;
+  try {
+    packageName = getNpmPackageName();
+  } catch {
+    return null;
+  }
   try {
     const require2 = createRequire(join(getPackageDir(), "package.json"));
     const packageJsonPath = require2.resolve(`${packageName}/package.json`);
@@ -154,6 +161,13 @@ function isDevWorkspace() {
   return existsSync(join(workspaceRoot, "Cargo.toml"));
 }
 function findBinary() {
+  const override = process.env["FFF_C_LIB"];
+  if (override) {
+    if (!existsSync(override)) {
+      throw new Error(`FFF_C_LIB points to a file that does not exist: ${override}`);
+    }
+    return override;
+  }
   if (isDevWorkspace()) {
     const binPath = join(getPackageDir(), "bin", getLibFilename());
     if (existsSync(binPath)) return binPath;
@@ -194,6 +208,23 @@ function err(error) {
 function createGrepCursor(offset) {
   return { __brand: "GrepCursor", _offset: offset };
 }
+function definitionModeToInt(mode) {
+  switch (mode) {
+    case void 0:
+    case false:
+    case "off":
+      return 0;
+    case true:
+    case "classify":
+      return 1;
+    case "definition_only":
+      return 2;
+    case "usage_only":
+      return 3;
+    default:
+      return void 0;
+  }
+}
 
 // src/ffi.ts
 var LIBRARY_KEY = "fff_c";
@@ -213,9 +244,13 @@ var FFF_CREATE_OPTIONS_STRUCT = {
   cache_budget_max_file_size: DataType.U64,
   enable_fs_root_scanning: DataType.U8,
   enable_home_dir_scanning: DataType.U8,
-  follow_symlinks: DataType.U8
+  follow_symlinks: DataType.U8,
+  extra_ignore: DataType.String,
+  disable_git: DataType.U8,
+  disable_ignore_files: DataType.U8
 };
-var FFF_CREATE_OPTIONS_VERSION = 2;
+var FFF_CREATE_OPTIONS_VERSION = 3;
+var LEGACY_CREATE_OPTIONS_VERSION = 2;
 var GREP_MODE_PLAIN = 0;
 var GREP_MODE_REGEX = 1;
 var GREP_MODE_FUZZY = 2;
@@ -367,10 +402,12 @@ function freeString(ptr) {
   } catch {
   }
 }
-function ffiCreate(basePath, frecencyDbPath, historyDbPath, _useUnsafeNoLock, enableMmapCache, enableContentIndexing, watch, aiMode, logFilePath, logLevel, cacheBudgetMaxFiles, cacheBudgetMaxBytes, cacheBudgetMaxFileSize, enableFsRootScanning, enableHomeDirScanning, followSymlinks) {
+function ffiCreate(basePath, frecencyDbPath, historyDbPath, _useUnsafeNoLock, enableMmapCache, enableContentIndexing, watch, aiMode, logFilePath, logLevel, cacheBudgetMaxFiles, cacheBudgetMaxBytes, cacheBudgetMaxFileSize, enableFsRootScanning, enableHomeDirScanning, followSymlinks, extraIgnore, disableGit = false, disableIgnoreFiles = false) {
+  if (extraIgnore.includes("\0")) return err("extraIgnore cannot contain NUL bytes");
   loadLibrary();
+  const version = extraIgnore || disableGit || disableIgnoreFiles ? FFF_CREATE_OPTIONS_VERSION : LEGACY_CREATE_OPTIONS_VERSION;
   const optsValue = {
-    version: FFF_CREATE_OPTIONS_VERSION,
+    version,
     base_path: basePath,
     frecency_db_path: frecencyDbPath,
     history_db_path: historyDbPath,
@@ -385,7 +422,10 @@ function ffiCreate(basePath, frecencyDbPath, historyDbPath, _useUnsafeNoLock, en
     cache_budget_max_file_size: cacheBudgetMaxFileSize,
     enable_fs_root_scanning: enableFsRootScanning ? 1 : 0,
     enable_home_dir_scanning: enableHomeDirScanning ? 1 : 0,
-    follow_symlinks: followSymlinks ? 1 : 0
+    follow_symlinks: followSymlinks ? 1 : 0,
+    extra_ignore: extraIgnore,
+    disable_git: disableGit ? 1 : 0,
+    disable_ignore_files: disableIgnoreFiles ? 1 : 0
   };
   const rawPtr = load({
     library: LIBRARY_KEY,
@@ -445,6 +485,7 @@ var FFF_SCORE_STRUCT = {
   distance_penalty: DataType.I32,
   current_file_penalty: DataType.I32,
   combo_match_boost: DataType.I32,
+  path_alignment_bonus: DataType.I32,
   exact_match: DataType.U8,
   match_type: DataType.External
 };
@@ -518,8 +559,8 @@ var FFF_GREP_MATCH_STRUCT = {
   match_ranges_count: DataType.U32,
   context_before_count: DataType.U32,
   context_after_count: DataType.U32,
-  fuzzy_score: DataType.U32,
-  // actually u16 in C, but ffi-rs doesn't so we read it as u32 with padding
+  fuzzy_score: DataType.I16,
+  // u16 in C; ffi-rs has no U16, so read I16 and mask (#888)
   has_fuzzy_score: DataType.U8,
   is_binary: DataType.U8,
   is_definition: DataType.U8
@@ -560,6 +601,7 @@ function readScoreFromRaw(raw) {
     distancePenalty: raw.distance_penalty,
     currentFilePenalty: raw.current_file_penalty,
     comboMatchBoost: raw.combo_match_boost,
+    pathAlignmentBonus: raw.path_alignment_bonus,
     exactMatch: raw.exact_match !== 0,
     matchType: readCString(raw.match_type) ?? ""
   };
@@ -660,7 +702,7 @@ function readGrepMatchFromRaw(raw) {
     matchRanges
   };
   if (raw.has_fuzzy_score !== 0) {
-    match.fuzzyScore = raw.fuzzy_score;
+    match.fuzzyScore = raw.fuzzy_score & 65535;
   }
   if (raw.context_before_count > 0) {
     match.contextBefore = readCStringArray(raw.context_before, raw.context_before_count);
@@ -1059,6 +1101,8 @@ function ffiSearchMixed(handle, query, currentFile, maxThreads, pageIndex, pageS
   return parseMixedSearchResult(rawPtr);
 }
 function ffiLiveGrep(handle, query, mode, maxFileSize, maxMatchesPerFile, smartCase, fileOffset, pageLimit, timeBudgetMs, enforceTimeBudget, beforeContext, afterContext, classifyDefinitions) {
+  const definitionMode = definitionModeToInt(classifyDefinitions);
+  if (definitionMode === void 0) return err("Invalid classifyDefinitions mode");
   loadLibrary();
   const rawPtr = load({
     library: LIBRARY_KEY,
@@ -1089,7 +1133,7 @@ function ffiLiveGrep(handle, query, mode, maxFileSize, maxMatchesPerFile, smartC
       // before_context
       DataType.U32,
       // after_context
-      DataType.Boolean
+      DataType.U8
       // classify_definitions
     ],
     paramsValue: [
@@ -1105,13 +1149,15 @@ function ffiLiveGrep(handle, query, mode, maxFileSize, maxMatchesPerFile, smartC
       enforceTimeBudget,
       beforeContext,
       afterContext,
-      classifyDefinitions
+      definitionMode
     ],
     freeResultMemory: false
   });
   return parseGrepResult(rawPtr);
 }
 function ffiMultiGrep(handle, patternsJoined, constraints, maxFileSize, maxMatchesPerFile, smartCase, fileOffset, pageLimit, timeBudgetMs, enforceTimeBudget, beforeContext, afterContext, classifyDefinitions) {
+  const definitionMode = definitionModeToInt(classifyDefinitions);
+  if (definitionMode === void 0) return err("Invalid classifyDefinitions mode");
   loadLibrary();
   const rawPtr = load({
     library: LIBRARY_KEY,
@@ -1142,7 +1188,7 @@ function ffiMultiGrep(handle, patternsJoined, constraints, maxFileSize, maxMatch
       // before_context
       DataType.U32,
       // after_context
-      DataType.Boolean
+      DataType.U8
       // classify_definitions
     ],
     paramsValue: [
@@ -1158,7 +1204,7 @@ function ffiMultiGrep(handle, patternsJoined, constraints, maxFileSize, maxMatch
       enforceTimeBudget,
       beforeContext,
       afterContext,
-      classifyDefinitions
+      definitionMode
     ],
     freeResultMemory: false
   });
@@ -1468,7 +1514,10 @@ var FileFinder = class _FileFinder {
       options.cacheBudgetMaxFileSize ?? 0,
       options.enableFsRootScanning ?? false,
       options.enableHomeDirScanning ?? false,
-      options.followSymlinks ?? false
+      options.followSymlinks ?? false,
+      options.extraIgnore?.join("\n") ?? "",
+      options.disableGit ?? false,
+      options.disableIgnoreFiles ?? false
     );
     if (!result.ok) {
       return result;