Batman

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @AlejandroSuero

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,129 @@
+name: Bug Report
+description: Report a problem with freeze-code.nvim
+title: "[Bug]: "
+labels:
+  - bug
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        # Before reporting
+
+        - Confirm that the problem is reproducible.
+        - Try using the [minimal reproduction template](https://github.com/AlejandroSuero/freeze-code.nvim/blob/main/contrib/minimal.lua).
+
+  - type: checkboxes
+    id: pre-requisites
+    attributes:
+      label: Pre-requisites
+      description: Make sure to check to see if you are following this requisites.
+      options:
+        - label: The issue is reproducible
+          required: true
+        - label: The aren't other issues similar to this problem.
+          required: true
+        - label: The aren't PRs tackling this problem.
+          required: true
+
+  - type: markdown
+    attributes:
+      value: |
+        ## Issue report
+
+  - type: textarea
+    id: nvim-version
+    attributes:
+      label: NeoVim version
+      description: Paste here your NeoVim version, `nvim --version`.
+      placeholder: |
+        NVIM v0.9.5
+        Build type: RelWithDebInfo
+        LuaJIT 2.1.1692716794
+    validations:
+      required: true
+
+  - type: dropdown
+    id: operative-system
+    attributes:
+      label: Operative system
+      description: OS in which the issue occurs
+      multiple: true
+      options:
+        - Windows
+        - MacOS
+        - Linux
+        - Android
+        - All systems
+    validations:
+      required: true
+
+  - type: textarea
+    id: os-version
+    attributes:
+      label: OS version
+      description: OS version in which the issue occurs
+      placeholder: |
+        MacOS 14.4.1
+        Windows 11
+        Ubuntu 22.04
+        ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: issue-behaviour
+    attributes:
+      label: Behaviour
+      description: Describe the current behaviour. May include logs, images, videos ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: repro-steps
+    attributes:
+      label: Steps to reproduce
+      description: List the steps to reproduce the behaviour mentioned above.
+      placeholder: |
+        1. `nvim --clean -u minimal.lua`
+        2. Go to ...
+        3. Use ...
+        ...
+    validations:
+      required: true
+
+  - type: textarea
+    id: minimal-config
+    attributes:
+      label: Minimal config
+      description: Minimal configuration to reproduce this behaviour.
+      render: lua
+      value: |
+        vim.cmd([[set runtimepath=$VIMRUNTIME]])
+        vim.cmd([[set packpath=/tmp/nvim/]])
+
+        local lazypath = "/tmp/nvim/lazy/lazy.nvim"
+        if not vim.loop.fs_stat(lazypath) then
+          vim.fn.system({
+            "git",
+            "clone",
+            "--filter=blob:none",
+            "https://github.com/folke/lazy.nvim.git",
+            "--branch=stable", -- latest stable release
+            lazypath,
+          })
+        end
+        vim.opt.rtp:prepend(lazypath)
+
+        require("lazy").setup({
+          {
+            "AlejandroSuero/freeze-code.nvim",
+            config = function()
+              require("freeze-code").setup()
+            end,
+            lazy = false,
+            enabled = true,
+          },
+        })
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,24 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[Feat]: "
+labels: enhancement
+assignees: ""
+---
+
+## Is your feature request related to a problem? Please describe
+
+A clear and concise description of what the problem is. Ex. I'm always frustrated
+when [...]
+
+## Describe the solution you'd like
+
+A clear and concise description of what you want to happen.
+
+## Describe alternatives you've considere
+
+A clear and concise description of any alternative solutions or features you've considered.
+
+## Additional context
+
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,36 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. Please also
+include relevant motivation and context
+
+Fixes # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- Bug fix (non-breaking change which fixes an issue)
+- New feature (non-breaking change which adds functionality)
+- Breaking change (fix or feature that would cause existing functionality to not
+  work as expected)
+- This change requires a documentation update
+
+## How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes. Provide
+instructions so we can reproduce. Please also list relevant details about your configuration
+
+- [ ] Test A
+- [ ] Test B
+
+**Configuration**:
+
+- Neovim version (`nvim --version`):
+- Operating system and version:
+
+## Checklist
+
+- [ ] My code follows the style guidelines of this project (stylua)
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation

.github/workflows/commitlint.yml

@@ -0,0 +1,15 @@
+name: commitlint
+
+on: [pull_request]
+
+jobs:
+  lint-commits:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: npm install --save-dev @commitlint/{cli,config-conventional}
+      - run: |
+          echo "module.exports = { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
+      - run: npx commitlint --from HEAD~1 --to HEAD --verbose

.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: docs
+
+on: ["push", "pull_request"]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Generating docs with panvimdoc
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: freeze-code.nvim
+          version: "Neovim >= 0.8.0"
+          demojify: true
+          treesitter: true
+      - name: Push changes
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: "auto-generate vimdoc"
+          commit_user_name: "github-actions[bot]"
+          commit_user_email: "github-actions[bot]@users.noreply.github.com"
+          commit_author:
+            "github-actions[bot] <github-actions[bot]@users.noreply.github.com>"

.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: lint
+
+on: ["push", "pull_request"]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Run selene
+        uses: NTBBloodbath/[email protected]
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --display-style quiet lua/freeze-code
+
+  style-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Lint with stylua
+        uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: latest
+          args: --check .

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: "release"
+on:
+  push:
+    tags:
+      - "*"
+jobs:
+  luarocks-upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: LuaRocks Upload
+        uses: nvim-neorocks/luarocks-tag-release@v5
+        env:
+          LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
+        with:
+          summary: |
+            A code snapshot plugin using freeze.
+          detailed_description: |
+            This plugin allows you to take a "screenshot" of your code,
+            thanks to freeze by charm.sh.
+          licence: "MIT/X11"

.github/workflows/test.yml

@@ -0,0 +1,68 @@
+name: test
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  vusted:
+    name: Run Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        nvim-versions: ["stable", "nightly"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: LuaJIT
+        uses: leafo/gh-actions-lua@v10
+        with:
+          luaVersion: "luajit-2.1.0-beta3"
+
+      - name: Luarocks
+        uses: leafo/gh-actions-luarocks@v4
+
+      - name: Run test with vusted
+        shell: bash
+        run: |
+          luarocks install vusted
+          make test
+
+  run_tests:
+    name: unit tests
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-22.04
+            rev: nightly/nvim-linux64.tar.gz
+          - os: ubuntu-22.04
+            rev: stable/nvim-linux64.tar.gz
+          - os: ubuntu-22.04
+            rev: v0.8.3/nvim-linux64.tar.gz
+          - os: ubuntu-22.04
+            rev: v0.9.1/nvim-linux64.tar.gz
+    steps:
+      - uses: actions/checkout@v3
+      - run: date +%F > todays-date
+      - name: Restore cache for today's nightly.
+        uses: actions/cache@v3
+        with:
+          path: _neovim
+          key: |
+            ${{ runner.os }}-${{ matrix.rev }}-${{ hashFiles('todays-date') }}
+      - name: Prepare
+        run: |
+          test -d _neovim || {
+            mkdir -p _neovim
+            curl -sL "https://github.com/neovim/neovim/releases/download/${{ matrix.rev }}" | tar xzf - --strip-components=1 -C "${PWD}/_neovim"
+          }
+
+      - name: Run tests with NeoVim
+        run: |
+          export PATH="${PWD}/_neovim/bin:${PATH}"
+          export VIM="${PWD}/_neovim/share/nvim/runtime"
+          nvim --version
+          make test-nvim