Merge pull request #67 from atom-community/binding-types

Author: aminya

.eslintrc.json

@@ -1,4 +1,4 @@
 {
   "extends": "eslint-config-atomic",
-  "ignorePatterns": ["./index.*", "build/", "node_modules/", "dist-test/"]
+  "ignorePatterns": ["index.js", "index.d.ts", "build/", "node_modules/", "dist-test/"]
 }

src/binding/binding.d.ts

@@ -0,0 +1,29 @@
+import type { Tree, TreeFilterResult } from "./node"
+
+export declare class Zadeh {
+  constructor()
+
+  filter(query: string, maxResult: number, usePathScoring: boolean, useExtensionBonus: boolean): Array<number>
+
+  setArrayFiltererCandidates(candidateStrings: Array<string>): boolean
+
+  filterTree(
+    query: string,
+    maxResult: number,
+    usePathScoring: boolean,
+    useExtensionBonus: boolean
+  ): Array<TreeFilterResult>
+
+  setTreeFiltererCandidates(candidateTrees: Array<Tree>, dataKey: string, childrenKey: string): boolean
+}
+
+export declare function score(
+  candidate: string,
+  query: string,
+  usePathScoring: boolean,
+  useExtensionBonus: boolean
+): number
+
+export declare function match(str: string, query: string, pathSeparator: string): Array<number>
+
+export declare function wrap(str: string, query: string, pathSeparator: string): string

src/binding/node.ts

@@ -1,6 +1,8 @@
 // @ts-ignore
 import nodeGypBuld from "node-gyp-build"
-const binding = nodeGypBuld(__dirname) // this relies on Parcel to bundle this file in the root of the package, so __dirname becomes correct
+
+import * as Binding from "./binding"
+const binding = nodeGypBuld(__dirname) as typeof Binding // __dirname relies on Parcel to bundle this file in the root of the package, so __dirname becomes correct
 
 /*
  ██████  ██████  ████████ ██  ██████  ███    ██ ███████
@@ -114,7 +116,7 @@ export class ArrayFilterer<T extends StringOrObjectArray> {
    * @param candidates An array of tree objects.
    * @param dataKey (optional) if `candidates` is an array of objects, pass the key in the object which holds the data.
    */
