aboutsummaryrefslogtreecommitdiff
path: root/config.go
AgeCommit message (Collapse)Author
2026-01-15config: use embed for spdxconv.cfg templateShulhan
Using embed made it easy to edit and review the code.
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 match-file-pattern for common filesShulhan
The Makefile, go.mod, and go.sum are known file names.
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: fix default regex match license and copyright to ignore commentShulhan
Instead of assuming that the comment prefix and space always exists "^(//)\s+..." change it to be optional, so it will works on the multi-line comment. For example, comment and old headers in html, <-- Copyright ... --> there is no comment prefix and space.
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-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-08cmd/spdxconv: implement "init" commandShulhan
The init command create the spdxconv configuration file in the current directory.
2026-01-08all: implement conversion for SPDX-License-IdentifierShulhan
If the file contains "SPDX-License-Identifier", it will not modify it. The program will move the identifier to the top of file after shebang. If the spdxconv.cfg contains match-license, and the pattern match with one of the line in the file, it will use the license_identifier instead of default one and insert it at the top, after shebang. If the files does not contains the identifier, it will insert new one based on default value in spdxconv.cfg file.
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.