@riebeckite/plugin-hard-breaks 0.0.0-stage → 0.0.22

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

@@ -1,3 +1,101 @@
-# Temporary Holding Version
+# @riebeckite/plugin-hard-breaks
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<!-- Generated from docs/docs/plugins/hard-breaks.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
+Render ordinary Markdown line breaks as `<br>` elements, matching Obsidian's
+behavior when "Strict line breaks" is turned off.
+
+[日本語](./README_ja.md)
+
+## Overview
+
+In standard Markdown, a single newline inside a paragraph is a soft break: it
+is rendered as a space. `hardBreaks()` registers the
+[`remark-breaks`](https://github.com/remarkjs/remark-breaks) transformer on the
+Riebeckite Markdown pipeline so every soft break becomes a `<br>` element at
+build time.
+
+The conversion happens on the Markdown AST before the tree is converted to
+HTML, so code blocks, inline code, and explicit hard breaks keep their meaning.
+The plugin adds no client JavaScript and no CSS.
+
+## Installation
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { hardBreaks } from "@riebeckite/plugin-hard-breaks";
+
+export default defineConfig({
+  // ...
+  plugins: [hardBreaks()],
+});
+```
+
+Add `hardBreaks()` to the `plugins` array of `riebeckite.config.ts`. The plugin
+is opt-in: without this entry, the pipeline keeps the standard Markdown soft
+break behavior.
+
+## Usage
+
+```ts
+import { hardBreaks } from "@riebeckite/plugin-hard-breaks";
+
+hardBreaks();
+```
+
+The factory takes no options.
+
+## Before and after
+
+Input:
+
+```md
+今日はいい天気です。
+散歩に行きました。
+明日も晴れるといいな。
+```
+
+Without the plugin (standard Markdown), the three lines render on one line.
+With `hardBreaks()`:
+
+```html
+<p>今日はいい天気です。<br>
+散歩に行きました。<br>
+明日も晴れるといいな。</p>
+```
+
+## Behavior
+
+| Input | Result |
+| --- | --- |
+| A single newline inside a paragraph | Becomes a `<br>` |
+| A blank line between paragraphs | Still splits paragraphs |
+| A fenced code block | Unchanged |
+| Inline code | Unchanged |
+| Headings | Keep their Markdown heading structure |
+| Line breaks in list items | Handled by the Markdown AST structure |
+| Line breaks in blockquotes | Treated like ordinary paragraphs |
+| An explicit hard break (two trailing spaces or `\`) | Not converted twice |
+| Raw HTML in Markdown | Left as-is |
+
+## Limitations
+
+- The plugin converts soft breaks only. It does not change how blank lines,
+  lists, or code blocks are parsed.
+- The result is decided at build time; rebuild the site after changing the
+  plugin list.
+
+## Obsidian relationship
+
+Obsidian has a setting called "Strict line breaks". When it is off, a single
+newline is shown as a line break. This plugin brings that same behavior to
+Riebeckite's rendered pages.
+
+## Exports
+
+- `hardBreaks()` — plugin factory
+- `hardBreaksPlugin` — alias of `hardBreaks`
+
+## See also
+
+- [Plugin guide](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.md)

package/README_ja.md

@@ -0,0 +1,100 @@
+# @riebeckite/plugin-hard-breaks
+
+<!-- Generated from docs/docs/plugins/hard-breaks.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
+
+Markdown の通常の改行を `<br>` 要素として出力するプラグインです。Obsidian の
+「厳密な改行」をオフにしたときの挙動に合わせます。
+
+[English](./README.md)
+
+## 概要
+
+標準の Markdown では、段落内の単一の改行はソフトブレークとなり、空白として
+描画されます。`hardBreaks()` は
+[`remark-breaks`](https://github.com/remarkjs/remark-breaks) のトランス
+フォーマーを Riebeckite の Markdown パイプラインに登録し、ソフトブレークを
+ビルド時に `<br>` 要素へ変換します。
+
+変換は Markdown AST の段階で行われるため、コードブロック、インラインコード、
+明示的な hard break の意味は変わりません。クライアント JavaScript と CSS は
+追加しません。
+
+## インストール
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { hardBreaks } from "@riebeckite/plugin-hard-breaks";
+
+export default defineConfig({
+  // ...
+  plugins: [hardBreaks()],
+});
+```
+
+`riebeckite.config.ts` の `plugins` 配列に `hardBreaks()` を追加します。この
+プラグインは opt-in です。追加しない場合、パイプラインは標準の Markdown の
+ソフトブレークの挙動を維持します。
+
+## 使い方
+
+```ts
+import { hardBreaks } from "@riebeckite/plugin-hard-breaks";
+
+hardBreaks();
+```
+
+ファクトリにオプションはありません。
+
+## 変換前後の比較
+
+入力:
+
+```md
+今日はいい天気です。
+散歩に行きました。
+明日も晴れるといいな。
+```
+
+プラグインなし（標準の Markdown）では、3 行は 1 行として描画されます。
+`hardBreaks()` を有効にすると次のようになります。
+
+```html
+<p>今日はいい天気です。<br>
+散歩に行きました。<br>
+明日も晴れるといいな。</p>
+```
+
+## 動作仕様
+
+| 入力 | 動作 |
+| --- | --- |
+| 段落内の単一の改行 | `<br>` に変換する |
+| 空行による段落の分割 | 従来どおり段落を分割する |
+| Fenced code block | 変更しない |
+| インラインコード | 変更しない |
+| 見出し | Markdown の見出し構造を維持する |
+| リスト項目内の改行 | Markdown AST の構造に従って処理する |
+| Blockquote 内の改行 | 通常の段落と同様に処理する |
+| 明示的な hard break（行末の空白 2 つ、または `\`） | 二重変換しない |
+| Markdown 内の HTML | そのまま扱う |
+
+## 制約事項
+
+- 変換するのはソフトブレークだけです。空行、リスト、コードブロックの解析方法は
+  変わりません。
+- 出力はビルド時に確定します。プラグインの一覧を変更したら再ビルドしてください。
+
+## Obsidian との関係
+
+Obsidian には「厳密な改行」という設定があります。これをオフにすると、単一の
+改行が改行として表示されます。このプラグインは同じ挙動を Riebeckite の
+レンダリング結果に持ち込みます。
+
+## 主なエクスポート
+
+- `hardBreaks()`: プラグインを作成する
+- `hardBreaksPlugin`: `hardBreaks` の別名
+
+## 関連資料
+
+- [プラグインガイド](https://github.com/Rerurate514/riebeckite/blob/main/docs/docs/reference/plugin-api.ja.md)

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export declare function hardBreaks(): import("@riebeckite/core").RiebeckitePlugin<unknown>;
+/** Alias kept for parity with plugins that export a `…Plugin` factory. */
+export declare const hardBreaksPlugin: typeof hardBreaks;

package/dist/index.js

@@ -0,0 +1,18 @@
+// index.ts
+import { definePlugin } from "@riebeckite/core";
+import remarkBreaks from "remark-breaks";
+function hardBreaks() {
+  return definePlugin({
+    name: "hard-breaks",
+    processedContentCache: {
+      version: "hard-breaks-v1",
+      dependencyMode: "none"
+    },
+    remarkPlugins: [remarkBreaks]
+  });
+}
+var hardBreaksPlugin = hardBreaks;
+export {
+  hardBreaks,
+  hardBreaksPlugin
+};

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@riebeckite/plugin-hard-breaks",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.0.22",
+  "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": {
+    "remark-breaks": "^4.0.0",
+    "@riebeckite/core": "0.0.22"
+  },
+  "devDependencies": {
+    "tsx": "^4.22.4",
+    "@riebeckite/test": "0.0.22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "README_ja.md",
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Rerurate514/riebeckite.git",
+    "directory": "packages/plugins/hard-breaks"
+  },
+  "homepage": "https://github.com/Rerurate514/riebeckite#readme",
+  "bugs": {
+    "url": "https://github.com/Rerurate514/riebeckite/issues"
+  },
+  "description": "Render ordinary Markdown line breaks as <br> elements for Riebeckite.",
+  "keywords": [
+    "riebeckite",
+    "plugin",
+    "markdown",
+    "line-breaks",
+    "obsidian"
+  ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "node ../../../scripts/build_package.mjs",
+    "test": "node --import tsx --test \"test/*.test.ts\""
+  }
 }