-  setCandidates(candidates: Array<T>, dataKey?: string): void {
+  setCandidates(candidates: Array<T>, dataKey?: string) {
     this.candidates = candidates
     let candidateStrings: string[]
     if (dataKey) {
@@ -135,7 +137,7 @@ export class ArrayFilterer<T extends StringOrObjectArray> {
     parseFilterOptions(options)
     const res = this.obj.filter(
       query,
-      options.maxResults,
+      options.maxResults as number /* numberified by parseFilterOptions */,
       Boolean(options.usePathScoring),
       Boolean(options.useExtensionBonus)
     )
@@ -186,7 +188,7 @@ export interface TreeFilterResult {
 /** TreeFilterer is a class that allows to set the `candidates` only once and perform filtering on them multiple times.
  *  This is much more efficient than calling the `filterTree` function directly.
  */
-export class TreeFilterer<T> {
+export class TreeFilterer<T extends Tree = Tree> {
   obj = new binding.Zadeh()
   // @ts-ignore
   candidates: Array<T>
@@ -204,7 +206,7 @@ export class TreeFilterer<T> {
    * @param dataKey the key of the object (and its children) which holds the data (defaults to `"data"`)
    * @param childrenKey the key of the object (and its children) which hold the children (defaults to `"children"`)
    */
-  setCandidates(candidates: Array<T>, dataKey: string = "data", childrenKey: string = "children"): void {
+  setCandidates(candidates: Array<T>, dataKey: string = "data", childrenKey: string = "children") {
     this.candidates = candidates
     return this.obj.setTreeFiltererCandidates(candidates, dataKey, childrenKey)
   }
@@ -218,7 +220,7 @@ export class TreeFilterer<T> {
     parseFilterOptions(options)
     return this.obj.filterTree(
       query,
-      options.maxResults,
+      options.maxResults as number /* numberified by parseFilterOptions */,
       Boolean(options.usePathScoring),
       Boolean(options.useExtensionBonus)
     )
@@ -289,11 +291,11 @@ export function match(str: string, query: string, options: IOptions = {}): numbe
     console.warn(`Zadeh: bad input to match str: ${str}, query: ${query}`)
     return []
   }
-  if (str == query) {
+  if (str === query) {
     return Array.from(Array(str.length).keys())
   }
   parseOptions(options)
-  return binding.match(str, query, options.pathSeparator)
+  return binding.match(str, query, options.pathSeparator as string /* stringified by parseOption */)
 }
 
 /*
@@ -312,7 +314,7 @@ export function wrap(str: string, query: string, options: IOptions = {}): string
     return []
   }
   parseOptions(options)
-  return binding.wrap(str, query, options.pathSeparator)
+  return binding.wrap(str, query, options.pathSeparator as string /* stringified by parseOption */)
 }
 
 /*

test/filter-tree-spec.js

@@ -89,7 +89,7 @@ describe("filterTree", () => {
   // answers are os dependant because of slight differences
   // console.log(filterTree(outlineData, "text", "plainText", "children"))
   it("can search in outline data", () => {
-    process.platform === "win32" &&
+    if (process.platform === "win32") {
       expect(
         DeepEqual(filterTree(outlineData, "text", "plainText", "children"), [
           { data: "text", index: 0, level: 4 },
@@ -189,9 +189,10 @@ describe("filterTree", () => {
           { data: "updateMaxScreenLineLength", index: 29, level: 2 },
         ])
       ).toBe(true)
+    }
 
     // console.log(filterTree(outlineData, "disp", "plainText", "children"))
-    process.platform !== "linux" &&
+    if (process.platform !== "linux") {
       expect(
         DeepEqual(filterTree(outlineData, "disp", "plainText", "children"), [
           { data: "disposable", index: 3, level: 4 },
@@ -218,9 +219,10 @@ describe("filterTree", () => {
           { data: "onDidChangeCursorPosition", index: 58, level: 2 },
         ])
       ).toBe(true)
+    }
 
     // console.log(filterTree(outlineData, "dips", "plainText", "children"))
-    process.platform !== "linux" &&
+    if (process.platform !== "linux") {
       expect(
         DeepEqual(filterTree(outlineData, "dips", "plainText", "children"), [
           { data: "didUpdateStyles", index: 2, level: 3 },
@@ -257,5 +259,6 @@ describe("filterTree", () => {
           { data: "destroyFoldsContainingBufferPositions", index: 373, level: 2 },
         ])
       ).toBe(true)
+    }
   })
 })

test/tree-filterer-spec.js

@@ -35,7 +35,7 @@ describe("TreeFilterer", function () {
     treeFilterer.setCandidates(outlineData, "plainText", "children")
 
     // console.log(treeFilterer.filter("text"))
-    process.platform === "win32" &&
+    if (process.platform === "win32") {
       expect(
         DeepEqual(treeFilterer.filter("text"), [
           { data: "text", index: 0, level: 4 },
@@ -135,9 +135,10 @@ describe("TreeFilterer", function () {
           { data: "updateMaxScreenLineLength", index: 29, level: 2 },
         ])
       ).toBe(true)
+    }
 
     // console.log(treeFilterer.filter("disp"))
-    process.platform !== "linux" &&
+    if (process.platform !== "linux") {
       expect(
         DeepEqual(treeFilterer.filter("disp"), [
           { data: "disposable", index: 3, level: 4 },
@@ -164,9 +165,10 @@ describe("TreeFilterer", function () {
           { data: "onDidChangeCursorPosition", index: 58, level: 2 },
         ])
       ).toBe(true)
+    }
 
     // console.log(treeFilterer.filter("dips"))
-    process.platform !== "linux" &&
+    if (process.platform !== "linux") {
       expect(
         DeepEqual(treeFilterer.filter("dips"), [
           { data: "didUpdateStyles", index: 2, level: 3 },
@@ -203,5 +205,6 @@ describe("TreeFilterer", function () {
           { data: "destroyFoldsContainingBufferPositions", index: 373, level: 2 },
         ])
       ).toBe(true)
+    }
   })
 })