Skip to content

Commit 8ccd853

Browse files
BoshenBoshen
committed
docs(npm): update package homepage URLs and add keywords (#18509)
## Summary - Update homepage links to point to specific documentation pages (e.g., `https://oxc.rs/docs/guide/usage/linter`) - Add usage instruction links to napi package READMEs - Add relevant keywords for better npm discoverability 🤖 Generated with [Claude Code](https://claude.com/claude-code)
1 parent 9c67974 commit 8ccd853

File tree

10 files changed

+47
-12
lines changed

10 files changed

+47
-12
lines changed

‎napi/minify/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Oxc Minify
22

3+
See [usage instructions](https://oxc.rs/docs/guide/usage/minifier).
4+
35
This is alpha software and may yield incorrect results, feel free to [submit a bug report](https://github.com/oxc-project/oxc/issues/new?assignees=&labels=C-bug&projects=&template=bug_report.md).
46

57
### Performance and Compression Size

‎napi/minify/package.json‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,15 @@
33
"version": "0.110.0",
44
"description": "Oxc Minifier Node API",
55
"keywords": [
6+
"javascript",
7+
"minifier",
68
"minify",
7-
"oxc"
9+
"oxc",
10+
"terser",
11+
"typescript",
12+
"uglify"
813
],
9-
"homepage": "https://oxc.rs",
14+
"homepage": "https://oxc.rs/docs/guide/usage/minifier",
1015
"bugs": "https://github.com/oxc-project/oxc/issues",
1116
"license": "MIT",
1217
"author": "Boshen and oxc contributors",

‎napi/parser/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Oxc Parser
22

3+
See [usage instructions](https://oxc.rs/docs/guide/usage/parser).
4+
35
## Features
46

57
### Supports WASM

‎napi/parser/package.json‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@
33
"version": "0.110.0",
44
"description": "Oxc Parser Node API",
55
"keywords": [
6+
"ast",
7+
"estree",
8+
"javascript",
69
"oxc",
7-
"parser"
10+
"parser",
11+
"typescript"
812
],
9-
"homepage": "https://oxc.rs",
13+
"homepage": "https://oxc.rs/docs/guide/usage/parser",
1014
"bugs": "https://github.com/oxc-project/oxc/issues",
1115
"license": "MIT",
1216
"author": "Boshen and oxc contributors",

‎napi/transform/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Oxc Transform
22

3+
See [usage instructions](https://oxc.rs/docs/guide/usage/transformer).
4+
35
## TypeScript and React JSX Transform
46

57
```javascript

‎napi/transform/package.json‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,16 @@
33
"version": "0.110.0",
44
"description": "Oxc Transformer Node API",
55
"keywords": [
6+
"babel",
7+
"javascript",
8+
"jsx",
69
"oxc",
7-
"transform"
10+
"transform",
11+
"transformer",
12+
"tsx",
13+
"typescript"
814
],
9-
"homepage": "https://oxc.rs",
15+
"homepage": "https://oxc.rs/docs/guide/usage/transformer",
1016
"bugs": "https://github.com/oxc-project/oxc/issues",
1117
"license": "MIT",
1218
"author": "Boshen and oxc contributors",

‎npm/oxfmt/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The Oxidation Compiler is creating a suite of high-performance tools for JavaScr
5050

5151
This is the formatter for oxc.
5252

53-
See [usage instructions](https://oxc.rs/docs/guide/usage/formatter.html).
53+
See [usage instructions](https://oxc.rs/docs/guide/usage/formatter).
5454

5555
Run
5656

‎npm/oxfmt/package.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,15 @@
22
"name": "oxfmt",
33
"version": "0.26.0",
44
"description": "Formatter for the JavaScript Oxidation Compiler",
5-
"keywords": [],
6-
"homepage": "https://oxc.rs",
5+
"keywords": [
6+
"formatter",
7+
"javascript",
8+
"oxc",
9+
"oxfmt",
10+
"prettier",
11+
"typescript"
12+
],
13+
"homepage": "https://oxc.rs/docs/guide/usage/formatter",
714
"bugs": "https://github.com/oxc-project/oxc/issues",
815
"license": "MIT",
916
"author": "Boshen and oxc contributors",

‎npm/oxlint/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The Oxidation Compiler is creating a suite of high-performance tools for JavaScr
5050

5151
This is the linter for oxc.
5252

53-
See [usage instructions](https://oxc.rs/docs/guide/usage/linter.html).
53+
See [usage instructions](https://oxc.rs/docs/guide/usage/linter).
5454

5555
Run
5656

‎npm/oxlint/package.json‎

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,15 @@
22
"name": "oxlint",
33
"version": "1.41.0",
44
"description": "Linter for the JavaScript Oxidation Compiler",
5-
"keywords": [],
6-
"homepage": "https://oxc.rs",
5+
"keywords": [
6+
"eslint",
7+
"javascript",
8+
"linter",
9+
"oxc",
10+
"oxlint",
11+
"typescript"
12+
],
13+
"homepage": "https://oxc.rs/docs/guide/usage/linter",
714
"bugs": "https://github.com/oxc-project/oxc/issues",
815
"license": "MIT",
916
"author": "Boshen and oxc contributors",

0 commit comments

Comments
 (0)