Merge pull request #24 from attilarepka/feat/support-multiline-copyright

feat(header): support multiline `copyright_text` as string or array

Author: attilarepka

README.md

@@ -45,7 +45,7 @@ The script comes with the following defaults:
     date_created_fmt = "%Y-%m-%d %H:%M:%S",
     date_modified = true,
     date_modified_fmt = "%Y-%m-%d %H:%M:%S",
-    line_separator = "------",
+    line_separator = nil,
     use_block_header = true,
     copyright_text = nil,
     license_from_file = false,
@@ -76,7 +76,11 @@ require("header").setup({
     date_modified_fmt = "%Y-%m-%d %H:%M:%S",
     line_separator = "------",
     use_block_header = false,
-    copyright_text = "Copyright 2023",
+    "copyright_text": [
+      "Copyright (c) 2023 Your Name",
+      "Your Company",
+      "All rights reserved."
+    ],
     license_from_file = false,
 })
 ```
@@ -130,7 +134,11 @@ The default configuration can be overwritten by a local project `.header.nvim` f
   "date_modified_fmt": "%Y-%m-%d %H:%M:%S",
   "line_separator": "------",
   "use_block_header": true,
-  "copyright_text": "Copyright (c) 2023 Your Name"
+  "copyright_text": [
+    "Copyright (c) 2023 Your Name",
+    "Your Company",
+    "All rights reserved."
+  ]
 }
 ```
 

lua/header.lua

@@ -14,7 +14,7 @@ header.config = {
     date_created_fmt = "%Y-%m-%d %H:%M:%S",
     date_modified = true,
     date_modified_fmt = "%Y-%m-%d %H:%M:%S",
-    line_separator = "------",
+    line_separator = nil,
     use_block_header = true,
     copyright_text = nil,
     license_from_file = false,
@@ -354,7 +354,12 @@ local function prepare_headers(callback)
         table.insert(headers, header.config.line_separator)
     end
     if header.config.copyright_text ~= nil then
-        table.insert(headers, header.config.copyright_text)
+        if type(header.config.copyright_text) == "string" then
+            local copyright_lines = string_to_table(header.config.copyright_text)
+            vim.list_extend(headers, copyright_lines)
+        elseif type(header.config.copyright_text) == "table" then
+            vim.list_extend(headers, header.config.copyright_text)
+        end
     end
 
     callback(headers)

tests/header/header_spec.lua

@@ -71,29 +71,42 @@ local function build_extended_expected_comments(file_name, comments, constants,
         style = comments.block or comments.line
     end
 
-    local result = {
-        style.line .. " " .. constants.file_name .. " " .. file_name,
-        style.line .. " " .. constants.project .. " " .. config.project,
-        style.line .. " " .. constants.author .. " " .. config.author,
-        style.line .. " " .. config.line_separator,
-        style.line .. " " .. config.copyright_text,
-        "",
-        file_name,
-    }
+    local result = {}
 
-    if style.start and style["end"] then
-        result = {
-            style.start,
-            style.line .. " " .. constants.file_name .. " " .. file_name,
-            style.line .. " " .. constants.project .. " " .. config.project,
-            style.line .. " " .. constants.author .. " " .. config.author,
-            style.line .. " " .. config.line_separator,
-            style.line .. " " .. config.copyright_text,
-            style["end"],
-            "",
-            file_name,
-        }
+    local function append_copyright_lines(text)
+        if not text then
+            return
+        end
+        if type(text) == "string" then
+            -- split on \n if any
+            for line in text:gmatch("[^\r\n]+") do
+                table.insert(result, style.line .. " " .. line)
+            end
+        elseif type(text) == "table" then
+            for _, line in ipairs(text) do
+                table.insert(result, style.line .. " " .. line)
+            end
+        end
+    end
+
+    if style.start then
+        table.insert(result, style.start)
     end
+
+    table.insert(result, style.line .. " " .. constants.file_name .. " " .. file_name)
+    table.insert(result, style.line .. " " .. constants.project .. " " .. config.project)
+    table.insert(result, style.line .. " " .. constants.author .. " " .. config.author)
+    table.insert(result, style.line .. " " .. config.line_separator)
+    append_copyright_lines(config.copyright_text)
+
+    if style["end"] then
+        table.insert(result, style["end"])
+    end
+
+    -- extra empty line and file name
+    table.insert(result, "")
+    table.insert(result, file_name)
+
     return result
 end
 
@@ -315,6 +328,74 @@ describe("add_headers", function()
             end
         end
     end)
+    it("should support multiline copyright text as an array", function()
+        local filetypes = require("filetypes")
+        for k, v in pairs(filetypes) do
+            vim.api.nvim_buf_set_lines(0, 0, -1, false, {})
+            local file_name = "main." .. k
+            vim.fn.setline(1, file_name)
+            vim.api.nvim_buf_set_name(0, file_name)
+
+            local config = {
+                file_name = true,
+                author = "test_author_name",
+                project = "test_project_name",
+                date_created = true,
+                date_created_fmt = "%Y-%m-%d %H:%M:%S",
+                date_modified = true,
+                date_modified_fmt = "%Y-%m-%d %H:%M:%S",
+                line_separator = "------",
+                use_block_header = true,
+                copyright_text = {
+                    "Copyright (c) 2023 Your Name",
+                    "Your Company",
+                    "All rights reserved."
+                },
+            }
+            header.setup(config)
+
+            header.add_headers()
+
+            local buffer = vim.api.nvim_buf_get_lines(0, 0, -1, false)
+            local comments = v()
+            local expected = build_extended_expected_comments(file_name, comments, header.constants, config)
+            local buffer_without_date = get_buffer_without_date(buffer, comments, header.constants)
+
+            assert.are.same(expected, buffer_without_date)
+        end
+    end)
+    it("should support multiline copyright text as a string with '\\n' separators", function()
+        local filetypes = require("filetypes")
+        for k, v in pairs(filetypes) do
+            vim.api.nvim_buf_set_lines(0, 0, -1, false, {})
+            local file_name = "main." .. k
+            vim.fn.setline(1, file_name)
+            vim.api.nvim_buf_set_name(0, file_name)
+
+            local config = {
+                file_name = true,
+                author = "test_author_name",
+                project = "test_project_name",
+                date_created = true,
+                date_created_fmt = "%Y-%m-%d %H:%M:%S",
+                date_modified = true,
+                date_modified_fmt = "%Y-%m-%d %H:%M:%S",
+                line_separator = "------",
+                use_block_header = true,
+                copyright_text = "Copyright (c) 2023 Your Name\nYour Company\nAll rights reserved."
+            }
+
+            header.setup(config)
+            header.add_headers()
+
+            local buffer = vim.api.nvim_buf_get_lines(0, 0, -1, false)
+            local comments = v()
+            local expected = build_extended_expected_comments(file_name, comments, header.constants, config)
+            local buffer_without_date = get_buffer_without_date(buffer, comments, header.constants)
+
+            assert.are.same(expected, buffer_without_date)
+        end
+    end)
 end)
 
 describe("update_date_modified", function()