@riebeckite/plugin-alias 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,87 @@
+# @riebeckite/plugin-alias
+
+Turns Obsidian `aliases` / `alias` frontmatter into site-local redirect URLs, so a note can be reached through its alternate names without changing its canonical permalink.
+
+[Japanese](./README_ja.md)
+
+## What it does
+
+When a vault note has frontmatter like
+
+```md
+---
+title: Old Note
+aliases:
+  - legacy-note
+  - "old notes"
+---
+```
+
+the plugin registers redirects such as:
+
+- `/legacy-note` → the note's canonical permalink
+- `/old%20notes` → the note's canonical permalink
+
+Redirects are written into the build-time manifest and resolved by HonoX at request time. No client-side JavaScript is required.
+
+## Setup
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { aliasPlugin } from "@riebeckite/plugin-alias";
+
+export default defineConfig({
+  // ...
+  plugins: [aliasPlugin()],
+});
+```
+
+It composes with the `permalink` plugin. `alias` augments already-resolved public locations through `extendContentLocations`, so it never overrides or re-derives the canonical permalink, whatever decided it.
+
+```ts
+plugins: [permalinkPlugin(), aliasPlugin()],
+```
+
+## Options
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `status` | `301 \| 302 \| 307 \| 308` | `308` | HTTP status used for generated redirects |
+
+## Alias normalization
+
+An alias is treated as an alternate note name and mapped to a path under the site root:
+
+- A leading `/` is ignored (`Old` and `/Old` both become `/Old`).
+- Path separators are allowed (`archive/Old` → `/archive/Old`).
+- Each segment is percent-encoded with the same rules as request paths, so non-ASCII and spaces work as-is.
+- An alias that cannot become a URL is skipped with a warning:
+  - empty, or only `.` / `..` segments
+  - containing `#`, `?`, or `\`
+  - containing `//` (an empty segment)
+  - containing malformed percent escapes
+
+## Diagnostics
+
+| Code | Severity | Meaning |
+| --- | --- | --- |
+| `alias-invalid` | warning | The alias cannot be converted into a URL path. |
+| `alias-collision` | warning | The alias path collides with another note's canonical permalink or an existing redirect. |
+
+A colliding alias is not registered; the existing path wins.
+
+## Limitations
+
+- Redirects are decided at build time; add or change aliases and rebuild the site.
+- SSG does not emit dedicated redirect HTML files. Redirects are resolved by the server (`resolveContentRoute` in HonoX).
+- Aliases are not part of the content graph (backlinks); only links written in the Markdown count.
+
+## Exports
+
+- `aliasPlugin(options?)` / `alias(options?)` — the plugin factory
+- `resolveAliasPath(alias)` — pure alias-to-path helper (returns `null` when invalid)
+- Types: `AliasOptions`, `AliasRedirectStatus`, `ResolvedAliasOptions`
+
+## Related
+
+- [Plugin system](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -0,0 +1,87 @@
+# @riebeckite/plugin-alias
+
+Obsidian のフロントマター `aliases`（`alias` も可）を、サイト内のリダイレクト URL に変換するプラグインです。ノートの別名でアクセスできるようにしつつ、正規のパーマリンクは変更しません。
+
+[English](./README.md)
+
+## できること
+
+Vault のノートが
+
+```md
+---
+title: Old Note
+aliases:
+  - legacy-note
+  - "古いノート"
+---
+```
+
+のようなフロントマターを持つとき、このプラグインは次のようなリダイレクトを生成します。
+
+- `/legacy-note` → ノートの正規パーマリンク
+- `/%E5%8F%A4%E3%81%84%E3%83%8E%E3%83%BC%E3%83%88` → ノートの正規パーマリンク
+
+リダイレクトはビルド時のマニフェストに登録され、リクエスト時に HonoX が解決します。クライアント側の JavaScript は不要です。
+
+## 設定
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { aliasPlugin } from "@riebeckite/plugin-alias";
+
+export default defineConfig({
+  // ...
+  plugins: [aliasPlugin()],
+});
+```
+
+`permalink` プラグインと併用できます。`alias` は「解決済みの公開ロケーション」を後から拡張する（`extendContentLocations`）ため、正規パーマリンクがどのように決まっていても、その値を上書きしたり再現したりしません。
+
+```ts
+plugins: [permalinkPlugin(), aliasPlugin()],
+```
+
+## オプション
+
+| オプション | 型 | 既定値 | 内容 |
+| --- | --- | --- | --- |
+| `status` | `301 \| 302 \| 307 \| 308` | `308` | 生成するリダイレクトの HTTP ステータス |
+
+## エイリアスの正規化
+
+エイリアスは「ノートの別名」として扱い、サイトルートからのパスに変換します。
+
+- 先頭の `/` は無視します（`Old` も `/Old` も `/Old` になります）。
+- パス区切り `/` による階層を許可します（`archive/Old` → `/archive/Old`）。
+- 各セグメントはリクエストパスと同じ規則でパーセントエンコードします。日本語や空白を含む別名もそのまま使えます。
+- 次のようなエイリアスは URL にできないためスキップし、警告を出します。
+  - 空、または `.` / `..` だけのセグメント
+  - `#`、`?`、`\` を含む
+  - `//`（空セグメント）を含む
+  - パーセントエンコードが壊れている
+
+## 診断
+
+| コード | 深刻度 | 内容 |
+| --- | --- | --- |
+| `alias-invalid` | warning | エイリアスを URL パスに変換できない。 |
+| `alias-collision` | warning | エイリアスのパスが、別のノートの正規パーマリンクまたは既存のリダイレクトと衝突している。 |
+
+衝突したエイリアスは登録されず、既存のパスが優先されます。
+
+## 制限事項
+
+- リダイレクトはビルド時に確定します。エイリアスの追加・変更はサイトを再ビルドすると反映されます。
+- SSG ではリダイレクト専用の HTML ファイルは生成されません。リダイレクトはサーバー（HonoX の `resolveContentRoute`）が解決します。
+- エイリアスはコンテンツグラフ（バックリンク）には含まれません。元の Markdown に書かれたリンクだけが対象です。
+
+## エクスポート
+
+- `aliasPlugin(options?)` / `alias(options?)` — プラグインファクトリ
+- `resolveAliasPath(alias)` — エイリアスをサイト内パスへ変換する純関数（`null` で無効）
+- 型: `AliasOptions`、`AliasRedirectStatus`、`ResolvedAliasOptions`
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import { type AliasOptions } from "./src/alias.js";
+export type { AliasOptions, AliasRedirectStatus, ResolvedAliasOptions, } from "./src/alias.js";
+export { resolveAliasPath } from "./src/alias.js";
+/**
+ * Turns Obsidian `aliases` / `alias` frontmatter into site-local redirects.
+ *
+ * The plugin augments already-resolved public locations through
+ * `extendContentLocations`, so it never has to reproduce (or override) the
+ * canonical permalink another plugin produced: aliases are added as extra
+ * redirect entries on top of whatever `permalink` resolved.
+ */
+export declare function alias(options?: AliasOptions): import("@riebeckite/core").RiebeckitePlugin<unknown>;
+export declare const aliasPlugin: typeof alias;

package/dist/index.js

@@ -0,0 +1,106 @@
+// index.ts
+import {
+  definePlugin,
+  extractFrontmatterAliases
+} from "@riebeckite/core";
+
+// src/alias.ts
+function resolveAliasOptions(options) {
+  const status = options.status ?? 308;
+  if (![301, 302, 307, 308].includes(status)) {
+    throw new Error(`Invalid alias redirect status: ${status}`);
+  }
+  return { status };
+}
+function resolveAliasPath(alias2) {
+  const raw = alias2.trim();
+  if (!raw) return null;
+  const trimmed = raw.replace(/^\/+/, "");
+  if (!trimmed || /[\\?#]/.test(trimmed) || trimmed.includes("//")) return null;
+  const segments = [];
+  for (const segment of trimmed.split("/")) {
+    if (!segment || segment === "." || segment === ".." || hasMalformedPercentEncoding(segment)) {
+      return null;
+    }
+    segments.push(encodeURIComponent(decodeURIComponent(segment)));
+  }
+  return `/${segments.join("/")}`;
+}
+function hasMalformedPercentEncoding(value) {
+  try {
+    decodeURIComponent(value);
+    return false;
+  } catch {
+    return true;
+  }
+}
+
+// index.ts
+function alias(options = {}) {
+  const resolved = resolveAliasOptions(options);
+  return definePlugin({
+    name: "alias",
+    extendContentLocations: (context) => {
+      applyAliases(context, resolved);
+    }
+  });
+}
+var aliasPlugin = alias;
+function applyAliases(context, options) {
+  const owners = /* @__PURE__ */ new Map();
+  for (const location of context.locations.values()) {
+    reservePath(owners, location.permalink, location.slug, "permalink");
+    for (const redirect of location.redirects ?? []) {
+      reservePath(owners, redirect.path, location.slug, "redirect");
+    }
+  }
+  for (const entry of context.entries) {
+    const location = context.locations.get(entry.slug);
+    if (!location) continue;
+    for (const alias2 of extractFrontmatterAliases(entry.markdown)) {
+      const path = resolveAliasPath(alias2);
+      if (!path) {
+        context.diagnostics.push({
+          code: "alias-invalid",
+          severity: "warning",
+          pluginName: "alias",
+          filePath: entry.path,
+          slug: entry.slug,
+          message: `Alias "${alias2}" cannot be used as a URL path and was skipped.`,
+          suggestion: "Aliases must not contain '#', '?', '\\', empty or '.'/'..' segments, or malformed percent escapes.",
+          meta: { alias: alias2 }
+        });
+        continue;
+      }
+      const owner = owners.get(path);
+      if (owner) {
+        if (owner.slug === entry.slug) continue;
+        context.diagnostics.push({
+          code: "alias-collision",
+          severity: "warning",
+          pluginName: "alias",
+          filePath: entry.path,
+          slug: entry.slug,
+          target: path,
+          message: `Alias "${alias2}" resolves to ${path}, which is already used by "${owner.slug}" (${owner.kind}); the alias was skipped.`,
+          suggestion: "Rename the alias or remove the conflicting permalink/redirect.",
+          meta: { alias: alias2, path, conflictSlug: owner.slug }
+        });
+        continue;
+      }
+      reservePath(owners, path, entry.slug, "redirect");
+      location.redirects = [
+        ...location.redirects ?? [],
+        { path, status: options.status }
+      ];
+    }
+  }
+}
+function reservePath(owners, path, slug, kind) {
+  if (!owners.has(path)) owners.set(path, { slug, kind });
+}
+export {
+  alias,
+  aliasPlugin,
+  resolveAliasPath
+};

package/dist/src/alias.d.ts

@@ -0,0 +1,19 @@
+export type AliasRedirectStatus = 301 | 302 | 307 | 308;
+export type AliasOptions = {
+    /** Redirect status recorded for every alias path. Defaults to `308`. */
+    status?: AliasRedirectStatus;
+};
+export type ResolvedAliasOptions = {
+    status: AliasRedirectStatus;
+};
+export declare function resolveAliasOptions(options: AliasOptions): ResolvedAliasOptions;
+/**
+ * Converts an Obsidian alias (a bare note name, not a path) into a site-local
+ * pathname. Returns `null` when the alias cannot be represented safely, so the
+ * caller can report it instead of emitting a broken redirect.
+ *
+ * A leading slash is accepted and ignored, so both `Old Name` and `/Old Name`
+ * resolve to `/Old%20Name`. The normalization intentionally matches the
+ * request-path encoding used by the HonoX integration.
+ */
+export declare function resolveAliasPath(alias: string): string | null;

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@riebeckite/plugin-alias",
+  "version": "0.0.1",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "source": "./index.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@riebeckite/core": "0.0.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/alias"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Obsidian alias redirects for Riebeckite sites.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "obsidian",
+    "redirects"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs"
+  }
+}