aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2026-01-15README: update the wording and grammarsShulhan
2026-01-15all: allow multiple pattern in match-file-commentShulhan
This makes the configuration more concise where pattern can be split into multi lines. While at it, add more pattern to match-file-comment.
2026-01-15all: add group "done" in the reportShulhan
The done group contain list of file that has been processed. File from group regular and binary that has been modified or added with SPDX format will be moved to here.
2026-01-14README: rewording and update header level on commandsShulhan
2026-01-14all: detect annotation from REUSE configurationShulhan
During scan, the program will read the REUSE.toml configuration. File that is already annotated inside REUSE.toml will be ignored during scan.
2026-01-14README: describe how the flow of scan commandShulhan
2026-01-14all: get the copyright year from git historyShulhan
If the line that match with pattern on match-copyright does not contains year, or there is no match, try to get the year from the first commit of the file using "git log --follow ..." command. If no commit history or its not using git, use default copyright year from configuration.
2026-01-13all: split the delete_line_pattern into before and afterShulhan
While at it, also add configuration for delete line before and after for match-copyright section.
2026-01-12all: add configuration for setting default copyright yearShulhan
The `copyright_year` set the default year to be used in `SPDX-FileCopyrightText`. The year can be a single year (for example "2026"), range of year (for example, "2000-2026"), or list of year with comma separated (for example, "2000,2001,2026"); as long as there is no space in between.
2026-01-12all: remove prefix config from struct matchCopyright and matchLicenseShulhan
2026-01-12all: implement match-file-comment for seting comment based on file nameShulhan
The first thing that the program do is to detect which comment string to be used when inserting SPDX identifiers in the file. For each pattern in the "match-file-comment" section, the program will match it with file name to get the comment prefix and suffix to be used later. User can add their own "match-file-comment" section as they like or modify the existing one. The "match-file-comment" can have empty prefix and suffix. That means, if the file name match, it will create new file with ".license" suffix that contains SPDX identifiers only, instead of inserting to the file.
2026-01-12config_match_license: remove unused field DeleteMatchShulhan
The line that match with pattern will be replaced with new SPDX license identifier, so no need to guard it with this flag.
2026-01-11all: implement apply commandShulhan
The apply command read the "spdxconv.report" and apply the license and copyright as stated on each file in the report. A file that has been successfully processed will be removed from the report.
2026-01-10report: store the index line number and comments in reportShulhan
For the index line number, instead of tied to license_id and copyright_id value (separated by ":"), store it in separate column as idx_license_id and idx_copyright_id. For comments, store the prefix and suffix at column 6 and 7 in CSV line.
2026-01-09report: change the output to use CSV formatShulhan
Using space separated with double quote on some fields are not easy to parse. Using CSV allow us to use the [encoding/csv] package from standard library.
2026-01-09all: implement the scan commandShulhan
The scan command scan the files that need to be converted or inserted with SPDX identifiers in the current directory. The result of scan is stored inside a report file named "spdxconv.report". There are no other files modified after scan completed. User then can inspect and modify the report to exclude certain files or changes the behaviour of apply command. Deleting a line in the report means excluding the file from being processed by "apply" command.
2026-01-08all: fix wrong copyright year on some filesShulhan
I wrote the initial codes in December 2025 but commit it on year 2026.
2026-01-08cmd/spdxconv: implement "init" commandShulhan
The init command create the spdxconv configuration file in the current directory.
2026-01-08all: add missing license and copyrightShulhan
Ah, the irony.
2026-01-06spdxconv: tool to convert license and copyright to SPDX formatShulhan
This is the initial implementation, work in progress, with the following functions, * loading the spdxconv.cfg file * scanning list of files to be converted * detect .git repository and exclude files ignored by .gitignore No conversion logic is implemented yet.