Skip to content

✨ 変更を行ったファイルのパスのみをブラウザで開く機能 #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2024

Conversation

KentarouTakeda
Copy link
Contributor

@KentarouTakeda KentarouTakeda commented Nov 12, 2024

closes #1

簡易的な実装のため制限がありますが、変更対象に ある程度近い ページをブラウザで開くためのスクリプトとmakeターゲットを作成しました。

  • doc-base, phd の機能としては(おそらく)提供されていないため git status コマンドの出力をパースすることで変更対象を検出する実装としました。
  • 1つのxmlファイルが複数のページを出力するケースがあるため次のような仕様としました:
  • open とは別で open-modified ターゲットを新設
    • 上の通り、現時点で完全な実装ではないため
    • テストなども不足しているため

DocBookの仕様にあまり詳しくないため、追加したphpスクリプトの実装が想定していないxmlだった場合は誤動作するかもしれません。

極めて簡易的な実装のため、使い勝手良くない点やMakefileの仕様などはご自由にカスタマイズしてください。用途に合わない場合はクローズ頂いても大丈夫です。 Allow edits by maintainers はオンにしました。

@jdkfx
Copy link
Owner

jdkfx commented Nov 13, 2024

@KentarouTakeda

make buildの際に変更したファイルがあると Validating failed. となるようでした。
こちらの環境依存の問題もありそうだと思っているので、どうして java が必要なのかも含め、少し調べてみます。

Validating manual.xml... failed.

The document didn't validate
The operation couldn’t be completed. Unable to locate a Java Runtime.
Please visit http://www.java.com for information on installing Java.

Command failed do you have Java installed?
Eyh man. No worries. Happ shittens. Try again after fixing the errors above.
make: *** [build] Error 1

make buildでエラーは出つつも、make open-modifiedにて、編集したページのリンクに遷移してくれるので LGTM です! 👍

@jdkfx
Copy link
Owner

jdkfx commented Nov 13, 2024

@KentarouTakeda

make buildの際に変更したファイルがあると Validating failed. となるようでした。

と思っていたんですけれど、編集した箇所によって失敗するかしないかが変わるようでした。
たまたま、僕がテストで編集した箇所が

 <refnamediv>
  <refname>mb_http_output</refname>
  <refpurpose>HTTP 出力文字エンコーディングを設定あるいは取得する</refpurpose>
  <refpurpose>ここに追加テキスト</refpurpose>
 </refnamediv>

のような形で、本来一つしか追加してはいけないrefpurposeタグを複数追加したからかもしれません。
まだ中のコードを読んでいないので断言できませんが、既存のrefpurposeのなかでテキストを追記した場合では失敗しなかったため、それも踏まえ調べてみます。

@jdkfx jdkfx merged commit c682779 into jdkfx:main Nov 13, 2024
@KentarouTakeda KentarouTakeda deleted the open-modified-files branch November 13, 2024 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

make openで変更を行なったファイルのURLを開きたい
2 participants