@helpfeel/cosense-cli 1.16.0 → 1.16.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@helpfeel/cosense-cli",
-  "version": "1.16.0",
+  "version": "1.16.1",
   "description": "Cosense (旧Scrapbox) のページを読み・調べ・編集するAgent Skillのハーネス",
   "homepage": "https://github.com/helpfeel/cosense-cli",
   "license": "MIT",

package/src/commands/browsePage.ts

@@ -1,5 +1,8 @@
 import { enrichTimestampsOf } from '../lib/enrichTimestamps.ts';
-import { encodeTitleForUrl } from '../lib/encodeTitle.ts';
+import {
+  encodeTitleForReadableLink,
+  encodeTitleForUrl
+} from '../lib/encodeTitle.ts';
 import { applyFileMarkup, fetchFileMarkups } from '../lib/fileMarkup.ts';
 import { renderLiterateDatabase } from '../lib/literateDatabase.ts';
 import { parsePageUrl } from '../lib/parseUrl.ts';
@@ -35,10 +38,11 @@ Usage:
   # <title>
 
   ## メタデータ
-    タイトル / URL / pageId / commitId / 作成日時 / 最終更新日時 / 最終アクセス日時 /
-    被リンク数 / pageRank / views / snapshot / 行数 / 文字数 / 作成者 / 最終更新者 /
-    関わったユーザー
+    タイトル / URL / Readable link / pageId / commitId / 作成日時 / 最終更新日時 /
+    最終アクセス日時 / 被リンク数 / pageRank / views / snapshot / 行数 / 文字数 /
+    作成者 / 最終更新者 / 関わったユーザー
     URL はタイトルをパーセントエンコードしたページURL
+    Readable link は日本語等を生で残した同じページのURL（Cosenseの「Copy readable link」相当）
     pageId はページの不変ID、commitId は閲覧時点の最新コミット。共同編集中に
     ページを見失ったら、これらを browsePageChanges に渡して変更（リネーム含む）を辿れる
 
@@ -92,7 +96,7 @@ Usage:
     ## 1 hop link（表に載っていないページ） に出力する
 
 persistent: false の時:
-  アイコン・テロメア・Infoboxは省略し、メタデータはURLだけを出力する。
+  アイコン・テロメア・Infoboxは省略し、メタデータはURLとReadable linkだけを出力する。
   (このページはまだ作成されていません) と 本文（テンプレート）と Related Pages を出力する
 
 URLに #<lineId> fragmentが指定された時:
@@ -208,10 +212,15 @@ const buildTelomere = (lines: PageLine[]): TelomereEntry[] => {
   return [...byUser.values()].sort((a, b) => b.lineCount - a.lineCount);
 };
 
