feat: setup porject

Author: AlejandroSuero

.editorconfig

@@ -18,3 +18,4 @@ indent_size = 4
 
 [*.{yaml,yml,json,jsonc}]
 indent_size = 2
+max_line_length = unset

.github/CODEOWNERS

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

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,5 +1,5 @@
 name: Bug Report
-description: Report a problem with your_plugin.nvim
+description: Report a problem with pretty-ts-errors.nvim
 title: "[Bug]: "
 labels:
   - bug
@@ -11,7 +11,7 @@ body:
         # Before reporting
 
         - Confirm that the problem is reproducible.
-        - Try using the [minimal reproduction template](https://github.com/your_github_user/your_plugin.nvim/blob/main/contrib/minimal.lua).
+        - Try using the [minimal reproduction template](https://github.com/AlejandroSuero/pretty-ts-errors.nvim/blob/main/contrib/minimal.lua).
 
   - type: checkboxes
     id: pre-requisites
@@ -35,8 +35,8 @@ body:
   - type: textarea
     id: nvim-version
     attributes:
-      label: NeoVim version
-      description: Paste here your NeoVim version, `nvim --version`.
+      label: Neovim version
+      description: Paste here your Neovim version, `nvim --version`.
       placeholder: |
         NVIM v0.10.0
         Build type: RelWithDebInfo
@@ -119,9 +119,9 @@ body:
 
         require("lazy").setup({
           {
-            "your_github_user/your_plugin.nvim",
+            "AlejandroSuero/pretty-ts-errors.nvim",
             config = function()
-              require("your_plugin").setup()
+              require("pretty-ts-errors").setup()
             end,
             lazy = false,
             enabled = true,

.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,42 @@
+name: docs
+
+on:
+  push:
+    paths:
+      - "README.md"
+  pull_request:
+    paths:
+      - "README.md"
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create doc directory if it doesn't exist
+        shell: bash
+        run: mkdir -p doc
+      - uses: actions/checkout@v4
+      - name: Generating docs with panvimdoc
+        uses: kdheepak/panvimdoc@main
+        with:
+          vimdoc: freeze-code.nvim
+          version: "Neovim >= 0.9.0"
+          demojify: true
+          treesitter: true
+      - name: Update documentation
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMMIT_MSG: |
+            docs: update `doc/pretty-ts-errors.txt`
+            skip-checks: true
+        run: |
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git config user.name "github-actions[bot]"
+          git remote set-url origin https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git
+          git add doc/
+          # Only commit and push if we have changes
+          git diff --quiet && git diff --staged --quiet || (git commit -m "${COMMIT_MSG}"; git push origin HEAD:${GITHUB_REF})

.github/workflows/lint.yml

@@ -33,3 +33,14 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           version: latest
           args: --check .
+
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install codespell
+        run: |
+          pip install codespell
+      - name: Run codespell
+        run: |
+          make spell

.github/workflows/release.yml

@@ -0,0 +1,19 @@
+name: "release"
+on:
+  push:
+    tags:
+      - "v*"
+jobs:
+  luarocks-upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: LuaRocks Upload
+        uses: nvim-neorocks/luarocks-tag-release@v7
+        env:
+          LUAROCKS_API_KEY: ${{ secrets.LUAROCKS_API_KEY }}
+        with:
+          summary: "Pretty TS Errors for NeoVim"
+          detailed_description: |
+            Makes your TypeScript errors pretty and readable.
+          template: "./rockspec.template"

.github/workflows/test.yml

@@ -31,4 +31,23 @@ jobs:
           export PATH="${PWD}/_neovim/bin:${PATH}"
           export VIM="${PWD}/_neovim/share/nvim/runtime"
           nvim --version
-          make test
+          nvim --headless --noplugin -u tests/minimal_init.lua -c "PlenaryBustedDirectory tests/pretty-ts-errors { minimal_init = './tests/minimal_init.lua'}"
+
+      - uses: actions/checkout@v4
+      - name: Install LuaJIT
+        uses: leafo/gh-actions-luajit@v10
+        with:
+          luaVersion: "luajit-2.1.0-beta3"
+      - name: Install luarocks
+        uses: leafo/gh-actions-luarocks@v4
+
+      - name: Install vusted
+        shell: bash
+        run: luarocks install vusted
+
+      - name: Run tests
+        shell: bash
+        run: |
+          export PATH="${PWD}/_neovim/bin:${PATH}"
+          export VIM="${PWD}/_neovim/share/nvim/runtime"
+          vusted --output=gtest tests/pretty-ts-errors

.luarc.json

@@ -2,5 +2,6 @@
   "$schema": "https://raw.githubusercontent.com/LuaLS/vscode-lua/master/setting/schema.json",
   "diagnostics": {
     "unusedLocalExclude": ["_*"]
-  }
+  },
+  "workspace.checkThirdParty": "false"
 }

.markdownlint.json

@@ -0,0 +1,18 @@
+{
+  "default": true,
+  "MD033": false,
+  "MD052": false,
+  "MD041": false,
+  "MD004": {
+    "style": "dash"
+  },
+  "MD046": {
+    "style": "fenced"
+  },
+  "MD030": {
+    "ul_single": 1,
+    "ol_single": 1,
+    "ul_multi": 1,
+    "ol_multi": 1
+  }
+}