docs: Effect-first README with install and API reference #1
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Tests | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| jobs: | |
| test: | |
| name: Parser tests | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install Neovim | |
| uses: rhysd/action-setup-vim@v1 | |
| with: | |
| neovim: true | |
| version: stable | |
| - name: Install plenary.nvim | |
| run: | | |
| git clone --depth 1 https://github.com/nvim-lua/plenary.nvim \ | |
| "$HOME/.local/share/nvim/site/pack/vendor/start/plenary.nvim" | |
| - name: Run tests | |
| run: | | |
| nvim --headless --noplugin \ | |
| -u tests/minimal_init.lua \ | |
| -c "PlenaryBustedDirectory tests/ {minimal_init='tests/minimal_init.lua',sequential=true}" | |
| stylua: | |
| name: StyLua formatting | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: JohnnyMorganz/stylua-action@v4 | |
| with: | |
| token: ${{ secrets.GITHUB_TOKEN }} | |
| version: latest | |
| args: --check lua/ tests/ |