{"id":20610563,"url":"https://github.com/kevinhwang91/nvim-ffhighlight","last_synced_at":"2025-04-15T04:32:22.144Z","repository":{"id":46170456,"uuid":"479245711","full_name":"kevinhwang91/nvim-fFHighlight","owner":"kevinhwang91","description":"Highlight f and F in Neovim","archived":false,"fork":false,"pushed_at":"2024-02-26T08:22:33.000Z","size":29,"stargazers_count":36,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-12T02:51:17.315Z","etag":null,"topics":["lua","neovim","nvim"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kevinhwang91.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-04-08T04:38:08.000Z","updated_at":"2025-02-18T21:33:13.000Z","dependencies_parsed_at":"2024-04-16T01:48:04.957Z","dependency_job_id":"0b68abe3-0cbb-4f43-9e39-10f00d5bf13b","html_url":"https://github.com/kevinhwang91/nvim-fFHighlight","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinhwang91%2Fnvim-fFHighlight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinhwang91%2Fnvim-fFHighlight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinhwang91%2Fnvim-fFHighlight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kevinhwang91%2Fnvim-fFHighlight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kevinhwang91","download_url":"https://codeload.github.com/kevinhwang91/nvim-fFHighlight/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249006577,"owners_count":21197301,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lua","neovim","nvim"],"created_at":"2024-11-16T10:17:13.785Z","updated_at":"2025-04-15T04:32:22.128Z","avatar_url":"https://github.com/kevinhwang91.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# nvim-fFHighlight\n\nHighlight the chars and words searched by `f` and `F`.\n\n\u003chttps://user-images.githubusercontent.com/17562139/162574749-b205e13f-8fe4-418f-a68f-56183cb421f7.mp4\u003e\n\n---\n\n## Table of contents\n\n* [Table of contents](#table-of-contents)\n* [Features](#features)\n* [Quickstart](#quickstart)\n  * [Requirements](#requirements)\n  * [Installation](#installation)\n  * [Minimal configuration](#minimal-configuration)\n  * [Usage](#usage)\n* [Documentation](#documentation)\n  * [Setup and description](#setup-and-description)\n  * [Highlight](#highlight)\n  * [API](#api)\n* [Customize configuration](#customize-configuration)\n* [Feedback](#feedback)\n* [License](#license)\n\n## Features\n\n- Highlight the chars searched by `f` and `F`\n- Highlight the words including the searched chars\n- Overlap the chars as numbers to jump faster\n\n## Quickstart\n\n### Requirements\n\n- [Neovim](https://github.com/neovim/neovim) 0.6.1\n\n### Installation\n\nInstall nvim-fFHighlight with [Packer.nvim](https://github.com/wbthomason/packer.nvim):\n\n```lua\nuse {'kevinhwang91/nvim-fFHighlight'}\n```\n\n### Minimal configuration\n\n```lua\nrequire('fFHighlight').setup()\n```\n\n### Usage\n\nAfter using [Minimal configuration](#Minimal-configuration):\n\nThe built-in `f` and `F` have been improved, enjoy!\n\n## Documentation\n\n### Setup and description\n\n```lua\n{\n    disable_keymap = {\n        description = [[Disable keymaps, users should map them manually]],\n        default = false\n    },\n    disable_words_hl = {\n        description = [[Disable the feature of highlighting words]],\n        default = false\n    },\n    number_hint_threshold = {\n        description = [[If the count of repeating latest `f` or `F` to the char is equal or greater\n                        than this value, use number to overlap char. minimal value is 2]],\n        default = 3\n    },\n    prompt_sign_define = {\n        description = [[The optional dict argument for sign_define(), `:h sign_define()` for\n                        more details. If this value is `{}`, will disable sign for prompt]],\n        default = {text = '-\u003e', text_hl = 'fFPromptSign', culhl = 'fFPromptSign'}\n    }\n}\n```\n\n### Highlight\n\n```vim\nhi default fFHintChar ctermfg=yellow cterm=bold guifg=yellow gui=bold\nhi default fFHintNumber ctermfg=yellow cterm=bold guifg=yellow gui=bold\nhi default fFHintWords cterm=underline gui=underline\nhi default link fFHintCurrentWord fFHintWords\nhi default fFPromptSign ctermfg=yellow cterm=bold guifg=yellow gui=bold\n```\n\n1. fFHintChar: highlight the hint of chars\n2. fFHintNumber: highlight the hint of number\n3. fFHintWords: highlight the hint of words\n4. fFHintCurrentWord: highlight the hint of current word\n5. fFPromptSign: highlight the prompt sign before searching a char\n\n### API\n\n```lua\n-- All API under this module\nlocal m = require('fFHighlight')\n\n--- Find the character to be typed on the current line\n---@param backward? boolean the direction of finding character. true is backward, otherwise is forward\nm.findChar(backward)\n```\n\n## Customize configuration\n\n```lua\nuse {\n    'kevinhwang91/nvim-fFHighlight',\n    config = function()\n        vim.cmd([[\n            hi fFHintChar ctermfg=yellow cterm=bold,undercurl guifg=yellow gui=bold,undercurl\n            hi fFHintWords cterm=undercurl gui=undercurl guisp=yellow\n            hi fFPromptSign ctermfg=yellow cterm=bold guifg=yellow gui=bold\n        ]])\n        require('fFHighlight').setup({\n            disable_keymap = false,\n            disable_words_hl = false,\n            number_hint_threshold = 3,\n            prompt_sign_define = {text = '✹'}\n        })\n    end,\n    keys = {{'n', 'f'}, {'x', 'f'}, {'n', 'F'}, {'x', 'F'}}\n}\n```\n\n## Feedback\n\n- If you get an issue or come up with an awesome idea, don't hesitate to open an issue in github.\n- If you think this plugin is useful or cool, consider rewarding it a star.\n\n## License\n\nThe project is licensed under a BSD-3-clause license. See [LICENSE](./LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinhwang91%2Fnvim-ffhighlight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkevinhwang91%2Fnvim-ffhighlight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkevinhwang91%2Fnvim-ffhighlight/lists"}