-const renderMetadata = (page: PageData, pageUrl: string): string => {
+const renderMetadata = (
+  page: PageData,
+  pageUrl: string,
+  readableLink: string
+): string => {
   const items: string[] = [];
   if (typeof page.title === 'string') items.push(`- タイトル: ${page.title}`);
   items.push(`- URL: ${pageUrl}`);
+  items.push(`- Readable link: ${readableLink}`);
   if (typeof page.id === 'string') items.push(`- pageId: ${page.id}`);
   if (typeof page.commitId === 'string') {
     items.push(`- commitId: ${page.commitId}`);
@@ -362,11 +371,14 @@ export const browsePage = async (args: string[]): Promise<void> => {
   const title = page.title ?? '';
   const persistent = page.persistent !== false;
   const pageUrl = `${origin}/${projectName}/${encodeTitleForUrl(title)}`;
+  const readableLink = `${origin}/${projectName}/${encodeTitleForReadableLink(title)}`;
   const sections: string[] = [`# ${title}`];
 
   if (!persistent) {
     sections.push('(このページはまだ作成されていません)');
-    sections.push(`## メタデータ\n\n- URL: ${pageUrl}`);
+    sections.push(
+      `## メタデータ\n\n- URL: ${pageUrl}\n- Readable link: ${readableLink}`
+    );
     const { body } = renderBody(page.lines ?? [], null, new Map());
     sections.push(`## 本文（テンプレート）\n\n${body}`);
     const related = renderRelatedPages(hopValue, page);
@@ -414,7 +426,7 @@ export const browsePage = async (args: string[]): Promise<void> => {
   ]);
   enrichPageUsers(page, userMap);
 
-  sections.push(renderMetadata(page, pageUrl));
+  sections.push(renderMetadata(page, pageUrl, readableLink));
 
   const iconsSection = renderHumanIcons(page.icons, userMap);
   if (iconsSection) sections.push(iconsSection);

package/src/commands/browsePageChanges.ts

@@ -1,4 +1,7 @@
-import { encodeTitleForUrl } from '../lib/encodeTitle.ts';
+import {
+  encodeTitleForReadableLink,
+  encodeTitleForUrl
+} from '../lib/encodeTitle.ts';
 import { formatTimestamp } from '../lib/formatTimestamp.ts';
 import { parseProjectUrlStrict } from '../lib/parseUrl.ts';
 import { requestJson } from '../lib/request.ts';
@@ -32,7 +35,7 @@ Usage:
 出力形式（Markdown plain text。JSONではない）:
   # ページ変更履歴
     pageId / 範囲（--since より後か全履歴か）/ commit数 / title change（変更後タイトル、無ければ なし）
-    タイトルが変わっていた時のみ、新URLも出力する
+    タイトルが変わっていた時のみ、新URLと新Readable linkも出力する
   ## 変更
     時系列の変更イベントを「<日時>\t<誰>が<何を>」の形（TAB区切り）で列挙する。
     同一行への連続した編集は1件にまとめ、変更前→最終のテキストを示す。
@@ -231,6 +234,8 @@ export const browsePageChanges = async (args: string[]): Promise<void> => {
   if (latestTitle !== undefined) {
     const newUrl = `${origin}/${projectName}/${encodeTitleForUrl(latestTitle)}`;
     meta.push(`- 新URL: ${newUrl}`);
+    const newReadableLink = `${origin}/${projectName}/${encodeTitleForReadableLink(latestTitle)}`;
+    meta.push(`- 新Readable link: ${newReadableLink}`);
   }
   sections.push(meta.join('\n'));
 

package/src/commands/submitEdit.ts

@@ -1,4 +1,7 @@
-import { encodeTitleForUrl } from '../lib/encodeTitle.ts';
+import {
+  encodeTitleForReadableLink,
+  encodeTitleForUrl
+} from '../lib/encodeTitle.ts';
 import { parseProjectUrlStrict } from '../lib/parseUrl.ts';
 import { requestJson } from '../lib/request.ts';
 import { resolveCredential } from '../lib/settings.ts';
@@ -19,10 +22,11 @@ Usage:
   commitId: <生成されたcommitのID>
   title:    <実際に書き込まれたpage title>
   url:      <作成または更新された page の URL。タイトルはパーセントエンコード済み>
+  readableLink: <同じ page の URL。日本語等を生で残す（Cosenseの「Copy readable link」相当）>
 
-  url はサーバーが返す title から再構築される。 同名ページが既に存在する場合、 サーバーは
-  タイトルに auto-suffix を付ける (新規作成でも既存ページのタイトル変更でも起きる)。
-  title/url にはその suffix が反映される。
+  url と readableLink はサーバーが返す title から再構築される。 同名ページが既に存在する場合、
+  サーバーはタイトルに auto-suffix を付ける (新規作成でも既存ページのタイトル変更でも起きる)。
+  title/url/readableLink にはその suffix が反映される。
 
   既存ページのタイトルが変わった編集では、続けて以下を出力する:
   titleChanged: "<変更前title>" -> "<変更後title>"
@@ -89,8 +93,9 @@ export const submitEdit = async (args: string[]): Promise<void> => {
     );
   }
   const url = `${origin}/${projectName}/${encodeTitleForUrl(title)}`;
+  const readableLink = `${origin}/${projectName}/${encodeTitleForReadableLink(title)}`;
   process.stdout.write(
-    `commitId: ${response.commitId}\ntitle:    ${title}\nurl:      ${url}\n`
+    `commitId: ${response.commitId}\ntitle:    ${title}\nurl:      ${url}\nreadableLink: ${readableLink}\n`
   );
 
   // titleChangedはサーバーが対応している場合のみ返る

package/src/lib/encodeTitle.ts

@@ -8,3 +8,12 @@ export const encodeTitleForUrl = (title: string): string => {
     c => `%${c.charCodeAt(0).toString(16).toUpperCase()}`
   );
 };
+
+// Cosenseの「Copy readable link」と同じく、日本語等を生で残して人が読めるURLにする
+// URLパーサーは`\`を`/`と解釈し、末尾のC0制御文字を取り除く。空白文字と`<>`は貼った先でURLの自動リンクを途中で切り、`'`はshellのクォートを壊す。これらを`/` `%` `?` `#`と共にエスケープする
+export const encodeTitleForReadableLink = (title: string): string =>
+  title
+    .replace(/ /g, '_')
+    .replace(/[/%?#\\<>\p{Cc}]|\s/gu, c => encodeURIComponent(c))
+    // encodeURIComponentは`'`をエスケープしない
+    .replace(/'/g, '%27');