Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Dax89/automaton.nvim
VSCode-Like Workspace Configuration Manager
https://github.com/Dax89/automaton.nvim
lua neovim neovim-plugin nvim nvim-lua nvim-plugin
Last synced: 3 months ago
JSON representation
VSCode-Like Workspace Configuration Manager
- Host: GitHub
- URL: https://github.com/Dax89/automaton.nvim
- Owner: Dax89
- License: mit
- Created: 2023-02-13T21:46:11.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T17:50:18.000Z (8 months ago)
- Last Synced: 2024-04-16T03:06:01.055Z (7 months ago)
- Topics: lua, neovim, neovim-plugin, nvim, nvim-lua, nvim-plugin
- Language: Lua
- Homepage:
- Size: 116 KB
- Stars: 33
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
_ _
/\ | | | |
/ \ _ _ | |_ ___ _ __ ___ __ _ | |_ ___ _ __
/ /\ \ | | | | | __| / _ \ | '_ ` _ \ / _` | | __| / _ \ | '_ \
/ ____ \ | |_| | | |_ | (_) | | | | | | | | (_| | | |_ | (_) | | | | |
/_/ \_\ \__,_| \__| \___/ |_| |_| |_| \__,_| \__| \___/ |_| |_|
```
Telescope and JSON5 powered VSCode-like Workspace configuration manager
[](https://asciinema.org/a/565957)
Automaton is a Workspace configuration manager inspired to VSCode tasks/launch configurations.
Configurations are stored in JSON5 format and they allows to execute tasks, run tests/profilers/linters and even debug your code (if DAP is configured)
## Table of Contents
- [Installation](#installation)
- [Configuration](#configuration)
- [Commands](#commands)
- [Workspace](#workspace)
- [Keybinds](#keybinds)
- [Contribuitng](#contributing)
- [License](#license)
- [Related Projects](#related-projects)
## Installation
#### Packer
```lua
use {
"Dax89/automaton.nvim",
requires = {
{"nvim-lua/plenary.nvim"},
{"nvim-telescope/telescope.nvim"},
{"mfussenegger/nvim-dap"}, -- Debug support for 'launch' configurations (Optional)
{"hrsh7th/nvim-cmp"}, -- Autocompletion for automaton workspace files (Optional)
{"L3MON4D3/LuaSnip"}, -- Snippet support for automaton workspace files (Optional)
}
}
```
#### Lazy
```lua
{
"Dax89/automaton.nvim",
dependencies = {
"nvim-lua/plenary.nvim",
"nvim-telescope/telescope.nvim",
"mfussenegger/nvim-dap", -- Debug support for 'launch' configurations (Optional)
"hrsh7th/nvim-cmp", -- Autocompletion for automaton workspace files (Optional)
"L3MON4D3/LuaSnip", -- Snippet support for automaton workspace files (Optional)
}
}
```
## Configuration
#### Default Config
```lua
require("automaton").setup({
debug = false,
saveall = true,
ignore_ft = { },
terminal = {
position = "botright",
size = 10,
},
integrations = {
luasnip = false,
cmp = false,
cmdcolor = require("automaton.utils").colors.yellow,
},
icons = {
buffer = "",
close = "",
launch = "",
task = "",
workspace = "",
},
events = {
workspacechanged = function(ws)
-- "ws" is the current workspace object (can be nil)
end
}
})
```
### Commands
```lua
:Automaton create -- Create a new workspace
recents -- Shows recent workspaces
init -- Initializes a workspace in "cwd"
load -- Loads a workspace in "cwd"
workspaces -- Manage loaded workspaces
jobs -- Shows running tasks/launch (can be killed too)
config -- Show/Edit workspace settings
tasks default -- Exec default task
tasks -- Select and exec task
launch default -- Exec default launch configuration
launch -- Select and exec a launch configuration
debug default -- Debug default launch configuration
debug -- Select and debug a launch configuration
open launch -- Open workspace's launch.json
open tasks -- Open workspace's tasks.json
open variables -- Open workspace's variables.json
open config -- Open workspace's config.json
```
## Workspace
Workspaces are configured with JSON5 files, the main ones are `tasks.json` and `launch.json`, the latter provides DAP integration too (if [nvim-dap](https://github.com/mfussenegger/nvim-dap) is installed).
If [nvim-cmp](https://github.com/hrsh7th/nvim-cmp) and [LuaSnip](https://github.com/L3MON4D3/LuaSnip) integrations are enabled it's possible to edit configurations with autocompletion and snippets.
Here is an example of `tasks.json` and `launch.json`:
```json5
// tasks.json
{
version: "1.0.0",
tasks: [
{
name: "Init NPM",
cwd: "${workspace_folder}",
type: "shell",
command: "npm init -y",
},
{
name: "Install dependencies",
cwd: "${workspace_folder}",
type: "shell",
command: "npm install .",
},
{
name: "Node Version",
type: "shell",
command: "node -v",
}
]
}
```
```json5
// launch.json
{
version: "1.0.0",
configurations: [
{
name: "Execute index",
cwd: "${workspace_folder}",
program: "node ${workspace_folder}/index.js",
default: true, // Set as default launch configuration
depends: ["Install dependencies"], // Always execute dependency installation
// DAP Configuration (optional)
type: "cppdpg", // Equals to 'dap.adapters.[key]' from your DAP config
// Extra fields are forwarded to dap.run() command
}
]
}
```
## Keybinds
Automaton doesn't provide any keybinds, this is an example of a possible one:
```lua
vim.keymap.set("n", "", "Automaton launch default")
vim.keymap.set("n", "", "Automaton debug default")
vim.keymap.set("n", "", "Automaton tasks default")
vim.keymap.set("n", "aC", "Automaton create")
vim.keymap.set("n", "aI", "Automaton init")
vim.keymap.set("n", "aL", "Automaton load")
vim.keymap.set("n", "ac", "Automaton config")
vim.keymap.set("n", "ar", "Automaton recents")
vim.keymap.set("n", "aw", "Automaton workspaces")
vim.keymap.set("n", "aj", "Automaton jobs")
vim.keymap.set("n", "al", "Automaton launch")
vim.keymap.set("n", "ad", "Automaton debug")
vim.keymap.set("n", "at", "Automaton tasks")
vim.keymap.set("n", "aol", "Automaton open launch")
vim.keymap.set("n", "aov", "Automaton open variables")
vim.keymap.set("n", "aot", "Automaton open tasks")
vim.keymap.set("n", "aoc", "Automaton open config")
-- Visual Mode
vim.keymap.set("v", "", "Automaton launch default")
vim.keymap.set("v", "", "Automaton debug default")
vim.keymap.set("v", "", "Automaton tasks default")
vim.keymap.set("v", "al", "Automaton launch")
vim.keymap.set("v", "ad", "Automaton debug")
vim.keymap.set("v", "at", "Automaton tasks")
```
## Contributing
Automaton's source code can be hacked easily, you can contribute in various ways:
- Fork this repository and send a [Pull Request](https://github.com/Dax89/automaton.nvim/pulls)
- Open an [Issue](https://github.com/Dax89/automaton.nvim/issues) with a feature request or a bug report
- Add more [Workspace Templates](https://github.com/Dax89/automaton.nvim/tree/master/lua/automaton/templates)
- Improve the [Wiki](https://github.com/Dax89/automaton.nvim/wiki)
## License
Automaton is licensed under the MIT License.
See the [LICENSE](LICENSE) file for details.
## Related Projects
- [projectmgr](https://github.com/charludo/projectmgr.nvim)
- [project.nvim](https://github.com/ahmedkhalf/project.nvim)
- [neovim-cmake](https://github.com/Shatur/neovim-cmake)