Reorganize packages

.github/workflows/main.yaml

@@ -40,15 +40,18 @@ jobs:
       with:
         check_name: "Test Results (Windows)"
         files: .test-report.xml
+    - if: '!cancelled()'
+      uses: codecov/test-results-action@v1
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: .test-report.xml
     - run: deno coverage --lcov .cov > .cov.lcov
     - uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
         slug: dahlia/logtape
         file: .cov.lcov
-    - run: deno task dnt
-    - run: bun run ./test_runner.js
-      working-directory: ${{ github.workspace }}/npm/
+    - run: deno task test:bun
     - run: deno task check
 
   publish:
@@ -64,33 +67,40 @@ jobs:
         deno-version: v2.x
     - if: github.ref_type == 'branch'
       run: |
-        jq \
+        v="$(jq \
+          --raw-output \
           --arg build "$GITHUB_RUN_NUMBER" \
           --arg commit "${GITHUB_SHA::8}" \
-          '.version = .version + "-dev." + $build + "+" + $commit' \
-          deno.json > deno.json.tmp
-        mv deno.json.tmp deno.json
+          '.version + "-dev." + $build + "+" + $commit' \
+          logtape/deno.json)"
+        deno run --allow-read --allow-write scripts/update_versions.ts "$v"
+        deno task check:versions
     - if: github.ref_type == 'tag'
       run: |
         set -ex
-        [[ "$(jq -r .version deno.json)" = "$GITHUB_REF_NAME" ]]
-    - run: 'deno task dnt "$(jq -r .version deno.json)"'
+        [[ "$(jq -r .version logtape/deno.json)" = "$GITHUB_REF_NAME" ]]
+        deno task check:versions
+    - run: deno task dnt-all
     - if: github.event_name == 'push'
       run: |
         set -ex
         npm config set //registry.npmjs.org/:_authToken "$NPM_AUTH_TOKEN"
-        if [[ "$GITHUB_REF_TYPE" = "tag" ]]; then
-          npm publish --provenance --access public
-        else
-          npm publish --provenance --access public --tag dev
-        fi
+        for npm in */npm/; do
+          pushd "$npm"
+          if [[ "$GITHUB_REF_TYPE" = "tag" ]]; then
+            npm publish --provenance --access public
+          else
+            npm publish --provenance --access public --tag dev
+          fi
+          popd
+        done
       env:
         NPM_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
       working-directory: ${{ github.workspace }}/npm/
     - if: github.event_name == 'pull_request'
-      run: deno publish --dry-run --allow-dirty
+      run: deno task publish --dry-run --allow-dirty
     - if: github.event_name == 'push'
-      run: deno publish --allow-dirty
+      run: deno task publish --allow-dirty
 
   publish-docs:
     if: github.event_name == 'push'
@@ -113,12 +123,14 @@ jobs:
         bun install
         if [[ "$GITHUB_REF_TYPE" = "tag" ]]; then
           bun add -D "@logtape/logtape@$GITHUB_REF_NAME"
+          bun add -D "@logtape/file@$GITHUB_REF_NAME"
           bun add -D @logtape/otel@latest
           EXTRA_NAV_TEXT=Unstable \
           EXTRA_NAV_LINK="$UNSTABLE_DOCS_URL" \
           bun run build
         else
           bun add -D @logtape/logtape@dev
+          bun add -D @logtape/file@dev
           bun add -D @logtape/otel@dev
           EXTRA_NAV_TEXT=Stable \
           EXTRA_NAV_LINK="$STABLE_DOCS_URL" \

.gitignore

@@ -1,2 +1,3 @@
+.dnt-import-map.json
 coverage/
 npm/

.vscode/settings.json

