Merge pull request #23 from barrettruth/chore/update-project-configs

chore: update project configs

.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+insert_final_newline = true
+charset = utf-8
+
+[*.lua]
+indent_style = space
+indent_size = 2

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,46 +0,0 @@
----
-name: Bug Report
-about: File a bug with live-server.nvim
-title: "Bug Report"
-labels: ""
-assignees: ""
----
-
-<!-- Be sure you can affirm the following: -->
-<!-- 1. live-server is up to date and functioning correctly (run `live-server` in the terminal) -->
-<!-- 2. I have searched the issue tracker and not found a similar issue -->
-
-### Info
-
-- Operating System:
-- `nvim --version`:
-- Node package manager:
-- `<node-package-manager> --version`:
-- `live-server --version`:
-
-### Configuration
-
-<!-- Replace the below with your live-server.nvim setup -->
-
-```lua
-require('live-server').setup {
-
-}
-```
-
-<!-- Replace the below with your *neovim* package manager setup -->
-
-```lua
-require('nvim-package-manager').setup {
-    -- Any special plugin config
-    {
-        'barrett-ruth/live-server.nvim',
-    }
-}
-```
-
-</details>
-
-### Description
-
-<!-- A clear and concise description of the bug -->

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,77 @@
+name: Bug Report
+description: Report a bug
+title: "bug: "
+labels: [bug]
+body:
+  - type: checkboxes
+    attributes:
+      label: Prerequisites
+      options:
+        - label: I have searched [existing
+            issues](https://github.com/barrettruth/live-server.nvim/issues)
+          required: true
+        - label: I have updated to the latest version
+          required: true
+
+  - type: textarea
+    attributes:
+      label: "Neovim version"
+      description: "Output of `nvim --version`"
+      render: text
+    validations:
+      required: true
+
+  - type: input
+    attributes:
+      label: "Operating system"
+      placeholder: "e.g. Arch Linux, macOS 15, Ubuntu 24.04"
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Description
+      description: What happened? What did you expect?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Minimal steps to trigger the bug
+      value: |
+        1.
+        2.
+        3.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: "Health check"
+      description: "Output of `:checkhealth live-server`"
+      render: text
+
+  - type: textarea
+    attributes:
+      label: Minimal reproduction
+      description: |
+        Save the script below as `repro.lua`, edit if needed, and run:
+        ```
+        nvim -u repro.lua
+        ```
+        Confirm the bug reproduces with this config before submitting.
+      render: lua
+      value: |
+        vim.env.LAZY_STDPATH = '.repro'
+        load(vim.fn.system('curl -s https://raw.githubusercontent.com/folke/lazy.nvim/main/bootstrap.lua'))()
+        require('lazy.nvim').setup({
+          spec = {
+            {
+              'barrett-ruth/live-server.nvim',
+              opts = {},
+            },
+          },
+        })
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/config.yaml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Questions
+    url: https://github.com/barrettruth/live-server.nvim/discussions
+    about: Ask questions and discuss ideas

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,29 @@
+name: Feature Request
+description: Suggest a feature
+title: "feat: "
+labels: [enhancement]
+body:
+  - type: checkboxes
+    attributes:
+      label: Prerequisites
+      options:
+        - label: I have searched [existing
+            issues](https://github.com/barrettruth/live-server.nvim/issues)
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Problem
+      description: What problem does this solve?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Proposed solution
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternatives considered

.github/workflows/ci.yaml

@@ -0,0 +1,61 @@
+name: ci
+on:
+  workflow_call:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      lua: ${{ steps.changes.outputs.lua }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: changes
+        with:
+          filters: |
+            lua:
+              - 'lua/**'
+              - 'plugin/**'
+              - '*.lua'
+              - '.luarc.json'
+              - 'stylua.toml'
+              - 'selene.toml'
+
+  lua-format:
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.lua == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: 2.1.0
+          args: --check .
+
+  lua-lint:
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.lua == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: NTBBloodbath/selene-action@v1.0.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --display-style quiet .
+
+  lua-typecheck:
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.lua == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: mrcjkb/lua-typecheck-action@v0
+        with:
+          checklevel: Warning
+          directories: lua
+          configpath: .luarc.json

.github/workflows/luarocks.yaml

@@ -0,0 +1,21 @@
+name: luarocks
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  ci:
+    uses: ./.github/workflows/ci.yaml
+
+  publish:
+    needs: ci
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: nvim-neorocks/luarocks-tag-release@v7
+        env:
+          LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}

.github/workflows/quality.yaml

@@ -0,0 +1,89 @@
+name: quality
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  changes:
+    runs-on: ubuntu-latest
+    outputs:
+      lua: ${{ steps.changes.outputs.lua }}
+      markdown: ${{ steps.changes.outputs.markdown }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dorny/paths-filter@v3
+        id: changes
+        with:
+          filters: |
+            lua:
+              - 'lua/**'
+              - 'plugin/**'
+              - '*.lua'
+              - '.luarc.json'
+              - '*.toml'
+            markdown:
+              - '*.md'
+              - 'doc/**/*.md'
+
+  lua-format:
+    name: Lua Format Check
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.lua == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: JohnnyMorganz/stylua-action@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          version: 2.1.0
+          args: --check .
+
+  lua-lint:
+    name: Lua Lint Check
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.lua == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Lint with Selene
+        uses: NTBBloodbath/selene-action@v1.0.0
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          args: --display-style quiet .
+
+  lua-typecheck:
+    name: Lua Type Check
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.lua == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run Lua LS Type Check
+        uses: mrcjkb/lua-typecheck-action@v0
+        with:
+          checklevel: Warning
+          directories: lua
+          configpath: .luarc.json
+
+  markdown-format:
+    name: Markdown Format Check
+    runs-on: ubuntu-latest
+    needs: changes
+    if: ${{ needs.changes.outputs.markdown == 'true' }}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 8
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+      - name: Install prettier
+        run: pnpm add -g prettier@3.1.0
+      - name: Check markdown formatting with prettier
+        run: prettier --check .

.gitignore

@@ -1,3 +1,5 @@
 doc/tags
-vim.toml
-selene.toml
+.*cache*
+CLAUDE.md
+.claude/
+node_modules/

.luarc.json

@@ -0,0 +1,8 @@
+{
+  "runtime.version": "Lua 5.1",
+  "runtime.path": ["lua/?.lua", "lua/?/init.lua"],
+  "diagnostics.globals": ["vim"],
+  "workspace.library": ["$VIMRUNTIME/lua", "${3rd}/luv/library"],
+  "workspace.checkThirdParty": false,
+  "completion.callSnippet": "Replace"
+}

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+minimum_pre_commit_version: "3.5.0"
+
+repos:
+  - repo: https://github.com/JohnnyMorganz/StyLua
+    rev: v2.3.1
+    hooks:
+      - id: stylua-github
+        name: stylua (Lua formatter)
+        files: \.lua$
+        pass_filenames: true
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v4.0.0-alpha.8
+    hooks:
+      - id: prettier
+        name: prettier
+        files: \.(md|toml|ya?ml|sh)$

.stylua.toml

@@ -1,4 +0,0 @@
-quote_style = "AutoPreferSingle"
-call_parentheses = "None"
-indent_type = "Spaces"
-column_width = 80

live-server.nvim-scm-1.rockspec

@@ -0,0 +1,12 @@
+rockspec_format = '3.0'
+package = 'live-server.nvim'
+version = 'scm-1'
+
+source = { url = 'git://github.com/barrettruth/live-server.nvim' }
+build = { type = 'builtin' }
+
+test_dependencies = {
+  'lua >= 5.1',
+  'nlua',
+  'busted >= 2.1.1',
+}

lua/live-server.lua

@@ -25,7 +25,10 @@ local function init()
   local user_config = vim.g.live_server or {}
   config = vim.tbl_deep_extend('force', defaults, user_config)
 
-  if not vim.fn.executable('live-server') and not (is_windows() and vim.fn.executable('live-server.cmd')) then
+  if
+    not vim.fn.executable('live-server')
+    and not (is_windows() and vim.fn.executable('live-server.cmd'))
+  then
     log('live-server is not executable. Ensure the npm module is properly installed', 'ERROR')
     return false
   end
@@ -127,7 +130,13 @@ end
 
 ---@deprecated Use `vim.g.live_server` instead
 function M.setup(user_config)
-  vim.deprecate('require("live-server").setup()', 'vim.g.live_server', 'v0.1.0', 'live-server.nvim')
+  vim.deprecate(
+    'require("live-server").setup()',
+    'vim.g.live_server',
+    'v0.1.0',
+    'live-server.nvim',
+    false
+  )
 
   if user_config then
     vim.g.live_server = vim.tbl_deep_extend('force', vim.g.live_server or {}, user_config)

selene.toml

@@ -0,0 +1 @@
+std = 'vim'

stylua.toml

@@ -0,0 +1,8 @@
+column_width = 100
+line_endings = "Unix"
+indent_type = "Spaces"
+indent_width = 2
+quote_style = "AutoPreferSingle"
+call_parentheses = "Always"
+[sort_requires]
+enabled = true

vim.toml

@@ -0,0 +1,30 @@
+[selene]
+base = "lua51"
+name = "vim"
+
+[vim]
+any = true
+
+[jit]
+any = true
+
+[assert]
+any = true
+
+[describe]
+any = true
+
+[it]
+any = true
+
+[before_each]
+any = true
+
+[after_each]
+any = true
+
+[spy]
+any = true
+
+[stub]
+any = true