一部のソースファイルにライセンスヘッダーを一括で追加するツールを探しています。その一部にはすでにヘッダーがあります。ヘッダーがまだ存在しない場合、ヘッダーを挿入するツールはありますか?
編集:回答は基本的にすべて環境固有で主観的なものであるため、私は意図的にこの質問に対する回答をマークしていません
一部のソースファイルにライセンスヘッダーを一括で追加するツールを探しています。その一部にはすでにヘッダーがあります。ヘッダーがまだ存在しない場合、ヘッダーを挿入するツールはありますか?
編集:回答は基本的にすべて環境固有で主観的なものであるため、私は意図的にこの質問に対する回答をマークしていません
回答:
#!/bin/bash
for i in *.cc # or whatever other pattern...
do
if ! grep -q Copyright $i
then
cat copyright.txt $i >$i.new && mv $i.new $i
fi
done
"$i"
for i in $(find /folder -name '*.cc');
に置き換えて、サブディレクトリでスクリプトを実行します
Pythonソリューション、必要に応じて変更
特徴:
-
# updates the copyright information for all .cs files
# usage: call recursive_traversal, with the following parameters
# parent directory, old copyright text content, new copyright text content
import os
excludedir = ["..\\Lib"]
def update_source(filename, oldcopyright, copyright):
utfstr = chr(0xef)+chr(0xbb)+chr(0xbf)
fdata = file(filename,"r+").read()
isUTF = False
if (fdata.startswith(utfstr)):
isUTF = True
fdata = fdata[3:]
if (oldcopyright != None):
if (fdata.startswith(oldcopyright)):
fdata = fdata[len(oldcopyright):]
if not (fdata.startswith(copyright)):
print "updating "+filename
fdata = copyright + fdata
if (isUTF):
file(filename,"w").write(utfstr+fdata)
else:
file(filename,"w").write(fdata)
def recursive_traversal(dir, oldcopyright, copyright):
global excludedir
fns = os.listdir(dir)
print "listing "+dir
for fn in fns:
fullfn = os.path.join(dir,fn)
if (fullfn in excludedir):
continue
if (os.path.isdir(fullfn)):
recursive_traversal(fullfn, oldcopyright, copyright)
else:
if (fullfn.endswith(".cs")):
update_source(fullfn, oldcopyright, copyright)
oldcright = file("oldcr.txt","r+").read()
cright = file("copyrightText.txt","r+").read()
recursive_traversal("..", oldcright, cright)
exit()
著作権ヘッダーRubyGemをチェックしてください。拡張子がphp、c、h、cpp、hpp、hh、rb、css、js、htmlで終わるファイルをサポートします。また、ヘッダーを追加および削除することもできます。
「sudo gem install copyright-header
」と入力してインストールします
その後、次のようなことができます。
copyright-header --license GPL3 \
--add-path lib/ \
--copyright-holder 'Dude1 <dude1@host.com>' \
--copyright-holder 'Dude2 <dude2@host.com>' \
--copyright-software 'Super Duper' \
--copyright-software-description "A program that makes life easier" \
--copyright-year 2012 \
--copyright-year 2012 \
--word-wrap 80 --output-dir ./
また、-license-file引数を使用したカスタムライセンスファイルもサポートしています。
--license-file
引数とともに渡し、--remove-path
フラグを使用してすべてのファイルからその正確なヘッダーを削除します。基本的に、ヘッダーには非常に多くの種類があり、それらを確実に削除するアルゴリズムを作成することは簡単ではありません。
Dockerfile
ので、面倒なルビーの依存関係をインストールすることはもはや問題ではありません
以下は、license.txtファイルにライセンスヘッダーがあると仮定して、トリックを実行するBashスクリプトです。
ファイルaddlicense.sh:
#!/bin/bash
for x in $*; do
head -$LICENSELEN $x | diff license.txt - || ( ( cat license.txt; echo; cat $x) > /tmp/file;
mv /tmp/file $x )
done
次に、これをソースディレクトリで実行します。
export LICENSELEN=`wc -l license.txt | cut -f1 -d ' '`
find . -type f \(-name \*.cpp -o -name \*.h \) -print0 | xargs -0 ./addlicense.sh
cut -f1 -d ' '
編集:Eclipseを使用している場合は、プラグインがあります
SilverDragonの返信に基づいて簡単なPythonスクリプトを作成しました。より柔軟なソリューションが必要だったので、これを思いつきました。これにより、ディレクトリ内のすべてのファイルに再帰的にヘッダーファイルを追加できます。オプションで、ファイル名が一致する必要のある正規表現、ディレクトリ名が一致する必要のある正規表現、およびファイルの最初の行が一致しない必要のある正規表現を追加できます。この最後の引数を使用して、ヘッダーがすでに含まれているかどうかを確認できます。
これがシバン(#!)で始まる場合、このスクリプトはファイルの最初の行を自動的にスキップします。これは、これに依存する他のスクリプトを壊さないためです。この動作を望まない場合は、writeheaderで3行をコメントアウトする必要があります。
ここにあります:
#!/usr/bin/python
"""
This script attempts to add a header to each file in the given directory
The header will be put the line after a Shebang (#!) if present.
If a line starting with a regular expression 'skip' is present as first line or after the shebang it will ignore that file.
If filename is given only files matchign the filename regex will be considered for adding the license to,
by default this is '*'
usage: python addheader.py headerfile directory [filenameregex [dirregex [skip regex]]]
easy example: add header to all files in this directory:
python addheader.py licenseheader.txt .
harder example adding someone as copyrightholder to all python files in a source directory,exept directories named 'includes' where he isn't added yet:
python addheader.py licenseheader.txt src/ ".*\.py" "^((?!includes).)*$" "#Copyright .* Jens Timmerman*"
where licenseheader.txt contains '#Copyright 2012 Jens Timmerman'
"""
import os
import re
import sys
def writeheader(filename,header,skip=None):
"""
write a header to filename,
skip files where first line after optional shebang matches the skip regex
filename should be the name of the file to write to
header should be a list of strings
skip should be a regex
"""
f = open(filename,"r")
inpt =f.readlines()
f.close()
output = []
#comment out the next 3 lines if you don't wish to preserve shebangs
if len(inpt) > 0 and inpt[0].startswith("#!"):
output.append(inpt[0])
inpt = inpt[1:]
if skip and skip.match(inpt[0]): #skip matches, so skip this file
return
output.extend(header) #add the header
for line in inpt:
output.append(line)
try:
f = open(filename,'w')
f.writelines(output)
f.close()
print "added header to %s" %filename
except IOError,err:
print "something went wrong trying to add header to %s: %s" % (filename,err)
def addheader(directory,header,skipreg,filenamereg,dirregex):
"""
recursively adds a header to all files in a dir
arguments: see module docstring
"""
listing = os.listdir(directory)
print "listing: %s " %listing
#for each file/dir in this dir
for i in listing:
#get the full name, this way subsubdirs with the same name don't get ignored
fullfn = os.path.join(directory,i)
if os.path.isdir(fullfn): #if dir, recursively go in
if (dirregex.match(fullfn)):
print "going into %s" % fullfn
addheader(fullfn, header,skipreg,filenamereg,dirregex)
else:
if (filenamereg.match(fullfn)): #if file matches file regex, write the header
writeheader(fullfn, header,skipreg)
def main(arguments=sys.argv):
"""
main function: parses arguments and calls addheader
"""
##argument parsing
if len(arguments) > 6 or len(arguments) < 3:
sys.stderr.write("Usage: %s headerfile directory [filenameregex [dirregex [skip regex]]]\n" \
"Hint: '.*' is a catch all regex\nHint:'^((?!regexp).)*$' negates a regex\n"%sys.argv[0])
sys.exit(1)
skipreg = None
fileregex = ".*"
dirregex = ".*"
if len(arguments) > 5:
skipreg = re.compile(arguments[5])
if len(arguments) > 3:
fileregex = arguments[3]
if len(arguments) > 4:
dirregex = arguments[4]
#compile regex
fileregex = re.compile(fileregex)
dirregex = re.compile(dirregex)
#read in the headerfile just once
headerfile = open(arguments[1])
header = headerfile.readlines()
headerfile.close()
addheader(arguments[2],header,skipreg,fileregex,dirregex)
#call the main method
main()
Javaの場合、Mavenのライセンスプラグインを使用できます:http://code.google.com/p/maven-license-plugin/
これは、フォルダ内の指定した種類のすべてのファイルを検索し、必要なテキスト(ライセンステキスト)を先頭に追加して、結果を別のディレクトリにコピーする(潜在的な上書きの問題を回避する)単純なWindows専用UIツールです。 。それも無料です。必須の.Net4.0。
私は実際に作者なので、修正や新機能を自由にリクエストしてください...ただし、配信スケジュールについての約束はありません。;)
ライセンス追加機能を確認してください。複数のコードファイル(カスタムファイルも含む)をサポートし、既存のヘッダーを正しく処理します。最も一般的なオープンソースライセンスのテンプレートがすでに付属しています。
license-adder
あなたは正確にどちらを参照していますか?私が見つけた、Googleプロジェクトホスティング-自由な.NETアプリケーションを-ライセンス加算器、およびライセンス・アダー・簡単なPythonスクリプト・GitHubの
これは、PHPファイルを変更するためにPHPでロールしたものです。削除する古いライセンス情報もあったので、最初に古いテキストを置き換えてから、開いた直後に新しいテキストを追加します
<?php
class Licenses
{
protected $paths = array();
protected $oldTxt = '/**
* Old license to delete
*/';
protected $newTxt = '/**
* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
*/';
function licensesForDir($path)
{
foreach(glob($path.'/*') as $eachPath)
{
if(is_dir($eachPath))
{
$this->licensesForDir($eachPath);
}
if(preg_match('#\.php#',$eachPath))
{
$this->paths[] = $eachPath;
}
}
}
function exec()
{
$this->licensesForDir('.');
foreach($this->paths as $path)
{
$this->handleFile($path);
}
}
function handleFile($path)
{
$source = file_get_contents($path);
$source = str_replace($this->oldTxt, '', $source);
$source = preg_replace('#\<\?php#',"<?php\n".$this->newTxt,$source,1);
file_put_contents($path,$source);
echo $path."\n";
}
}
$licenses = new Licenses;
$licenses->exec();
それでも必要な場合は、SrcHeadという名前の小さなツールがあります。あなたはそれをhttp://www.solvasoft.nl/downloads.htmlで見つけることができます
header.txt
前に付加され//
、最初の行はUnicodeBOMで始まります。
sbtを使用している場合は、https://github.com/Banno/sbt-license-pluginがあります。