Skip to content
This repository was archived by the owner on May 2, 2026. It is now read-only.

chore: Add deprecation notice and release v1.1.2 as the final version - #430

Merged
inouetakuya merged 3 commits into
mainfrom
chore/deprecation
May 2, 2026
Merged

inouetakuya merged 3 commits into
mainfrom
chore/deprecation

Conversation

@inouetakuya

Copy link
Copy Markdown
Owner

概要

vue-nl2br をクローズするにあたり、その第一歩として deprecation notice の追加と最終リリース v1.1.2 の準備を行います。

このパッケージが解決していた「データ中の改行を <br> として表示する」という課題は、現代の CSS の white-space: pre-wrap; で完全に置き換え可能です。また Vue 2 自体が 2023-12-31 に EOL を迎えており、本パッケージを今後メンテナンスし続ける合理的な理由はありません。

主な変更点

  • README 冒頭に deprecation notice を追加し、Vue 2 EOL と CSS による代替が可能であることを明示
  • README に Migration セクションを追加し、white-space: pre-wrap; への移行コード例(before / after)を掲載
  • 移行先として pre-wrap を推奨する理由(Issue Why not just use CSS white-space: pre;? #7 で議論された折り返し問題の解決)を補足
  • package.json の version を 1.1.1 から 1.1.2 に bump
  • CHANGELOG に v1.1.2 のエントリを追加し、本リリースが最終版であり以降メンテナンスされない旨を明示

後続の作業(このプルリクエストには含めません)

このプルリクエストのマージ後、以下の作業を順に実施する予定です。

このパッケージは今後メンテナンスされないため、利用者に対して deprecation を明示し、CSS `white-space: pre-wrap;` への移行ガイドを提供します

主な変更点は以下のとおりです

- README 冒頭に deprecation notice を追加し Vue 2 EOL と CSS による代替が可能であることを明示
- Migration セクションを追加し before/after のコード例を掲載
- `pre-wrap` を推奨する理由(Issue #7 で議論された折り返し問題の解決)を補足
- 既存利用者向けに従来の API ドキュメントは引き続き残置
deprecation notice の README 反映と依存パッケージの更新を含む最終リリースとして v1.1.2 を切ります

主な変更点は以下のとおりです

- `package.json` の version を 1.1.1 から 1.1.2 に bump
- CHANGELOG に v1.1.2 のエントリを追加し本リリースが最終版であることを明示
@inouetakuya inouetakuya self-assigned this May 2, 2026
レビューで指摘された箇所をブラッシュアップし、移行先のコード例と振る舞いの差分の説明をより親切にします

主な変更点は以下のとおりです

- Before/After の例に `class` 属性を含め、`className` プロパティに相当する移行方法を明示
- CSS クラス例に `text` が `\n` を含む前提であることの注記を追加
- Notes セクションを追加し `<br>` 注入と `pre-wrap` の振る舞いの差分(空白保持・コピー挙動)を説明
@inouetakuya
inouetakuya merged commit e6aaf22 into main May 2, 2026
1 check passed
@inouetakuya
inouetakuya deleted the chore/deprecation branch May 2, 2026 13:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant