@ast-grep/napi 0.1.0 → 0.1.4

package/README.md

@@ -1,21 +1,6 @@
-# `@napi-rs/package-template`
+# @ast-grep/napi
 
-![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
-```
+See https://github.com/HerringtonDarkholme/ast-grep
 
 ## Support matrix
 
@@ -37,69 +22,3 @@ yarn add @napi-rs/package-template
 <!-- | 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.js

@@ -30,7 +30,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.android-arm64.node')
           } else {
-            nativeBinding = require('ast-grep-napi-android-arm64')
+            nativeBinding = require('@ast-grep/napi-android-arm64')
           }
         } catch (e) {
           loadError = e
@@ -42,7 +42,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.android-arm-eabi.node')
           } else {
-            nativeBinding = require('ast-grep-napi-android-arm-eabi')
+            nativeBinding = require('@ast-grep/napi-android-arm-eabi')
           }
         } catch (e) {
           loadError = e
@@ -62,7 +62,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.win32-x64-msvc.node')
           } else {
-            nativeBinding = require('ast-grep-napi-win32-x64-msvc')
+            nativeBinding = require('@ast-grep/napi-win32-x64-msvc')
           }
         } catch (e) {
           loadError = e
@@ -76,7 +76,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.win32-ia32-msvc.node')
           } else {
-            nativeBinding = require('ast-grep-napi-win32-ia32-msvc')
+            nativeBinding = require('@ast-grep/napi-win32-ia32-msvc')
           }
         } catch (e) {
           loadError = e
@@ -90,7 +90,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.win32-arm64-msvc.node')
           } else {
-            nativeBinding = require('ast-grep-napi-win32-arm64-msvc')
+            nativeBinding = require('@ast-grep/napi-win32-arm64-msvc')
           }
         } catch (e) {
           loadError = e
@@ -108,7 +108,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.darwin-x64.node')
           } else {
-            nativeBinding = require('ast-grep-napi-darwin-x64')
+            nativeBinding = require('@ast-grep/napi-darwin-x64')
           }
         } catch (e) {
           loadError = e
@@ -122,7 +122,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.darwin-arm64.node')
           } else {
-            nativeBinding = require('ast-grep-napi-darwin-arm64')
+            nativeBinding = require('@ast-grep/napi-darwin-arm64')
           }
         } catch (e) {
           loadError = e
@@ -141,7 +141,7 @@ switch (platform) {
       if (localFileExisted) {
         nativeBinding = require('./ast-grep-napi.freebsd-x64.node')
       } else {
-        nativeBinding = require('ast-grep-napi-freebsd-x64')
+        nativeBinding = require('@ast-grep/napi-freebsd-x64')
       }
     } catch (e) {
       loadError = e
@@ -158,7 +158,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./ast-grep-napi.linux-x64-musl.node')
             } else {
-              nativeBinding = require('ast-grep-napi-linux-x64-musl')
+              nativeBinding = require('@ast-grep/napi-linux-x64-musl')
             }
           } catch (e) {
             loadError = e
@@ -171,7 +171,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./ast-grep-napi.linux-x64-gnu.node')
             } else {
-              nativeBinding = require('ast-grep-napi-linux-x64-gnu')
+              nativeBinding = require('@ast-grep/napi-linux-x64-gnu')
             }
           } catch (e) {
             loadError = e
@@ -187,7 +187,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./ast-grep-napi.linux-arm64-musl.node')
             } else {
-              nativeBinding = require('ast-grep-napi-linux-arm64-musl')
+              nativeBinding = require('@ast-grep/napi-linux-arm64-musl')
             }
           } catch (e) {
             loadError = e
@@ -200,7 +200,7 @@ switch (platform) {
             if (localFileExisted) {
               nativeBinding = require('./ast-grep-napi.linux-arm64-gnu.node')
             } else {
-              nativeBinding = require('ast-grep-napi-linux-arm64-gnu')
+              nativeBinding = require('@ast-grep/napi-linux-arm64-gnu')
             }
           } catch (e) {
             loadError = e
@@ -215,7 +215,7 @@ switch (platform) {
           if (localFileExisted) {
             nativeBinding = require('./ast-grep-napi.linux-arm-gnueabihf.node')
           } else {
-            nativeBinding = require('ast-grep-napi-linux-arm-gnueabihf')
+            nativeBinding = require('@ast-grep/napi-linux-arm-gnueabihf')
           }
         } catch (e) {
           loadError = e

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ast-grep/napi",
-  "version": "0.1.0",
+  "version": "0.1.4",
   "description": "Search and Rewrite code at large scale using precise AST pattern",
   "main": "index.js",
   "repository": "https://github.com/HerringtonDarkholme/ast-grep",
@@ -47,7 +47,7 @@
     "@swc-node/register": "1.5.1",
     "ava": "4.3.3",
     "chalk": "5.0.1",
-    "typescript": "4.8.2"
+    "typescript": "4.8.3"
   },
   "ava": {
     "require": [
@@ -64,11 +64,11 @@
   },
   "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"
+    "@ast-grep/napi-win32-x64-msvc": "0.1.4",
+    "@ast-grep/napi-darwin-x64": "0.1.4",
+    "@ast-grep/napi-linux-x64-gnu": "0.1.4",
+    "@ast-grep/napi-win32-ia32-msvc": "0.1.4",
+    "@ast-grep/napi-darwin-arm64": "0.1.4",
+    "@ast-grep/napi-win32-arm64-msvc": "0.1.4"
   }
 }