[{"result":{"data":{"id":54349,"owner":"ckolkey","name":"ts-node-action","type":"github","source":"awesome-neovim","category":"editing-support","link":"https://github.com/ckolkey/ts-node-action","shortDescription":"Neovim Plugin for running functions on nodes.","createdAt":"2023-05-12T23:32:30.836Z","lastSyncedAt":"2023-05-12T23:32:38.787Z","stars":261,"readme":"# TS Node Action\n\nA framework for running functions on Tree-sitter nodes, and updating the buffer with the result.\n\n- [Installation](https://github.com/CKolkey/ts-node-action/blob/master/README.md#installation)\n- [Usage](https://github.com/CKolkey/ts-node-action/blob/master/README.md#usage)\n- [Configuration](https://github.com/CKolkey/ts-node-action/blob/master/README.md#configuration)\n - [Multiple Actions for a Node Type](https://github.com/CKolkey/ts-node-action/blob/master/README.md#multiple-actions-for-a-node-type)\n - [Writing Your Own Actions](https://github.com/CKolkey/ts-node-action#writing-your-own-node-actions)\n- [API](https://github.com/CKolkey/ts-node-action#writing-your-own-node-actions)\n - [Helpers](https://github.com/CKolkey/ts-node-action#helpers)\n - [Null-LS](https://github.com/CKolkey/ts-node-action#null-ls-integration)\n- [Builtin Actions](https://github.com/CKolkey/ts-node-action#builtin-actions)\n- [Testing](https://github.com/CKolkey/ts-node-action#testing)\n- [Contributing](https://github.com/CKolkey/ts-node-action#contributing)\n\n![cycle case](https://user-images.githubusercontent.com/7228095/210154055-8851210e-e8e1-4ba3-a474-0be373df8d1b.gif)\n\n![multiline](https://user-images.githubusercontent.com/7228095/210153839-5009dbed-db7a-4b1c-b5c9-879b90f32a64.gif)\n\n![condition formatting](https://user-images.githubusercontent.com/7228095/210153712-8be29018-00a3-427f-8a59-959e705e12c6.gif)\n\n![ternerizing](https://user-images.githubusercontent.com/7228095/210153716-2fde6101-352b-4ef9-ba00-0842e6749201.gif)\n\n![operator flipflop](https://user-images.githubusercontent.com/7228095/210153726-3f5da644-ae1f-4288-b52b-e12a9c757293.gif)\n\n![split join blocks](https://user-images.githubusercontent.com/7228095/210153731-a2c2a717-e7ae-4330-9664-11ba4ed3c005.gif)\n\n## Installation\n\n`Lazy.nvim`:\n```lua\n{\n 'ckolkey/ts-node-action',\n dependencies = { 'nvim-treesitter' },\n opts = {},\n},\n```\n\n`packer`:\n```lua\nuse({\n 'ckolkey/ts-node-action',\n requires = { 'nvim-treesitter' },\n config = function()\n require(\"ts-node-action\").setup({})\n end\n})\n```\n\n**Note**: It's not required to call `require(\"ts-node-action\").setup()` to initialize the plugin,\nbut a table can be passed into the setup function to specify new actions for nodes or additional langs.\n\n## Usage\n\nBind `require(\"ts-node-action\").node_action` to something. This is left up to the user.\n\nFor example, this would bind the function to `K`:\n```lua\nvim.keymap.set({ \"n\" }, \"K\", require(\"ts-node-action\").node_action, { desc = \"Trigger Node Action\" })\n```\n\nIf `tpope/vim-repeat` is installed, calling `node_action()` is dot-repeatable.\n\nIf `setup()` is called, user commands `:NodeAction` and `:NodeActionDebug` are defined.\n\nSee `available_actions()` below for how to set this up with LSP Code Actions.\n\n## Configuration\n\nThe `setup()` function accepts a table that conforms to the following schema:\n\n```lua\n{\n ['*'] = { -- Global table is checked for all langs\n [\"node_type\"] = fn,\n ...\n },\n lang = {\n [\"node_type\"] = fn,\n ...\n },\n ...\n}\n```\n\n- `lang` should be the treesitter parser lang, or `'*'` for the global table\n- `node_type` should be the value of `vim.treesitter.get_node_at_cursor()`\n\nA definition on the `lang` table will take precedence over the `*` (global) table.\n\n### Multiple Actions for a Node Type\n\nTo define multiple actions for a node type, structure your `node_type` value as a table of tables, like so:\n\n```lua\n[\"node_type\"] = {\n { function_one, name = \"Action One\" },\n { function_two, name = \"Action Two\" },\n}\n```\n\n`vim.ui.select` will use the value of `name` to when prompting you on which action to perform.\n\n## Writing your own Node Actions\n\nAll node actions should be a function that takes one argument: the tree-sitter node under the cursor.\n\nYou can read more about their API via `:help tsnode`\n\nThis function can return one or two values:\n\n- The first being the text to replace the node with. The replacement text can be either a `\"string\"` or\n`{ \"table\", \"of\", \"strings\" }`. With a table of strings, each string will be on it's own line.\n\n- The second (optional) returned value is a table of options. Supported keys are: `cursor`, `callback`, `format`, and\n `target`.\n\nHere's how that can look.\n\n```lua\n{\n cursor = { row = 0, col = 0 },\n callback = function() ... end,\n format = true,\n target = \n}\n```\n\n#### `cursor`\nIf the `cursor` key is present with an empty table value, the cursor will be moved to the start of the line where the\ncurrent node is (`row = 0` `col = 0` relative to node `start_row` and `start_col`).\n\n#### `callback`\nIf `callback` is present, it will simply get called without arguments after the buffer has been updated, and after the\ncursor has been positioned.\n\n#### `format`\nBoolean value. If `true`, will run `=` operator on new buffer text. Requires `indentexpr` to be set.\n\n#### `target`\nTSNode. If present, this node will be used as the target for replacement instead of the node under your cursor.\n\nHere's a simplified example of how a node-action function gets called:\n```lua\nlocal action = node_actions[lang][node:type()]\nlocal replacement, opts = action(node)\nreplace_node(node, replacement, opts or {})\n```\n\n## API\n\n`require(\"ts-node-action\").node_action()`\nMain function for plugin. Should be assigned by user, and when called will attempt to run the assigned function for the\nnode your cursor is currently on.\n

\n\n`require(\"ts-node-action\").debug()`\nPrints some helpful information about the current node, as well as the loaded node actions for all langs\n

\n\n`require(\"ts-node-action\").available_actions()`\nExposes the function assigned to the node your cursor is currently on, as well as its name\n

\n\n## null-ls Integration\n\nUsers can set up integration with [null-ls](https://github.com/jose-elias-alvarez/null-ls.nvim) and use it to display\navailable node actions by registering the builtin `ts_node_action` code action source\n\n```lua\nlocal null_ls = require(\"null-ls\")\nnull_ls.setup({\n sources = {\n null_ls.builtins.code_actions.ts_node_action,\n ...\n }\n})\n```\n\nThis will present the available node action(s) for the node under your cursor alongside your `lsp`/`null-ls` code actions.\n

\n\n## Helpers\n\n`require(\"ts-node-action.helpers\").node_text(node)`\n```\n@node: tsnode\n@return: string\n```\nReturns the text of the specified node.\n

\n\n`require(\"ts-node-action.helpers\").node_is_multiline(node)`\n```\n@node: tsnode\n@return: boolean\n```\nReturns true if node spans multiple lines, and false if it's a single line.\n

\n\n`require(\"ts-node-action.helpers\").padded_node_text(node, padding)`\n```\n@node: tsnode\n@padding: table\n@return: string\n```\nFor formatting unnamed tsnodes. For example, if you pass in an unnamed node representing the text `,`, you could pass in\na `padding` table (below) to add a trailing whitespace to `,` nodes.\n```lua\n{ [\",\"] = \"%s \" }\n```\n\nNodes not specified in table are returned unchanged.\n\n## Builtin Actions\n\n

Cycle Case

\n\n`require(\"ts-node-action.actions\").cycle_case(formats)`\n\n```\n@param formats table|nil\n```\n\n`formats` param can be a table of strings specifying the different formats to cycle through. By default it's `{\n \"snake_case\", \"pascal_case\", \"screaming_snake_case\", \"camel_case\" }`.\n\nA table can also be used in place of a string to implement a custom formatter. Every format is a table that implements the following interface:\n- pattern (string)\n- apply (function)\n- standardize (function)\n\n### pattern\nA Lua pattern (string) that matches the format\n\n### apply\nA function that takes a _table_ of standardized strings as it's argument, and returns a _string_ in the format\n\n### standardize\nA function that takes a _string_ in this format, and returns a table of strings, all lower case, no special chars.\nie:\n```\n standardize(\"ts_node_action\") -> { \"ts\", \"node\", \"action\" }\n standardize(\"tsNodeAction\") -> { \"ts\", \"node\", \"action\" }\n standardize(\"TsNodeAction\") -> { \"ts\", \"node\", \"action\" }\n standardize(\"TS_NODE_ACTION\") -> { \"ts\", \"node\", \"action\" }\n```\n\nNOTE: The order of formats can be important, as some identifiers are the same for multiple formats.\n Take the string 'action' for example. This is a match for both snake_case _and_ camel_case. It's\n therefore important to place a format between those two so we can correcly change the string.\n

\n\nBuiltin actions are all higher-order functions so they can easily have options overridden on a per-lang basis. Check out the implementations under `lua/filetypes/` to see how!\n\n| | (*) | Ruby | js/ts/tsx/jsx | Lua | Python | PHP | Rust | JSON | HTML | YAML | R |\n|---|---|---|---|---|---|---|---|---|---|---|---|\n| `toggle_boolean()` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | ✅ | ✅ |\n| `cycle_case()` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | | ✅ | ✅ |\n| `cycle_quotes()` | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | | | ✅ |\n| `toggle_multiline()` | | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | | | |\n| `toggle_operator()` | | ✅ | ✅ | ✅ | ✅ | ✅ | | | | | ✅ |\n| `toggle_int_readability()` | | ✅ | ✅ | | ✅ | ✅ | ✅ | ✅ | | | |\n| `toggle_block()` | | ✅ | | | | | | | | | |\n| if/else <-> ternery | | ✅ | | | ✅ | | | | | | |\n| if block/postfix | | ✅ | | | | | | | | | |\n| `toggle_hash_style()` | | ✅ | | | | | | | | | |\n| `conceal_string()` | | | ✅ | | | | | | ✅ | | |\n\n## Testing\nTo run the test suite, clone the repo and run `./run_spec`. It should pull all dependencies into `spec/support/` on\nfirst run, then execute the tests.\n\nThis is still a little WIP.\n\n## Contributing\n\nIf you come up with something that would be a good fit, pull requests for node actions are welcome!\n\nVisit: https://www.github.com/ckolkey/ts-node-action\n","configCount":1}}}]