comparing 20fd4ef1704bac2c1c560bb5742c0a4cd838430f and master on ejri.dev/baredot.nvim

+37

.github/workflows/ci.yml

···

       1
       1
       +
       name: CI

     

       2
       2
       +
       on:

     

       3
       3
       +
         push:

     

       4
       4
       +
           branches:

     

       5
       5
       +
             - 'master'

     

       6
       6
       +
         pull_request:

     

       7
       7
       +
           branches:

     

       8
       8
       +
             - 'master'

     

       9
       9
       +
       

     

       10
       10
       +
       jobs:

     

       11
       11
       +
         docs:

     

       12
       12
       +
           runs-on: ubuntu-latest

     

       13
       13
       +
           steps:

     

       14
       14
       +
             - uses: actions/checkout@v4

     

       15
       15
       +
             - name: panvimdoc

     

       16
       16
       +
               uses: kdheepak/panvimdoc@v4.0.1

     

       17
       17
       +
               with:

     

       18
       18
       +
                 vimdoc: baredot.nvim

     

       19
       19
       +
                 version: "Neovim >= 0.9.0"

     

       20
       20
       +
                 demojify: true

     

       21
       21
       +
                 treesitter: true

     

       22
       22
       +
             - name: Push changes

     

       23
       23
       +
               uses: stefanzweifel/git-auto-commit-action@v5

     

       24
       24
       +
               with:

     

       25
       25
       +
                 commit_message: "chore(build): auto-generate vimdoc"

     

       26
       26
       +
                 commit_user_name: "github-actions[bot]"

     

       27
       27
       +
                 commit_user_email: "github-actions[bot]@users.noreply.github.com"

     

       28
       28
       +
                 commit_author: "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"

     

       29
       29
       +
         release:

     

       30
       30
       +
           name: release

     

       31
       31
       +
           needs:

     

       32
       32
       +
             - docs

     

       33
       33
       +
           runs-on: ubuntu-latest

     

       34
       34
       +
           steps:

     

       35
       35
       +
             - uses: googleapis/release-please-action@v4

     

       36
       36
       +
               with:

     

       37
       37
       +
                 release-type: simple

CHANGELOG.md

