nvim-lua/wishlist

Heuristically set buffer options

Open

#19 opened on Apr 24, 2021

View on GitHub
 (3 comments) (11 reactions) (0 assignees) (0 forks)github user discovery
help wantedidea

Repository metrics

Stars
 (249 stars)
PR merge metrics
 (PR metrics pending)

Description

What? This plugin automatically adjusts 'shiftwidth' and 'expandtab' heuristically based on the current file.

Why? When you work with several projects, it is not very convenient to manually set formatting parameters. It would be nice to be able to define these options automatically.

Potential existing implementations: This functionality is provided by default in VSCode. There is also a great plugin https://github.com/tpope/vim-sleuth, but it is written in Vimscript and can slow down the editor.

Potential pitfalls: It would be nice to implement this feature async.

Contributor guide

Research direction
Explore how to asynchronously detect file type and set buffer options like shiftwidth and expandtab. Check existing vim sleuth plugin for reference.
Tech stack
lua
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
LuaNeovim plugin development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70