Skip to content

Commit 2cb4634

Browse files
committed
Change mode name : report -> convert
1 parent 462c17d commit 2cb4634

File tree

8 files changed

+9
-9
lines changed

8 files changed

+9
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Here a short summary:
1919

2020
- `lint` --- Check whether the [source code's copyright and license writing rules][rule] are complied with.
2121

22-
- `report` --- Convert [oss-pkg-info.yaml](https://github.com/fosslight/fosslight_reuse/blob/main/tests/report/oss-pkg-info.yaml) to [FOSSLight-Report.xlsx](https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html) and vice versa.
22+
- `convert` --- Convert [oss-pkg-info.yaml](https://github.com/fosslight/fosslight_reuse/blob/main/tests/convert/oss-pkg-info.yaml) to [FOSSLight-Report.xlsx](https://fosslight.org/fosslight-guide-en/learn/2_fosslight_report.html) and vice versa.
2323

2424
- `add` --- Add copyright and license to missing file(s)
2525

src/fosslight_reuse/_help.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
Parameters:
1515
Mode
1616
lint\t\t Check REUSE compliance
17-
report\t\t oss_pkg_info.yaml <-> FOSSLight-Report.xlsx
17+
convert\t\t Convert oss_pkg_info.yaml <-> FOSSLight-Report.xlsx
1818
add\t\t\t Add missing license and copyright
1919
2020
Options:

src/fosslight_reuse/cli.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212
def main():
1313
parser = argparse.ArgumentParser(description='FOSSLight Reuse', prog='fosslight_reuse', add_help=False)
14-
parser.add_argument('mode', help='lint | report | add')
14+
parser.add_argument('mode', help='lint | convert | add')
1515
parser.add_argument('--path', '-p', help='Path to check', type=str, dest='path', default="")
1616
parser.add_argument('--file', '-f', help='Files to check', type=str, dest='file', default="")
1717
parser.add_argument('--output', '-o', help='Output file name', type=str, dest='output', default="")
@@ -29,7 +29,7 @@ def main():
2929

3030
if args.mode == "lint":
3131
run_lint(args.path, args.file, args.disable, args.output)
32-
elif args.mode == "report":
32+
elif args.mode == "convert":
3333
convert_report(args.path, args.file, args.output)
3434
elif args.mode == "add":
3535
add_content(args.path, args.file, args.license, args.copyright)
File renamed without changes.
File renamed without changes.

tox.ini

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ filterwarnings = ignore::DeprecationWarning
2424
commands =
2525
fosslight_reuse lint -p src/ -o "test_result/reuse_result.xml"
2626
fosslight_reuse lint -p src/ -f "fosslight_reuse/_fosslight_reuse.py" -o "test_result2/reuse_result.xml"
27-
fosslight_reuse report -p tests/report
28-
fosslight_reuse report -f tests/report/OSS-Report-Sample_1_BOM.xlsx -o test_report/output
29-
cat test_report/output.yaml
27+
fosslight_reuse convert -p tests/convert
28+
fosslight_reuse convert -f tests/convert/OSS-Report-Sample_1_BOM.xlsx -o test_convert/output
29+
cat test_convert/output.yaml
3030
rm -rf tests/add_result
3131
cp -r tests/add tests/add_result
3232
fosslight_reuse add -p tests/add_result -c "2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
@@ -39,8 +39,8 @@ commands =
3939
fosslight_reuse -h
4040
fosslight_reuse lint -p src/ -o "test_result/reuse_result.xml"
4141
fosslight_reuse lint -p src/ -f "fosslight_reuse/_fosslight_reuse.py" -o "test_result2/reuse_result.xml"
42-
fosslight_reuse report -p tests/report
43-
fosslight_reuse report -f tests/report/OSS-Report-Sample_1_BOM.xlsx -o test_report/output
42+
fosslight_reuse convert -p tests/convert
43+
fosslight_reuse convert -f tests/convert/OSS-Report-Sample_1_BOM.xlsx -o test_convert/output
4444
cp -r tests/add tests/add_result
4545
fosslight_reuse add -p tests/add_result -c "2019-2021 LG Electronics Inc." -l "GPL-3.0-only"
4646
pytest -v --flake8

0 commit comments

Comments
 (0)