☰

シェルやPythonスクリプトなどのスクリプトヘッダブロックを自動的に挿入して更新するツールはありますか？

tag-icon • tag-icon linux shell scripting utilities programming
シェルやPythonスクリプトなどのスクリプトヘッダブロックを自動的に挿入して更新するツールはありますか？

BashやPythonでかなり良いスクリプトを書いた元管理者が書いたスクリプトを見つけました。彼のスクリプトはすべてよくフォーマットされており、私が呼ぶように、常に似たような「スクリプトヘッダー」または「コードヘッダー」が付属しています。

私は彼がこれを行う方法と、このタイプの「コードヘッダー」を挿入して自動的に更新するためのよく知られたツールがあるかどうかを知りたいです。

どんなアイデア/ヒントがありますか？

以下は、これらのコードヘッダブロックの例です。 Pythonだけではありません。さまざまな言語とLinuxスクリプトで見つけることができます。

#!/usr/bin/env python
# vim:fileencoding=utf-8
#
#   project-name
#   ~~~~~~~~~~~~~~
#
#   script description
#
#   * Intended to be run as a cron job.
#
#   Project title:      Back-Up Management
#
#   Project directory:  FileHost/project-name
#
#   Project documents:  xxxxx
#                       yyyyy
#                       zzzzz
#
#   Target OS:          Unix
#
#   Target interpreter: Python 2.5
#
#   File encoding:      UTF-8
#
#   2010-11-23  adminName     Created
#
#   2015-06-12  AdminName     CHANGE: some description
#
#   $Id: script-name.py 474 2010-12-10 12:16:36Z adminName $
#

答え1

テキストの最後の行から始めます。

$Id: script-name.py 474 2010-12-10 12:16:36Z adminName $

これらのファイルはSubversionに保存されていると想定できます（キーワードの$Id$説明ここ）。以前のCVSもキーワードを使用していましたが、$Id$これによりファイル名がscript-name.py,v（完了したように）拡張されます。ここ）。

前の 2 つの項目は、改訂履歴のコミットコメントからのものかもしれませんが、タイトルの残りの部分は手作りのように見えます。

Project title:私は、コメントアウトされていない行に似た文字列を持つbash / pythonファイルを自分のコンピュータで検索します。以前の管理者がシステムのどこかに「ツール」を残した可能性があります。

関連情報