Templates for Swift files

[wojciech-kulik]

Often, you want to have templates for specific files in your project or at least you want to have a header (like when using Xcode).

I created a small function that fills in a new file with predefined template. Based on the file name suffix it can use the relevant template.

This function is also able to replace some placeholders like {date}, {filename}, and {name}. If you place {cursor} in your template, the cursor will be automatically moved there.

vim.api.nvim_create_autocmd({ "BufNewFile", "BufReadPost" }, {
  group = "bufcheck",
  pattern = "*.swift",
  callback = function(ev)
    local lines = #vim.api.nvim_buf_get_lines(ev.buf, 0, -1, false)

    if lines > 1 then
      return
    end

    local filename = string.match(ev.file, "([^/]*)%.swift")
    local name = filename

    -- TODO: make sure this path leads to your folder with templates!!
    local basepath = os.getenv("HOME") .. "/.config/YOUR_CONFIG_PATH/templates/"
    local templates = { "View", "ViewModel", "Builder", "Router", "Tests", "Spec" }

    local template
    local cursor

    for _, templateSuffix in ipairs(templates) do
      if vim.endswith(filename, templateSuffix) then
        template = vim.fn.readfile(basepath .. string.lower(templateSuffix) .. ".txt")
        name = string.gsub(name, templateSuffix, "")
        break
      end
    end

    template = template or vim.fn.readfile(basepath .. "empty.txt")

    for i = 1, #template do
      template[i] = string.gsub(template[i], "{date}", os.date("%d/%m/%Y"))
      template[i] = string.gsub(template[i], "{filename}", filename)
      template[i] = string.gsub(template[i], "{name}", name)

      if cursor == nil and string.find(template[i], "{cursor}") then
        cursor = { i, tonumber(string.find(template[i], "{cursor}")) + 1 }
      end
      template[i] = string.gsub(template[i], "{cursor}", " ")
    end

    vim.api.nvim_buf_set_lines(ev.buf, 0, -1, false, template)

    if cursor then
      vim.api.nvim_win_set_cursor(0, cursor)
    end

    vim.cmd("w")
  end,
})

Sample template templates/viewmodel.txt

//
//  {filename}.swift
//
//
//  Created by YOUR_NAME on {date}.
//  Copyright © 2024 YOUR_COMPANY. All rights reserved.
//

import Foundation

protocol {filename}Protocol: ObservableObject {
    var someProperty: String { get }
}

final class {filename}: {filename}Protocol {
    @Published var someProperty: String = ""

    init() {
        {@cursor@}
    }
}

[wojciech-kulik]

Moved to Wiki