@rust-gear/glob 0.2.0

package/README.md

@@ -0,0 +1,55 @@
+# rust-glob
+
+A high-performance globbing library for Node.js, powered by native Rust code.
+
+## Installation
+
+```sh
+npm install --save-dev @rust-gear/glob
+```
+
+## Usage
+
+```js
+import { globSync, glob } from "@rust-gear/glob";
+
+const files = globSync("src/**/*.rs", { cwd: process.cwd() });
+console.log(files);
+
+const filesAsync = await glob("src/**/*.rs", { cwd: process.cwd() });
+console.log(filesAsync);
+```
+
+## Options
+
+You must pass an options object as the second argument to `globSync`/`glob`.  
+The `cwd` option is **required**.
+
+> **Note:**  
+> If you need to search an absolute path, set it as `cwd` and use a relative pattern.
+
+| Option  | Type     | Description                                            |
+| :------ | :------- | :----------------------------------------------------- |
+| cwd     | string   | **(Required)** Current working directory for searching |
+| exclude | string[] | Array of glob patterns to exclude                      |
+
+### Example
+
+```js
+const files = globSync("**/*.rs", {
+  cwd: "src",
+  exclude: ["**/test/**", "**/target/**"],
+});
+```
+
+## API
+
+**globSync(pattern: string \| string[], options: GlobOptions): string[]**  
+Synchronously returns an array of file paths.
+
+**glob(pattern: string \| string[], options: GlobOptions): Promise<string[]>**  
+Asynchronously returns an array of file paths.
+
+## License
+
+Apache-2.0

package/index.d.ts

@@ -0,0 +1,11 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface GlobOptions {
+  exclude?: Array<string>
+  cwd: string
+}
+export declare function globSync(patterns: string | Array<string>, options: GlobOptions): Array<string>
+export declare function glob(patterns: string | Array<string>, options: GlobOptions): Promise<Array<string>>

package/index.js

@@ -0,0 +1,316 @@
+/* tslint:disable */
+/* eslint-disable */
+/* prettier-ignore */
+
+/* auto-generated by NAPI-RS */
+
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim()
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'glob.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.android-arm64.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'glob.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'glob.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'glob.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'glob.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'glob.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./glob.darwin-universal.node')
+      } else {
+        nativeBinding = require('@rust-gear/glob-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'glob.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.darwin-x64.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'glob.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.darwin-arm64.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'glob.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./glob.freebsd-x64.node')
+      } else {
+        nativeBinding = require('@rust-gear/glob-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-arm-musleabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-arm-musleabihf.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-arm-musleabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-arm-gnueabihf.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-arm-gnueabihf.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-arm-gnueabihf')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'riscv64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-riscv64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-riscv64-musl.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-riscv64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'glob.linux-riscv64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./glob.linux-riscv64-gnu.node')
+            } else {
+              nativeBinding = require('@rust-gear/glob-linux-riscv64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 's390x':
+        localFileExisted = existsSync(
+          join(__dirname, 'glob.linux-s390x-gnu.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./glob.linux-s390x-gnu.node')
+          } else {
+            nativeBinding = require('@rust-gear/glob-linux-s390x-gnu')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { globSync, glob } = nativeBinding
+
+module.exports.globSync = globSync
+module.exports.glob = glob

package/index.mjs

@@ -0,0 +1,5 @@
+import { createRequire } from "node:module";
+const require = createRequire(import.meta.url);
+const { globSync, glob } = require("./index.js");
+
+export { globSync, glob };

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@rust-gear/glob",
+  "version": "0.2.0",
+  "description": "Node.js bindings for Rust glob library",
+  "keywords": [
+    "rust-gear",
+    "glob",
+    "napi",
+    "napi-rs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rust-gear-project/rust-gear.git"
+  },
+  "license": "Apache-2.0",
+  "author": "Refirst",
+  "main": "index.js",
+  "module": "index.mjs",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.mjs",
+    "index.d.ts"
+  ],
+  "napi": {
+    "name": "glob",
+    "triples": [
+      "darwin-arm64",
+      "darwin-x64",
+      "linux-arm64-gnu",
+      "linux-arm64-musl",
+      "linux-x64-gnu",
+      "linux-x64-musl",
+      "win32-x64-msvc",
+      "win32-ia32-msvc",
+      "win32-arm64-msvc"
+    ]
+  },
+  "scripts": {
+    "build": "napi build --platform --release",
+    "packages": "node ../../scripts/generate-platform-packages.js",
+    "readme": "node ../../scripts/generate-platform-readme.js",
+    "test": "node -r kpx test/test.ts"
+  },
+  "engines": {
+    "node": ">=10"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^2.18.4"
+  },
+  "optionalDependencies": {
+    "@rust-gear/glob-darwin-arm64": "0.2.0",
+    "@rust-gear/glob-darwin-x64": "0.2.0",
+    "@rust-gear/glob-linux-arm64-gnu": "0.2.0",
+    "@rust-gear/glob-linux-arm64-musl": "0.2.0",
+    "@rust-gear/glob-linux-x64-gnu": "0.2.0",
+    "@rust-gear/glob-linux-x64-musl": "0.2.0",
+    "@rust-gear/glob-win32-arm64-msvc": "0.2.0",
+    "@rust-gear/glob-win32-ia32-msvc": "0.2.0",
+    "@rust-gear/glob-win32-x64-msvc": "0.2.0"
+  }
+}