@@ -13,7 +13,7 @@
     "editor.defaultFormatter": "denoland.vscode-deno",
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-      "source.organizeImports": "explicit"
+      "source.sortImports": "always"
     }
   },
   "[json]": {
@@ -28,13 +28,14 @@
     "editor.defaultFormatter": "denoland.vscode-deno",
     "editor.formatOnSave": true,
     "editor.codeActionsOnSave": {
-      "source.organizeImports": "explicit"
+      "source.sortImports": "always"
     }
   },
   "cSpell.words": [
     "Codecov",
     "consolemock",
     "deno",
+    "filesink",
     "hongminhee",
     "logtape",
     "runtimes",

CHANGES.md

@@ -8,6 +8,13 @@ Version 0.9.0
 
 To be released.
 
+ -  Moved file sinks and rotating file sinks to separate packages.
+
+     -  Moved `getFileSink()` function to `@logtape/file` package.
+     -  Moved `FileSinkOptions` interface to `@logtape/file` package.
+     -  Moved `getRotatingFileSink()` function to `@logtape/file` package.
+     -  Moved `RotatingFileSinkOptions` interface to `@logtape/file` package.
+
  -  Added synchronous versions of configuration functions.
     [[#12], [#29] by Murph Murphy]
 

README.md

@@ -0,0 +1 @@
+logtape/README.md

deno.json

@@ -0,0 +1,62 @@
+{
+  "workspace": [
+    "./logtape",
+    "./file"
+  ],
+  "imports": {
+    "@david/which-runtime": "jsr:@david/which-runtime@^0.2.1",
+    "@deno/dnt": "jsr:@deno/dnt@^0.41.1",
+    "@std/assert": "jsr:@std/assert@^0.222.1",
+    "@std/async": "jsr:@std/async@^0.222.1",
+    "@std/fs": "jsr:@std/fs@^0.223.0",
+    "@std/path": "jsr:@std/path@^1.0.2",
+    "@std/testing": "jsr:@std/testing@^0.222.1",
+    "consolemock": "npm:consolemock@^1.1.0"
+  },
+  "unstable": [
+    "fs"
+  ],
+  "lock": false,
+  "exclude": [
+    ".github/",
+    "docs/"
+  ],
+  "tasks": {
+    "check": {
+      "command": "deno check **/*.ts && deno lint && deno fmt --check",
+      "dependencies": [
+        "check:versions"
+      ]
+    },
+    "check:versions": "deno run --allow-read scripts/check_versions.ts",
+    "test": "deno test --allow-read --allow-write",
+    "coverage": "rm -rf coverage && deno task test --coverage && deno coverage --html coverage",
+    "dnt-all": "deno task --recursive dnt",
+    "test-all:bun": "deno task --recursive test:bun",
+    "test-all": {
+      "dependencies": [
+        "test",
+        "test-all:bun"
+      ]
+    },
+    "publish": {
+      "command": "deno publish",
+      "dependencies": [
+        "check",
+        "test"
+      ]
+    },
+    "hooks:install": "deno run --allow-read=deno.json,.git/hooks/ --allow-write=.git/hooks/ jsr:@hongminhee/deno-task-hooks",
+    "hooks:pre-commit": {
+      "dependencies": [
+        "check"
+      ]
+    },
+    "hooks:pre-push": {
+      "dependencies": [
+        "check",
+        "test"
+      ]
+    }
+  }
+}

docs/.jsr-cache.file.json

@@ -0,0 +1 @@
+{"package":"@logtape/file","version":"0.9.0-dev.1","index":{"getFileSink()":{"kind":[{"char":"f","kind":"Function","title":"Function"}],"name":"getFileSink","file":".","doc":"Get a file sink.\n\nNote that this function is unavailable in the browser.\n","url":"https://jsr.io/@logtape/[email protected]/doc/~/getFileSink","deprecated":false,"label":"getFileSink()"},"getRotatingFileSink()":{"kind":[{"char":"f","kind":"Function","title":"Function"}],"name":"getRotatingFileSink","file":".","doc":"Get a rotating file sink.\n\nThis sink writes log records to a file, and rotates the file when it reaches\nthe `maxSize`.  The rotated files are named with the original file name\nfollowed by a dot and a number, starting from 1.  The number is incremented\nfor each rotation, and the maximum number of files to keep is `maxFiles`.\n\nNote that this function is unavailable in the browser.\n","url":"https://jsr.io/@logtape/[email protected]/doc/~/getRotatingFileSink","deprecated":false,"label":"getRotatingFileSink()"}}}

docs/.vitepress/config.mts

@@ -1,18 +1,24 @@
+import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 import { jsrRef } from "markdown-it-jsr-ref";
 import { defineConfig } from "vitepress";
-import { transformerTwoslash } from "@shikijs/vitepress-twoslash";
 
 const jsrRefVersion =
   process.env.CI === "true" && process.env.GITHUB_REF_TYPE === "tag"
     ? "stable"
     : "unstable";
 
-const jsrRefPlugin = await jsrRef({
+const jsrRef_logtape = await jsrRef({
   package: "@logtape/logtape",
   version: jsrRefVersion,
   cachePath: ".jsr-cache.json",
 });
 
+const jsrRef_file = await jsrRef({
+  package: "@logtape/file",
+  version: jsrRefVersion,
+  cachePath: ".jsr-cache.file.json",
+});
+
 let extraNav: { text: string; link: string }[] = [];
 if (process.env.EXTRA_NAV_TEXT && process.env.EXTRA_NAV_LINK) {
   extraNav = [
@@ -116,7 +122,8 @@ export default defineConfig({
       }),
     ],
     config(md) {
-      md.use(jsrRefPlugin);
+      md.use(jsrRef_logtape);
+      md.use(jsrRef_file);
     },
   },
 

docs/manual/sinks.md

@@ -136,12 +136,38 @@ File sink
 > [!NOTE]
 > File sink is unavailable in the browser environment.
 
-LogTape provides a file sink as well.  Here's an example of a file sink that
-writes log messages to a file:
+LogTape provides a file sink through a separate package *@logtape/file*:
+
+::: code-group
+
+~~~~ sh [Deno]
+deno add jsr:@logtape/file
+~~~~
+
+~~~~ sh [npm]
+npm add @logtape/file
+~~~~
+
+~~~~ sh [pnpm]
+pnpm add @logtape/file
+~~~~
+
+~~~~ sh [Yarn]
+yarn add @logtape/file
+~~~~
+
+~~~~ sh [Bun]
+bun add @logtape/file
+~~~~
+
+:::
+
+Here's an example of a file sink that writes log messages to a file:
 
 ~~~~ typescript twoslash
 // @noErrors: 2345
-import { configure, getFileSink } from "@logtape/logtape";
+import { getFileSink } from "@logtape/file";
+import { configure } from "@logtape/logtape";
 
 await configure({
   sinks: {
@@ -181,12 +207,39 @@ the ability to *rotate* the log file when it reaches a certain size. This means:
 This rotation process helps prevent any single log file from growing too large,
 which can cause issues with file handling, log analysis, and storage management.
 
-To use the rotating file sink, you can use the `getRotatingFileSink()` function.
+To use the rotating file sink, you can use the `getRotatingFileSink()` function,
+which is provided by the *@logtape/file* package:
+
+::: code-group
+
+~~~~ sh [Deno]
+deno add jsr:@logtape/file
+~~~~
+
+~~~~ sh [npm]
+npm add @logtape/file
+~~~~
+
+~~~~ sh [pnpm]
+pnpm add @logtape/file
+~~~~
+
+~~~~ sh [Yarn]
+yarn add @logtape/file
+~~~~
+
+~~~~ sh [Bun]
+bun add @logtape/file
+~~~~
+
+:::
+
 Here's an example of a rotating file sink that writes log messages to a file:
 
 ~~~~ typescript twoslash
 // @noErrors: 2345
-import { configure, getRotatingFileSink } from "@logtape/logtape";
+import { getRotatingFileSink } from "@logtape/file";
+import { configure } from "@logtape/logtape";
 
 await configure({
   sinks: {

docs/package.json

@@ -1,13 +1,12 @@
 {
-  "dependencies": {
-    "@logtape/sentry": "^0.1.0",
-    "@sentry/node": "^8.40.0"
-  },
   "devDependencies": {
     "@biomejs/biome": "^1.8.3",
     "@cloudflare/workers-types": "^4.20240909.0",
+    "@logtape/file": "^0.9.0-dev.1",
     "@logtape/logtape": "0.9.0-dev.127",
+    "@logtape/sentry": "^0.1.0",
     "@logtape/otel": "^0.2.0",
+    "@sentry/node": "^8.40.0",
     "@shikijs/vitepress-twoslash": "^1.17.6",
     "@teidesu/deno-types": "^1.46.3",
     "@types/bun": "^1.1.9",

file/README.md

@@ -0,0 +1,43 @@
+<!-- deno-fmt-ignore-file -->
+
+File sinks for LogTape
+======================
+
+[![JSR][JSR badge]][JSR]
+[![npm][npm badge]][npm]
+
+This package provides file sinks for [LogTape].  You can use the file sinks to
+write log records to files.  For details, read the docs:
+
+ -  [File sink]
+ -  [Rotating file sink]
+
+[JSR]: https://jsr.io/@logtape/file
+[JSR badge]: https://jsr.io/badges/@logtape/file
+[npm]: https://www.npmjs.com/package/@logtape/file
+[npm badge]: https://img.shields.io/npm/v/@logtape/file?logo=npm
+[LogTape]: https://logtape.org/
+[File sink]: https://logtape.org/manual/sinks#file-sink
+[Rotating file sink]: https://logtape.org/manual/sinks#rotating-file-sink
+
+
+Installation
+------------
+
+This package is available on [JSR] and [npm].  You can install it for various
+JavaScript runtimes and package managers:
+
+~~~~ sh
+deno add @logtape/file  # for Deno
+npm  add @logtape/file  # for npm
+pnpm add @logtape/file  # for pnpm
+yarn add @logtape/file  # for Yarn
+bun  add @logtape/file  # for Bun
+~~~~
+
+
+Docs
+----
+
+The docs of LogTape is available at <https://logtape.org/manual/sinks>.
+For the API references, see <https://jsr.io/@logtape/file>.