@ast-grep/napi 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 N-API for Rust
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,105 @@
+# `@napi-rs/package-template`
+
+![https://github.com/napi-rs/package-template/actions](https://github.com/napi-rs/package-template/workflows/CI/badge.svg)
+
+> Template project for writing node packages with napi-rs.
+
+# Usage
+
+1. Click **Use this template**.
+2. **Clone** your project.
+3. Run `yarn install` to install dependencies.
+4. Run `npx napi rename -n [name]` command under the project folder to rename your package.
+
+## Install this test package
+
+```
+yarn add @napi-rs/package-template
+```
+
+## Support matrix
+
+### Operating Systems
+
+|                  | node14 | node16 | node18 |
+| ---------------- | ------ | ------ | ------ |
+| Windows x64      | ✓      | ✓      | ✓      |
+| macOS x64        | ✓      | ✓      | ✓      |
+| macOS arm64      | ✓      | ✓      | ✓      |
+| Linux x64 gnu    | ✓      | ✓      | ✓      |
+<!-- | Windows x32      | ✓      | ✓      | ✓      | -->
+<!-- | Windows arm64    | ✓      | ✓      | ✓      | -->
+<!-- | Linux x64 musl   | ✓      | ✓      | ✓      | -->
+<!-- | Linux arm gnu    | ✓      | ✓      | ✓      | -->
+<!-- | Linux arm64 gnu  | ✓      | ✓      | ✓      | -->
+<!-- | Linux arm64 musl | ✓      | ✓      | ✓      | -->
+<!-- | Android arm64    | ✓      | ✓      | ✓      | -->
+<!-- | Android armv7    | ✓      | ✓      | ✓      | -->
+<!-- | FreeBSD x64      | ✓      | ✓      | ✓      | -->
+
+## Ability
+
+### Build
+
+After `yarn build/npm run build` command, you can see `package-template.[darwin|win32|linux].node` file in project root. This is the native addon built from [lib.rs](./src/lib.rs).
+
+### Test
+
+With [ava](https://github.com/avajs/ava), run `yarn test/npm run test` to testing native addon. You can also switch to another testing framework if you want.
+
+### CI
+
+With GitHub Actions, each commit and pull request will be built and tested automatically in [`node@14`, `node@16`, `@node18`] x [`macOS`, `Linux`, `Windows`] matrix. You will never be afraid of the native addon broken in these platforms.
+
+### Release
+
+Release native package is very difficult in old days. Native packages may ask developers who use it to install `build toolchain` like `gcc/llvm`, `node-gyp` or something more.
+
+With `GitHub actions`, we can easily prebuild a `binary` for major platforms. And with `N-API`, we should never be afraid of **ABI Compatible**.
+
+The other problem is how to deliver prebuild `binary` to users. Downloading it in `postinstall` script is a common way that most packages do it right now. The problem with this solution is it introduced many other packages to download binary that has not been used by `runtime codes`. The other problem is some users may not easily download the binary from `GitHub/CDN` if they are behind a private network (But in most cases, they have a private NPM mirror).
+
+In this package, we choose a better way to solve this problem. We release different `npm packages` for different platforms. And add it to `optionalDependencies` before releasing the `Major` package to npm.
+
+`NPM` will choose which native package should download from `registry` automatically. You can see [npm](./npm) dir for details. And you can also run `yarn add @napi-rs/package-template` to see how it works.
+
+## Develop requirements
+
+- Install the latest `Rust`
+- Install `Node.js@10+` which fully supported `Node-API`
+- Install `yarn@1.x`
+
+## Test in local
+
+- yarn
+- yarn build
+- yarn test
+
+And you will see:
+
+```bash
+$ ava --verbose
+
+  ✔ sync function from native code
+  ✔ sleep function from native code (201ms)
+  ─
+
+  2 tests passed
+✨  Done in 1.12s.
+```
+
+## Release package
+
+Ensure you have set your **NPM_TOKEN** in the `GitHub` project setting.
+
+In `Settings -> Secrets`, add **NPM_TOKEN** into it.
+
+When you want to release the package:
+
+```
+npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease [--preid=<prerelease-id>] | from-git]
+
+git push
+```
+
+GitHub actions will do the rest job for you.

package/index.d.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface Pos {
+  row: number
+  col: number
+}
+export interface Range {
+  start: Pos
+  end: Pos
+}
+export class SgNode {
+  range(): Range
+  isLeaf(): boolean
+  kind(): string
+  text(): string
+  matches(m: string): boolean
+  inside(m: string): boolean
+  has(m: string): boolean
+  precedes(m: string): boolean
+  follows(m: string): boolean
+  children(): Array<SgNode>
+  findByString(pattern: string): SgNode | null
+  findAll(pattern: string): Array<SgNode>
+  field(name: string): SgNode | null
+  parent(): SgNode | null
+  child(nth: number): SgNode | null
+  ancestors(): Array<SgNode>
+  next(): SgNode | null
+  nextAll(): Array<SgNode>
+  prev(): SgNode | null
+  prevAll(): Array<SgNode>
+}
+export type SgRoot = AstGrep
+export class AstGrep {
+  static html(src: string): SgRoot
+  static js(src: string): SgRoot
+  static ts(src: string): SgRoot
+  static tsx(src: string): SgRoot
+  root(): SgNode
+}

package/index.js

@@ -0,0 +1,242 @@
+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 {
+      return readFileSync('/usr/bin/ldd', '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, 'ast-grep-napi.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.android-arm64.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'ast-grep-napi.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-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, 'ast-grep-napi.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'ast-grep-napi.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'ast-grep-napi.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'ast-grep-napi.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.darwin-x64.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'ast-grep-napi.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.darwin-arm64.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-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, 'ast-grep-napi.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./ast-grep-napi.freebsd-x64.node')
+      } else {
+        nativeBinding = require('ast-grep-napi-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'ast-grep-napi.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./ast-grep-napi.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('ast-grep-napi-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'ast-grep-napi.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./ast-grep-napi.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('ast-grep-napi-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'ast-grep-napi.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./ast-grep-napi.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('ast-grep-napi-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'ast-grep-napi.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./ast-grep-napi.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('ast-grep-napi-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(
+          join(__dirname, 'ast-grep-napi.linux-arm-gnueabihf.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./ast-grep-napi.linux-arm-gnueabihf.node')
+          } else {
+            nativeBinding = require('ast-grep-napi-linux-arm-gnueabihf')
+          }
+        } 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 { SgNode, AstGrep } = nativeBinding
+
+module.exports.SgNode = SgNode
+module.exports.AstGrep = AstGrep

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@ast-grep/napi",
+  "version": "0.1.0",
+  "description": "Search and Rewrite code at large scale using precise AST pattern",
+  "main": "index.js",
+  "repository": "https://github.com/HerringtonDarkholme/ast-grep",
+  "license": "MIT",
+  "keywords": [
+    "ast",
+    "pattern",
+    "codemod",
+    "search",
+    "rewrite"
+  ],
+  "files": [
+    "index.d.ts",
+    "index.js"
+  ],
+  "napi": {
+    "name": "ast-grep-napi",
+    "triples": {
+      "defaults": true,
+      "additional": [
+        "i686-pc-windows-msvc",
+        "aarch64-apple-darwin",
+        "aarch64-pc-windows-msvc"
+      ]
+    }
+  },
+  "engines": {
+    "node": ">= 10"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "prepublishOnly": "napi prepublish -t npm",
+    "test": "ava",
+    "version": "napi version"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "2.11.4",
+    "@swc-node/register": "1.5.1",
+    "ava": "4.3.3",
+    "chalk": "5.0.1",
+    "typescript": "4.8.2"
+  },
+  "ava": {
+    "require": [
+      "@swc-node/register"
+    ],
+    "extensions": [
+      "ts"
+    ],
+    "timeout": "2m",
+    "workerThreads": false,
+    "environmentVariables": {
+      "TS_NODE_PROJECT": "./tsconfig.json"
+    }
+  },
+  "packageManager": "yarn@3.2.3",
+  "optionalDependencies": {
+    "@ast-grep/napi-win32-x64-msvc": "0.1.0",
+    "@ast-grep/napi-darwin-x64": "0.1.0",
+    "@ast-grep/napi-linux-x64-gnu": "0.1.0",
+    "@ast-grep/napi-win32-ia32-msvc": "0.1.0",
+    "@ast-grep/napi-darwin-arm64": "0.1.0",
+    "@ast-grep/napi-win32-arm64-msvc": "0.1.0"
+  }
+}