royle

command module

v1.20240616.140238 Latest Latest Go to latest Published: Jun 16, 2024 License: MIT Imports: 1 Imported by: 0

Details

MYSQLドキュメントを生成するコマンドラインアプリケーション

go install github.com/digeon-inc/royle@latest

royle --host mysql --password password --port 3306 --user docker --database template -x "path/to/gorm/dir1 path/to/gorm/dir2" > doc.md

pandocと合わせて使えば様々なフォーマットに変換することができます。

 royle --host mysql --password password --port 3306 --user docker --database template | pandoc -o doc.html

royle --host mysql --password password --port 3306 --user docker --database template | Out-File -FilePath doc.md -Encoding utf8

フラグ	短縮形	説明
--host	-s	MYSQLのホスト (必須)
--password	-p	MYSQLのパスワード (必須)
--port	-r	MYSQLのポート (必須)
--user	-u	mysqlのユーザー (必須)
--database	-d	MYSQLのデータベース名 (必須)
--title	-t	ドキュメントのタイトル
--help	-h	コマンドについての説明
--dirs	-x	gormファイルがあるディレクトリのパス。指定することでファイル内で宣言したカラム順になる。

--dirsフラグが指定された時だけ有効です。各フラグについての説明はgormのドキュメントを参照してください。デフォルト値はgorm使用時と同じに設定してます。

フラグ名	デフォルト値	例
--table-prefix	""	--table-prefix=my_prefix
--singular-table	false	--singular-table=true
--replace-list	nil	--replace-list="old_name1　new_name1 old_name2 new_name2"
--no-lowercase	false	--no-lowercase=true
--identifier-max-length	64	--identifier-max-length=100

example.sqlで作ったテーブルから生成したマークダウンをpandocでhtmlにしたドキュメント

##に続く見出しはテーブル名である。また、その見出しのすぐ下にある説明はテーブルのコメントである。

列名	説明
Name	カラムの名前。
TYPE	カラムのデータ型。
Nullable	カラムの NULL 値可能性。この値は、NULL 値をカラムに格納できる場合は YES で、格納できない場合は NO。
Constraints	制約のタイプ。値は、UNIQUE, PRIMARY KEY, FOREIGN KEY または (MySQL 8.0.16) CHECK。
Referenced	FOREIGN KEY が参照しているテーブルの名前。
Default	カラムのデフォルト値。
Extra	カラムについての追加情報。 AUTO_INCREMENT 属性、ON UPDATE CURRENT_TIMESTAMP 属性、生成されたカラムの STORED GENERATED または VIRTUAL GENERATED、式のデフォルト値を持つカラムの DEFAULT_GENERATED。
Comment	カラムのコメント。

royleを使うことでドキュメント生成を自動化でき、手作業での作業時間を節約できます。これにより、開発者やチームはより多くの時間を実際のコードの開発や修正に費やすことができます。 Github Actionの例はこちら。

royleはドキュメントを生成するときにmysqlのテーブル情報を毎回取得し、正確な情報を提供します。特に開発者がormを使っている場合、データベース上でテーブルがどのように表現されているかをormのドキュメントなしで正確に知ることができます。

There is no documentation for this package.

Path	Synopsis
cmd
filter
consumer
producer
transformer
transformer/another_test_data
transformer/test_data
integration_test
another_test_data
test_data
pipe