···

       1
       1
       +
       # Changelog

     

       2
       2
       +
       

     

       3
       3
       +
       ## [1.1.0](https://github.com/ejrichards/baredot.nvim/compare/v1.0.0...v1.1.0) (2024-06-17)

     

       4
       4
       +
       

     

       5
       5
       +
       

     

       6
       6
       +
       ### Features

     

       7
       7
       +
       

     

       8
       8
       +
       * Adding "is_enabled" lua function ([9fd8094](https://github.com/ejrichards/baredot.nvim/commit/9fd80946fe0ad6ab5147238751472e023f4a01c4))

+3 -2

README.md

···

       40
       40
        
       

     

       41
       41
        
       ## Commands

     

       42
       42
        
       

     

       43
       43
       -
       - `:BaredotInfo` - Print current status

     

       44
       44
       -
       - `:BaredotToggle` - Manually toggle the env vars on / off

     

       43
       43
       +
       - `:Baredot info` - Print current status

     

       44
       44
       +
       - `:Baredot toggle` - Manually toggle the env vars on / off

     

       45
       45
        
       

     

       46
       46
        
       ## Functions

     

       47
       47
        
       

     

       48
       48
        
       - `require("baredot").info()` - Print current status

     

       49
       49
       +
       - `require("baredot").is_enabled()` - Returns current status as boolean

     

       49
       50
        
       - `require("baredot").toggle()` - Manually toggle the env vars on / off

     

       50
       51
        
       - `require("baredot").set(boolean)` - Set the env vars on / off

+37

cliff.toml

···

       1
       1
       +
       [changelog]

     

       2
       2
       +
       # https://keats.github.io/tera/docs/#introduction

     

       3
       3
       +
       body = """

     

       4
       4
       +
       {% for group, commits in commits | group_by(attribute="group") %}

     

       5
       5
       +
           === {{ group | striptags | trim | upper_first }}

     

       6
       6
       +
           {% for commit in commits %}

     

       7
       7
       +
               - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\

     

       8
       8
       +
                   {% if commit.breaking %}[**breaking**] {% endif %}\

     

       9
       9
       +
                   {{ commit.message | upper_first }}\

     

       10
       10
       +
           {% endfor %}

     

       11
       11
       +
       {% endfor %}\n

     

       12
       12
       +
       """

     

       13
       13
       +
       # remove the leading and trailing s

     

       14
       14
       +
       trim = true

     

       15
       15
       +
       

     

       16
       16
       +
       [git]

     

       17
       17
       +
       conventional_commits = true

     

       18
       18
       +
       filter_unconventional = true

     

       19
       19
       +
       split_commits = false

     

       20
       20
       +
       

     

       21
       21
       +
       # Just things end users will care about

     

       22
       22
       +
       commit_parsers = [

     

       23
       23
       +
         { message = "^feat", group = "<!-- 0 -->🚀 Features" },

     

       24
       24
       +
         { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },

     

       25
       25
       +
         { message = "^doc", group = "<!-- 3 -->📚 Documentation" },

     

       26
       26
       +
         { message = "^perf", group = "<!-- 4 -->⚡ Performance" },

     

       27
       27
       +
         { message = "^style", group = "<!-- 5 -->🎨 Styling" },

     

       28
       28
       +
         { message = "^test", group = "<!-- 6 -->🧪 Testing" },

     

       29
       29
       +
         { message = "^chore|^ci|^refactor", skip = true },

     

       30
       30
       +
         { body = ".*security", group = "<!-- 8 -->🛡️ Security" },

     

       31
       31
       +
         { message = "^revert", group = "<!-- 9 -->◀️ Revert" },

     

       32
       32
       +
         { message = ".*", group = "<!-- 10 -->💼 Other" },

     

       33
       33
       +
       ]

     

       34
       34
       +
       # filter out the commits that are not matched by commit parsers

     

       35
       35
       +
       filter_commits = false

     

       36
       36
       +
       topo_order = false

     

       37
       37
       +
       sort_commits = "oldest"

doc/.gitkeep

This is a binary file and will not be displayed.

+76

doc/baredot.nvim.txt

···

       1
       1
       +
       *baredot.nvim.txt*        For Neovim >= 0.9.0        Last change: 2024 June 18

     

       2
       2
       +
       

     

       3
       3
       +
       ==============================================================================

     

       4
       4
       +
       Table of Contents                             *baredot.nvim-table-of-contents*

     

       5
       5
       +
       

     

       6
       6
       +
       1. Baredot                                              |baredot.nvim-baredot|

     

       7
       7
       +
         - Details                                     |baredot.nvim-baredot-details|

     

       8
       8
       +
         - Setup                                         |baredot.nvim-baredot-setup|

     

       9
       9
       +
         - Configuration                         |baredot.nvim-baredot-configuration|

     

       10
       10
       +
         - Commands                                   |baredot.nvim-baredot-commands|

     

       11
       11
       +
         - Functions                                 |baredot.nvim-baredot-functions|

     

       12
       12
       +
       

     

       13
       13
       +
       ==============================================================================

     

       14
       14
       +
       1. Baredot                                              *baredot.nvim-baredot*

     

       15
       15
       +
       

     

       16
       16
       +
       This is a Neovim plugin to automatically adjust `git` env vars when syncing

     

       17
       17
       +
       dotfiles using the "bare git repo" method:

     

       18
       18
       +
       

     

       19
       19
       +
       Dotfiles: Best way to store in a bare git repository

     

       20
       20
       +
       <https://www.atlassian.com/git/tutorials/dotfiles>

     

       21
       21
       +
       

     

       22
       22
       +
       

     

       23
       23
       +
       DETAILS                                         *baredot.nvim-baredot-details*

     

       24
       24
       +
       

     

       25
       25
       +
       When launching and when changing directory (eg. `:cd`), the plugin will detect

     

       26
       26
       +
       if the current directory is in a git repo by searching for a `.git` folder.

     

       27
       27
       +
       

     

       28
       28
       +
       - If a `.git` folder is found, the env vars are cleared and `git` will work as normal.

     

       29
       29
       +
       - If a `.git` folder is not found, and we are in `$HOME`, the env vars will be adjusted to use the

     

       30
       30
       +
           bare git repo. This will let other git plugins function using that repo.

     

       31
       31
       +
       

     

       32
       32
       +
       

     

       33
       33
       +
       SETUP                                             *baredot.nvim-baredot-setup*

     

       34
       34
       +
       

     

       35
       35
       +
       lazy.nvim

     

       36
       36
       +
       

     

       37
       37
       +
       >lua

     

       38
       38
       +
           {

     

       39
       39
       +
             "ejrichards/baredot.nvim",

     

       40
       40
       +
             opts = {

     

       41
       41
       +
               git_dir = "~/.cfg" -- Change this path

     

       42
       42
       +
             }

     

       43
       43
       +
           }

     

       44
       44
       +
       <

     

       45
       45
       +
       

     

       46
       46
       +
       

     

       47
       47
       +
       CONFIGURATION                             *baredot.nvim-baredot-configuration*

     

       48
       48
       +
       

     

       49
       49
       +
       >lua

     

       50
       50
       +
           {

     

       51
       51
       +
             -- These two options set the GIT_DIR and GIT_WORK_TREE env vars

     

       52
       52
       +
             -- They are expanded using "vim.fn.expand"

     

       53
       53
       +
             git_dir = "~/.cfg",

     

       54
       54
       +
             git_work_tree = "~",

     

       55
       55
       +
             -- Filename pattern to find that will disable Baredot

     

       56
       56
       +
             disable_pattern = "%.git"

     

       57
       57
       +
           }

     

       58
       58
       +
       <

     

       59
       59
       +
       

     

       60
       60
       +
       

     

       61
       61
       +
       COMMANDS                                       *baredot.nvim-baredot-commands*

     

       62
       62
       +
       

     

       63
       63
       +
       - `:Baredot info` - Print current status

     

       64
       64
       +
       - `:Baredot toggle` - Manually toggle the env vars on / off

     

       65
       65
       +
       

     

       66
       66
       +
       

     

       67
       67
       +
       FUNCTIONS                                     *baredot.nvim-baredot-functions*

     

       68
       68
       +
       

     

       69
       69
       +
       - `require("baredot").info()` - Print current status

     

       70
       70
       +
       - `require("baredot").is_enabled()` - Returns current status as boolean

     

       71
       71
       +
       - `require("baredot").toggle()` - Manually toggle the env vars on / off

     

       72
       72
       +
       - `require("baredot").set(boolean)` - Set the env vars on / off

     

       73
       73
       +
       

     

       74
       74
       +
       Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

     

       75
       75
       +
       

     

       76
       76
       +
       vim:tw=78:ts=8:noet:ft=help:norl:

+22 -10

lua/baredot/commands.lua

···

       13
       13
        
       	end

     

       14
       14
        
       end

     

       15
       15
        
       

     

       16
       16
       +
       function Commands.is_enabled()

     

       17
       17
       +
       	return vim.env.GIT_DIR ~= nil and vim.env.GIT_WORK_TREE ~= nil

     

       18
       18
       +
       end

     

       19
       19
       +
       

     

       16
       20
        
       function Commands.toggle()

     

       17
       17
       -
       	if vim.env.GIT_DIR == nil or vim.env.GIT_WORK_TREE == nil then

     

       18
       18
       -
       		Commands.set(true)

     

       19
       19
       -
       	else

     

       20
       20
       -
       		Commands.set(false)

     

       21
       21
       -
       	end

     

       21
       21
       +
       	Commands.set(not Commands.is_enabled())

     

       22
       22
        
       	Commands.info()

     

       23
       23
        
       end

     

       24
       24
        
       

     

       25
       25
        
       function Commands.info()

     

       26
       26
       -
       	if vim.env.GIT_DIR == nil or vim.env.GIT_WORK_TREE == nil then

     

       27
       27
       -
       		vim.notify("Baredot mode off", vim.log.levels.INFO, { title = "baredot.nvim" });

     

       28
       28
       -
       	else

     

       26
       26
       +
       	if Commands.is_enabled() then

     

       29
       27
        
       		vim.notify(

     

       30
       28
        
       			"Baredot mode on: GIT_DIR=" .. vim.env.GIT_DIR .. " GIT_WORK_TREE=" .. vim.env.GIT_WORK_TREE,

     

       31
       29
        
       			vim.log.levels.INFO,

     

       32
       30
        
       			{ title = "baredot.nvim" }

     

       33
       31
        
       		);

     

       32
       32
       +
       	else

     

       33
       33
       +
       		vim.notify("Baredot mode off", vim.log.levels.INFO, { title = "baredot.nvim" });

     

       34
       34
        
       	end

     

       35
       35
        
       end

     

       36
       36
        
       

     

       37
       37
        
       function Commands.setup(opt)

     

       38
       38
        
       	options = opt

     

       39
       39
        
       

     

       40
       40
       -
       	vim.api.nvim_create_user_command("BaredotInfo", Commands.info, { desc = "BaredotInfo" })

     

       41
       41
       -
       	vim.api.nvim_create_user_command("BaredotToggle", Commands.toggle, { desc = "BaredotToggle" })

     

       40
       40
       +
       	vim.api.nvim_create_user_command("Baredot", function(args)

     

       41
       41
       +
       		local cmd = vim.trim(args.args or "")

     

       42
       42
       +
       		if cmd == "toggle" then

     

       43
       43
       +
       			Commands.toggle()

     

       44
       44
       +
       		else

     

       45
       45
       +
       			Commands.info()

     

       46
       46
       +
       		end

     

       47
       47
       +
       	end, {

     

       48
       48
       +
       		desc = "Baredot",

     

       49
       49
       +
       		nargs = "?",

     

       50
       50
       +
       		complete = function()

     

       51
       51
       +
       			return { "info", "toggle" }

     

       52
       52
       +
       		end

     

       53
       53
       +
       	})

     

       42
       54
        
       end

     

       43
       55
        
       

     

       44
       56
        
       return Commands

lua/baredot/init.lua

···

       47
       47
        
       function Baredot.toggle()

     

       48
       48
        
       	return commands.toggle()

     

       49
       49
        
       end

     

       50
       50
       +
       ---@return boolean

     

       51
       51
       +
       function Baredot.is_enabled()

     

       52
       52
       +
       	return commands.is_enabled()

     

       53
       53
       +
       end

     

       50
       54
        
       

     

       51
       55
        
       return Baredot

Compare changes