my-awesome-plugin.nvim → base.nvim #9
Merged
Conversation
This file contains 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
Deleted the bug report and feature request issue templates from the .github/ISSUE_TEMPLATE directory.
- Deleted .luacheckrc, .neoconf.json, .stylua.toml, Makefile, scripts/docs.lua, scripts/minimal_init.vim, and tests/my_awesome_plugin/my_awesome_plugin_spec.lua. - These files are no longer needed for the project.
- Added `lua/base/config.lua` to handle configuration setup and defaults. - Added `lua/base/health.lua` to validate options and check plugin health. - Added `lua/base/init.lua` to initialize the plugin and provide user interaction functions. - Added `lua/base/types.lua` to define type annotations for the plugin. - Removed old plugin files from `lua/my_awesome_plugin/` directory.
- Deleted `doc/.gitkeep` and `doc/my_awesome_plugin.txt`. - Added `doc/base.txt` with detailed information about the base.nvim plugin, including sections on requirements, installation, configuration, commands, and functions.
…-action - Added `.busted` configuration file for Busted testing framework. - Created `.github/workflows/run-tests.yml` to run tests on push and pull request events using `nvim-neorocks/nvim-busted-action`. - Removed old `.github/workflows/test.yml` workflow. This change sets up a new CI pipeline for running tests with Neovim using the nvim-busted-action.
Added unit tests for the `base` module to verify its behavior with default and user-defined options. The tests check the `hello` and `bye` functions to ensure they return the expected greetings.
- Added a new `Base` user command in `plugin/base.lua` with subcommands `hello` and `bye`. - Removed the `PluginName` user command from `plugin/my_awesome_plugin.lua`.
- Add .luarc.json for Lua type checking configuration. - Remove obsolete docs.yml workflow for generating documentation. - Remove lint.yml workflow for Luacheck and Stylua linting. - Add run-typecheck.yml workflow for static type checking using lua-typecheck-action.
- Added `.github/workflows/release-github.yml` for automated GitHub releases using `googleapis/release-please-action`. - Added `.github/workflows/release-luarocks.yml` for automated LuaRocks releases using `nvim-neorocks/luarocks-tag-release`. - Removed the combined `.github/workflows/release.yml` workflow to split responsibilities into dedicated workflows.
- Added `base.nvim-scm-1.rockspec` file. - Defined rockspec format, version, user, package, description, test dependencies, source, and build type.
- Add `.gitignore` to exclude `.repro` directory. - Add `repro/repro.lua` to provide a minimal reproducible environment for users to report issues.
- Changed plugin name from "My Awesome Plugin" to "base.nvim" - Updated badges and links to reflect new repository name - Added new sections for setup, plugin structure, tests, documentation, and CI/CD - Improved instructions for renaming and setting up the plugin - Included Lua code snippets for lazy.nvim configuration - Added references to LuaRocks, busted, and nlua for testing - Updated acknowledgments and resources
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've decide to rewrite this template from scratch using exp points gained building:
The auto-doc gen part was removed and the whole template was simplify