Merge pull request #3 from chenasraf/develop

chore: release

.github/workflows/develop.yml

@@ -0,0 +1,71 @@
+name: Release
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    types: [opened, synchronize]
+
+concurrency:
+  group: github.head_ref
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: lint
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: JohnnyMorganz/stylua-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: latest
+          args: --check .
+
+  documentation:
+    runs-on: ubuntu-latest
+    name: documentation
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 2
+
+      - name: setup neovim
+        uses: rhysd/action-setup-vim@v1
+        with:
+          neovim: true
+          version: v0.8.3
+
+      - name: generate documentation
+        run: make documentation-ci
+
+      - name: check docs diff
+        run: exit $(git status --porcelain doc | wc -l | tr -d " ")
+  release:
+    name: release
+    if: ${{ github.ref == 'refs/heads/develop' }}
+    permissions: write-all
+    needs:
+      - lint
+      - documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: google-github-actions/release-please-action@v3
+        id: release
+        with:
+          release-type: simple
+          package-name: text-transform.nvim
+
+      - name: tag dev versions
+        if: ${{ steps.release.outputs.release_created }}
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+          git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/google-github-actions/release-please-action.git"
+          git tag -d dev || true
+          git push origin :dev || true
+          git tag -a dev -m "Last Development Release"
+          git push origin dev

README.md

@@ -48,9 +48,9 @@ _[GIF version of the showcase video for mobile users](SHOWCASE_GIF_LINK)_
 
 ```lua
 -- stable version
-use {"text-transform.nvim", tag = "*" }
+use { "chenasraf/text-transform.nvim", tag = "*" }
 -- dev version
-use {"text-transform.nvim"}
+use { "chenasraf/text-transform.nvim" }
 ```
 
 </td>
@@ -65,9 +65,9 @@ use {"text-transform.nvim"}
 
 ```lua
 -- stable version
-Plug "text-transform.nvim", { "tag": "*" }
+Plug "chenasraf/text-transform.nvim", { "tag": "*" }
 -- dev version
-Plug "text-transform.nvim"
+Plug "chenasraf/text-transform.nvim"
 ```
 
 </td>
@@ -82,9 +82,9 @@ Plug "text-transform.nvim"
 
 ```lua
 -- stable version
-require("lazy").setup({{"text-transform.nvim", version = "*"}})
+require("lazy").setup({{ "chenasraf/text-transform.nvim", version = "*" }})
 -- dev version
-require("lazy").setup({"text-transform.nvim"})
+require("lazy").setup({ "chenasraf/text-transform.nvim" })
 ```
 
 </td>

doc/text-transform.txt

@@ -9,6 +9,7 @@ Default values:
   TextTransform.options = {
       -- Prints useful logs about what event are triggered, and reasons actions are executed.
       debug = false,
+      -- Keymap to trigger the transform.
       keymap = {
           "<Leader>~",
       },

lua/text-transform/config.lua

@@ -7,6 +7,7 @@ local TextTransform = {}
 TextTransform.options = {
     -- Prints useful logs about what event are triggered, and reasons actions are executed.
     debug = false,
+    -- Keymap to trigger the transform.
     keymap = {
         "<Leader>~",
     },

plugin/text-transform.lua

@@ -154,11 +154,6 @@ vim.cmd("amenu Transforms.&kebab-case :lua ReplaceCurrentWord(KebabCase)<CR>")
 vim.cmd("amenu Transforms.&dot\\.case :lua ReplaceCurrentWord(DotCase)<CR>")
 vim.cmd("amenu Transforms.&Title\\ Case :lua ReplaceCurrentWord(TitleCase)<CR>")
 
-for i in TextTransform.config.keymap do
-    vim.keymap.set(
-        { "n", "v" },
-        _G.TextTransform.config.keymap[i],
-        "<cmd>popup Transforms<CR>",
-        { silent = true }
-    )
+for kmap in _G.TextTransform.config.keymap do
+    vim.keymap.set({ "n", "v" }, kmap, "<cmd>popup Transforms<CR>", { silent = true })
 end