@riebeckite/plugin-analytics 0.0.3 → 0.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +17 -0
- package/README_ja.md +10 -0
- package/package.json +5 -2
package/README.md
CHANGED
|
@@ -61,6 +61,12 @@ stable ID is not tracked. The initializer is a no-op during builds/SSR and is
|
|
|
61
61
|
idempotent in a document. Riebeckite's current static document navigation needs
|
|
62
62
|
no SPA route hooks; SPA navigation is not tracked automatically.
|
|
63
63
|
|
|
64
|
+
Content IDs are an authoring responsibility. Duplicate or conflicting `id`/`uid`
|
|
65
|
+
declarations across published notes are reported by
|
|
66
|
+
[`@riebeckite/plugin-diagnostics`](../diagnostics/README.md)
|
|
67
|
+
(`duplicate-content-id` / `invalid-content-id`) and validated by the plugin's own
|
|
68
|
+
`validateAnalyticsOptions` at `check` time.
|
|
69
|
+
|
|
64
70
|
## Provider contract
|
|
65
71
|
|
|
66
72
|
```ts
|
|
@@ -75,6 +81,13 @@ Capabilities are `capture`, `content_page_views`, and `popular_content`. Call
|
|
|
75
81
|
`assertAnalyticsQuerySupported(provider, query)` when implementing a provider
|
|
76
82
|
that may not support all queries.
|
|
77
83
|
|
|
84
|
+
## Diagnostics
|
|
85
|
+
|
|
86
|
+
`@riebeckite/plugin-diagnostics` reports an `analytics-untracked` finding for
|
|
87
|
+
published content without a stable content ID when the site enables this
|
|
88
|
+
plugin, so tracking gaps are visible in `check`, `doctor`, and build
|
|
89
|
+
diagnostics.
|
|
90
|
+
|
|
78
91
|
## Exports
|
|
79
92
|
|
|
80
93
|
- `analytics()` / `analyticsPlugin()`
|
|
@@ -82,3 +95,7 @@ that may not support all queries.
|
|
|
82
95
|
- `MemoryAnalyticsProvider`
|
|
83
96
|
- Event, query/result, provider/capability, and public-config types
|
|
84
97
|
- `UnsupportedAnalyticsQueryError` and capability helpers
|
|
98
|
+
|
|
99
|
+
## See also
|
|
100
|
+
|
|
101
|
+
- [Plugin guide](../../../docs/en/plugin-system.md)
|
package/README_ja.md
CHANGED
|
@@ -44,6 +44,12 @@ Core の安定コンテンツ ID（フロントマターの `id`、互換用の
|
|
|
44
44
|
|
|
45
45
|
`path` と `lang` は補助情報であり、ID ではありません。安定 ID のないコンテンツは誤って計測しません。ビルド時・SSR 時は何もせず、同じドキュメント内での初期化も冪等です。現行リポジトリは静的なドキュメント遷移のため SPA フックは追加しておらず、SPA 遷移は自動計測しません。
|
|
46
46
|
|
|
47
|
+
コンテンツ ID は執筆側の責務です。公開ノート間での `id`/`uid` の重複・抵触は [`@riebeckite/plugin-diagnostics`](../diagnostics/README_ja.md) が報告し（`duplicate-content-id` / `invalid-content-id`）、プラグイン自身の `validateAnalyticsOptions` が `check` 時に検証します。
|
|
48
|
+
|
|
49
|
+
## 診断
|
|
50
|
+
|
|
51
|
+
`@riebeckite/plugin-diagnostics` は、サイトで本プラグインが有効なとき、安定 content ID を持たない公開コンテンツを `analytics-untracked` として報告します。計測の抜けを `check` / `doctor` / build の診断で確認できます。
|
|
52
|
+
|
|
47
53
|
## 主なエクスポート
|
|
48
54
|
|
|
49
55
|
- `analytics()` / `analyticsPlugin()`
|
|
@@ -51,3 +57,7 @@ Core の安定コンテンツ ID（フロントマターの `id`、互換用の
|
|
|
51
57
|
- `MemoryAnalyticsProvider`
|
|
52
58
|
- イベント、クエリ／結果、プロバイダ／機能、公開設定の型
|
|
53
59
|
- `UnsupportedAnalyticsQueryError` と機能確認ヘルパー
|
|
60
|
+
|
|
61
|
+
## ????
|
|
62
|
+
|
|
63
|
+
- [?????????](../../../docs/ja/plugin-system.md)
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@riebeckite/plugin-analytics",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -20,7 +20,10 @@
|
|
|
20
20
|
}
|
|
21
21
|
},
|
|
22
22
|
"dependencies": {
|
|
23
|
-
"@riebeckite/core": "0.0.
|
|
23
|
+
"@riebeckite/core": "0.0.6"
|
|
24
|
+
},
|
|
25
|
+
"devDependencies": {
|
|
26
|
+
"tsx": "^4.22.4"
|
|
24
27
|
},
|
|
25
28
|
"publishConfig": {
|
|
26
29
|
"access": "public"
|