doc: add descriptions and links in npm page

This commit is contained in:
HerringtonDarkholme
2023-08-03 13:41:46 -07:00
parent 8f82af7d57
commit 3be376400a
4 changed files with 35 additions and 6 deletions
+15 -5
View File
@@ -1,6 +1,17 @@
# @ast-grep/napi
See https://github.com/ast-grep/ast-grep
<p align=center>
<img src="https://ast-grep.github.io/logo.svg" alt="ast-grep"/>
</p>
## ast-grep(sg)
ast-grep(sg) is a CLI tool for code structural search, lint, and rewriting.
This npm package is for programmatic usage of ast-grep.
Please see the [API usage guide](https://ast-grep.github.io/guide/api-usage.html) and [API reference](https://ast-grep.github.io/reference/api.html).
Other resources include [ast-grep's official site](https://ast-grep.github.io/) and [repository](https://github.com/ast-grep/ast-grep).
## Support matrix
@@ -12,13 +23,12 @@ See https://github.com/ast-grep/ast-grep
| macOS x64 | ✓ | ✓ | ✓ |
| macOS arm64 | ✓ | ✓ | ✓ |
| Linux x64 gnu | ✓ | ✓ | ✓ |
<!-- | Windows x32 | ✓ | ✓ | ✓ | -->
<!-- | Windows arm64 | ✓ | ✓ | ✓ | -->
<!-- | Linux x64 musl | ✓ | ✓ | ✓ | -->
| Windows x32 | ✓ | ✓ | ✓ |
| Windows arm64 | ✓ | ✓ | ✓ |
<!-- | Linux arm gnu | ✓ | ✓ | ✓ | -->
<!-- | Linux x64 musl | ✓ | ✓ | ✓ | -->
<!-- | Linux arm64 gnu | ✓ | ✓ | ✓ | -->
<!-- | Linux arm64 musl | ✓ | ✓ | ✓ | -->
<!-- | Android arm64 | ✓ | ✓ | ✓ | -->
<!-- | Android armv7 | ✓ | ✓ | ✓ | -->
<!-- | FreeBSD x64 | ✓ | ✓ | ✓ | -->
+1
View File
@@ -2,6 +2,7 @@
"name": "@ast-grep/napi",
"version": "0.10.0",
"description": "Search and Rewrite code at large scale using precise AST pattern",
"homepage": "https://ast-grep.github.io",
"main": "index.js",
"repository": "https://github.com/ast-grep/ast-grep",
"license": "MIT",
+10 -1
View File
@@ -1,3 +1,12 @@
# @ast-grep/cli
Please see https://github.com/ast-grep/ast-grep
<p align=center>
<img src="https://ast-grep.github.io/logo.svg" alt="ast-grep"/>
</p>
## ast-grep(sg)
ast-grep(sg) is a CLI tool for code structural search, lint, and rewriting.
Please see [ast-grep's official site](https://ast-grep.github.io/) and [repository](https://github.com/ast-grep/ast-grep)
for more information.
+9
View File
@@ -4,10 +4,19 @@
"publishConfig": {
"access": "public"
},
"description": "Search and Rewrite code at large scale using precise AST pattern",
"homepage": "https://ast-grep.github.io",
"repository": "https://github.com/ast-grep/ast-grep",
"engines": {
"node": ">= 12.0.0"
},
"keywords": [
"ast",
"pattern",
"codemod",
"search",
"rewrite"
],
"files": [
"sg",
"ast-grep",