JSR 簡介

JavaScript 註冊中心 (JSR) 是 JavaScript 和 TypeScript 的現代套件註冊中心。JSR 可與許多執行時間 (Node.js、Deno、瀏覽器等) 搭配使用，且向下相容於 npm。 深入瞭解我們建置 JSR 的原因。

使用 JSR 套件

使用下列其中一個命令將套件新增至您的專案。這會將 @luca/cases 的最新版本新增至您的專案。

# deno
deno add @luca/cases

# npm (use any of npx, yarn dlx, pnpm dlx, or bunx)
npx jsr add @luca/cases

新增套件後，您可以在 ES 模組中像這樣匯入和使用它

import { camelCase } from "@luca/cases";

camelCase("hello world"); // "helloWorld"

在 Deno 中，你可以使用 jsr: 規範符和 Deno 的 原生 JSR 支援，在不經過安裝步驟的狀況下選擇性使用 JSR 套件。

import { camelCase } from "jsr:@luca/cases@1";

camelCase("hello world"); // "helloWorld"

你可以在 jsr.io 中找到更多套件。JSR 網站上的每個套件都會顯示文件，會自動從套件的原始程式碼中產生。深入了解如何使用套件。

發布 JSR 套件

JSR 套件使用 jsr publish / deno publish 指令發布。你可以從你的本機或 CI 發布套件。

首先，寫下你的程式碼。JSR 套件使用 JavaScript 或 TypeScript 編寫，並以 ES 模組發布。

// mod.ts
/**
 * A module providing a function to greet people.
 * @module
 */

/**
 * Greet a person.
 *
 * @param name The name of the person to greet.
 */
export function greet(name: string) {
  console.log(`Hello, ${name}!`);
}

然後，將組態檔加入你的套件。此檔案包含套件的元資料，例如名稱、版本和進入點。 exports 欄位 會告知 JSR 使用者應該可以從你的套件匯入哪些模組。

// jsr.json / deno.json
{
  "name": "@luca/greet",
  "version": "1.0.0",
  "exports": "./mod.ts"
}

最後，執行 npx jsr publish 或 deno publish，以發布你的套件。系統會提示你向 JSR 驗證身分，之後你的套件就會發布。

$ npx jsr publish
Visit https://jsr.dev.org.tw/auth?code=ABCD-EFGH to authorize publishing of @luca/greet
Waiting...
Authorization successful. Authenticated as Luca Casonato
Publishing @luca/greet@1.0.0 ...
Successfully published @luca/greet@1.0.0
Visit https://jsr.dev.org.tw/@luca/greet@1.0.0 for details

深入了解如何發布套件。