chore: add some basic fields of package.json (web-infra-dev#1916)

* chore: complete basic fields of every package * chore: adjust fields order
RobHannay · Feb 21, 2023 · 36bcb66 · 36bcb66
1 parent 947e06e
commit 36bcb66
Show file tree

Hide file tree

Showing 19 changed files with 85 additions and 65 deletions.
diff --git a/README.md b/README.md
@@ -16,11 +16,11 @@ English | [简体中文](./README.zh-CN.md)
 - 📦 **Webpack Interoperable**: Targeted interoperability the Webpack ecosystem, no need to build your ecosystem from scratch.
 - 🎨 **Batteries Included**: Out-of-the-box support for Typescript, JSX, CSS, CSS Modules, Sass, and more.
 
-Read [Introduction](https://rspack-docs.vercel.app/guide/introduction.html) for details.
+Read [Introduction](https://rspack.org/guide/introduction.html) for details.
 
 ## Getting Started
 
-- [Quick Start](https://rspack-docs.vercel.app/guide/getting-started.html)
+- [Quick Start](https://rspack.org/guide/getting-started.html)
 
 ## Contribution
 
@@ -30,7 +30,7 @@ Please read the [contributing guide](./CONTRIBUTING.md) and let's build Rspack t
 
 ## Links
 
-- [Rspack Website](https://rspack-docs.vercel.app/)
+- [Rspack Website](https://rspack.org)
 
 ## Credits
 

diff --git a/README.zh-CN.md b/README.zh-CN.md
@@ -16,11 +16,11 @@
 - 📦 **Webpack Interoperable**: 与 Webpack 生态有很好的兼容性，无需从零构建你的生态。
 - 🎨 **Batteries Included**: 对 Typescript、JSX、CSS、CSS Modules、Sass 等提供开箱即用的支持。
 
-请阅读 [Rspack 介绍](https://rspack-docs.vercel.app/zh/guide/introduction.html) 章节来了解更多。
+请阅读 [Rspack 介绍](https://rspack.org/zh/guide/introduction.html) 章节来了解更多。
 
 ## 快速上手
 
-- [快速上手](https://rspack-docs.vercel.app/zh/guide/getting-started.html)
+- [快速上手](https://rspack.org/zh/guide/getting-started.html)
 
 ## 参与贡献
 
@@ -30,7 +30,7 @@
 
 ## 链接
 
-- [Rspack 文档](https://rspack-docs.vercel.app/)
+- [Rspack 文档](https://rspack.org)
 
 ## 致谢
 

diff --git a/crates/node_binding/package.json b/crates/node_binding/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@rspack/binding",
   "version": "0.0.22",
+  "license": "MIT",
   "description": "Node binding for rspack",
   "main": "binding.js",
   "types": "binding.d.ts",
@@ -21,9 +22,9 @@
     "build:release:win": "napi build --target x86_64-pc-windows-msvc --release --platform --js false --dts binding.d.ts --config napirs.rc.json",
     "move-binding": "node scripts/move-binding"
   },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "devDependencies": {
     "@napi-rs/cli": "2.14.2",
     "why-is-node-running": "2.2.1",

diff --git a/docs/glossary.md b/docs/glossary.md
@@ -2,18 +2,18 @@
 
 ## Module
 
-`Module` is an abstraction of a file, which could be Javascript, CSS, or any other type of file. It's holds the information that plugin care about. The bundler does not know the detail of `Module`s and only intereact with it via the [`Module` trait](https://github.com/speedy-js/rspack/blob/e55f029498d965178e36dc0882c79b76e5883bfe/crates/rspack_core/src/module.rs#L72-L94).
+`Module` is an abstraction of a file, which could be Javascript, CSS, or any other type of file. It's holds the information that plugin care about. The bundler does not know the detail of `Module`s and only intereact with it via the [`Module` trait](https://github.com/modern-js-dev/rspack/blob/e55f029498d965178e36dc0882c79b76e5883bfe/crates/rspack_core/src/module.rs#L72-L94).
 
 ## ModuleGraphModule
 
 `ModuleGraphModule` is wrapper of `Module`. It holds the `Module` object and store some extra information that bundler care about.
 
 ## ModuleType
 
-`ModuleType` is an enum that represents the type of a `Module`. When rendering a module, the module will be rendered based on each `SourceType` request. In other words, `ModuleType` does not strongly related to the actual code generation result. For types supported, you may refer to [this](https://github.com/speedy-js/rspack/blob/3d981eea519f36fe0e53cdb878dab447a4e70cc8/crates/rspack_core/src/lib.rs#L37)
+`ModuleType` is an enum that represents the type of a `Module`. When rendering a module, the module will be rendered based on each `SourceType` request. In other words, `ModuleType` does not strongly related to the actual code generation result. For types supported, you may refer to [this](https://github.com/modern-js-dev/rspack/blob/3d981eea519f36fe0e53cdb878dab447a4e70cc8/crates/rspack_core/src/lib.rs#L37)
 
 # S
 
 ## SourceType
 
-`SourceType` is used to describe the type of a code snippet. Each `Module` may contain different `SourceType`. E.g. an `Asset Module` may contain `SourceType::Javascript` and `SourceType::Asset`, which means it has the ability to render both types. The bundler will use the `SourceType` as a part of the request to request a render from a `Module`. See [this](https://github.com/speedy-js/rspack/blob/3d981eea519f36fe0e53cdb878dab447a4e70cc8/crates/rspack_core/src/lib.rs#L30) to get the full list of supported `SourceType`.
+`SourceType` is used to describe the type of a code snippet. Each `Module` may contain different `SourceType`. E.g. an `Asset Module` may contain `SourceType::Javascript` and `SourceType::Asset`, which means it has the ability to render both types. The bundler will use the `SourceType` as a part of the request to request a render from a `Module`. See [this](https://github.com/modern-js-dev/rspack/blob/3d981eea519f36fe0e53cdb878dab447a4e70cc8/crates/rspack_core/src/lib.rs#L30) to get the full list of supported `SourceType`.
diff --git a/npm/darwin-arm64/package.json b/npm/darwin-arm64/package.json
@@ -1,15 +1,18 @@
 {
   "name": "@rspack/binding-darwin-arm64",
   "version": "0.0.22",
+  "license": "MIT",
   "description": "Node binding for rspack",
   "main": "rspack.darwin-arm64.node",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "*.node"
   ],
-  "license": "MIT",
   "os": [
     "darwin"
   ],

diff --git a/npm/darwin-x64/package.json b/npm/darwin-x64/package.json
@@ -1,15 +1,18 @@
 {
   "name": "@rspack/binding-darwin-x64",
   "version": "0.0.22",
+  "license": "MIT",
   "description": "Node binding for rspack",
   "main": "rspack.darwin-x64.node",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "*.node"
   ],
-  "license": "MIT",
   "os": [
     "darwin"
   ],

diff --git a/npm/linux-x64-gnu/package.json b/npm/linux-x64-gnu/package.json
@@ -1,16 +1,18 @@
 {
   "name": "@rspack/binding-linux-x64-gnu",
   "version": "0.0.22",
+  "license": "MIT",
   "description": "Node binding for rspack",
   "main": "rspack.linux-x64-gnu.node",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "*.node"
   ],
-  "author": "",
-  "license": "MIT",
   "os": [
     "linux"
   ],

diff --git a/npm/win32-x64-msvc/package.json b/npm/win32-x64-msvc/package.json
@@ -1,16 +1,18 @@
 {
   "name": "@rspack/binding-win32-x64-msvc",
   "version": "0.0.22",
+  "license": "MIT",
   "description": "Node binding for rspack",
   "main": "rspack.win32-x64-msvc.node",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "publishConfig": {
     "access": "public"
   },
   "files": [
     "*.node"
   ],
-  "author": "",
-  "license": "MIT",
   "os": [
     "win32"
   ],

diff --git a/package.json b/package.json
@@ -1,7 +1,8 @@
 {
   "name": "monorepo",
   "version": "1.0.0",
-  "description": "A Fast Rust-based Web Bundler",
+  "license": "MIT",
+  "description": "A Fast Rust-based web bundler",
   "main": "index.js",
   "private": true,
   "scripts": {
@@ -29,22 +30,14 @@
     "changeset": "changeset",
     "prepare": "is-ci || husky install"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/speedy-js/rspack.git"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/speedy-js/rspack/issues"
-  },
-  "homepage": "https://github.com/speedy-js/rspack#readme",
   "lint-staged": {
     "*.rs": "rustfmt --edition 2021",
     "*.js": "pnpm run format:js",
     "*.toml": "pnpm run format:toml"
   },
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "devDependencies": {
     "@changesets/cli": "2.24.4",
     "@taplo/cli": "^0.5.2",

diff --git a/packages/create-rspack/package.json b/packages/create-rspack/package.json
@@ -1,17 +1,14 @@
 {
   "name": "create-rspack",
   "version": "0.0.18",
-  "description": "",
+  "license": "Create a new rspack project",
   "main": "index.js",
   "bin": {
     "create-rspack": "index.js"
   },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "dependencies": {
     "yargs": "17.6.2",
     "prompts": "2.4.2"

diff --git a/packages/postcss-loader/package.json b/packages/postcss-loader/package.json
@@ -1,18 +1,19 @@
 {
   "name": "@rspack/postcss-loader",
   "version": "0.0.22",
-  "description": "",
+  "license": "MIT",
+  "description": "PostCSS loader for rspack",
   "main": "src/index.js",
   "scripts": {
     "test": "echo success"
   },
-  "keywords": [],
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "dependencies": {
     "@rspack/binding": "workspace:*",
     "postcss-modules": "^5.0.0",
     "postcss-pxtorem": "^6.0.0",
     "postcss": "^8.4.16"
-  },
-  "author": "",
-  "license": "MIT"
+  }
 }
diff --git a/packages/rspack-cli/package.json b/packages/rspack-cli/package.json
@@ -1,6 +1,8 @@
 {
   "name": "@rspack/cli",
   "version": "0.0.22",
+  "license": "MIT",
+  "description": "CLI for rspack",
   "bin": {
     "rspack": "./bin/rspack"
   },
@@ -16,6 +18,9 @@
     "bin",
     "dist"
   ],
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "devDependencies": {
     "@types/webpack-bundle-analyzer": "^4.6.0",
     "concat-stream": "^2.0.0",

diff --git a/packages/rspack-dev-client/package.json b/packages/rspack-dev-client/package.json
@@ -1,14 +1,16 @@
 {
   "name": "@rspack/dev-client",
-  "description": "",
   "version": "0.0.22",
+  "license": "MIT",
+  "description": "Development client for rspack",
   "scripts": {
     "build": "tsc",
     "dev": "tsc -w",
     "test": "echo success"
   },
-  "author": "",
-  "license": "MIT",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "devDependencies": {
     "typescript": "^4.7.4",
     "@types/node": "16.11.7",

diff --git a/packages/rspack-dev-middleware/package.json b/packages/rspack-dev-middleware/package.json
@@ -1,22 +1,23 @@
 {
   "name": "@rspack/dev-middleware",
   "version": "0.0.22",
-  "description": "",
+  "license": "MIT",
+  "description": "Development middleware for rspack",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
     "build": "tsc",
     "dev": "tsc -w"
   },
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "dependencies": {
     "@rspack/core": "workspace:*",
     "webpack-dev-middleware": "6.0.0",
     "mime-types": "2.1.35"
   },
   "devDependencies": {
     "@types/mime-types": "2.1.1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT"
+  }
 }
diff --git a/packages/rspack-dev-server/package.json b/packages/rspack-dev-server/package.json
@@ -1,16 +1,18 @@
 {
   "name": "@rspack/dev-server",
-  "description": "",
   "version": "0.0.22",
+  "license": "MIT",
+  "description": "Development server for rspack",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
     "build": "rm -rf dist/ && tsc",
     "dev": "tsc -w",
     "test": "rm -rf .test-temp && jest --verbose"
   },
-  "author": "",
-  "license": "MIT",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "devDependencies": {
     "@rspack/core": "workspace:*",
     "typescript": "^4.7.4",

diff --git a/packages/rspack-plugin-html/package.json b/packages/rspack-plugin-html/package.json
@@ -1,8 +1,8 @@
 {
   "name": "@rspack/plugin-html",
   "version": "0.0.22",
-  "description": "html plugin for rspack",
-  "author": "",
+  "license": "MIT",
+  "description": "HTML plugin for rspack",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "scripts": {
@@ -14,7 +14,9 @@
     "rspack",
     "html"
   ],
-  "license": "MIT",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "dependencies": {
     "@rspack/core": "workspace:*",
     "@types/html-minifier-terser": "7.0.0",

diff --git a/packages/rspack-plugin-minify/package.json b/packages/rspack-plugin-minify/package.json
@@ -1,12 +1,13 @@
 {
   "name": "@rspack/plugin-minify",
   "version": "0.0.22",
-  "description": "",
+  "license": "MIT",
+  "description": "Minify plugin for rspack",
   "main": "src/index.js",
   "scripts": {},
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
+  "homepage": "https://rspack.org",
+  "bugs": "https://github.com/modern-js-dev/rspack/issues",
+  "repository": "modern-js-dev/rspack",
   "publishConfig": {
     "access": "public"
   },