tldr-pages/tldr

Plugins for editors/IDEs

Open

#7,878 opened on Mar 11, 2022

View on GitHub
 (13 comments) (3 reactions) (0 assignees)Shell (2,507 forks)batch import
help wantedtooling

Repository metrics

Stars
 (30,937 stars)
PR merge metrics
 (Avg merge 7d 5h) (321 merged PRs in 30d)

Description

List

  • Vim
    • comment: waiting somebody to integrate our linter to ALE
  • Emacs
    • author: @EmilySeville7cfg
    • comment: waiting other contributors to close help wanted issues
  • NeoVim
    • comment: waiting somebody to integrate our linter to NeoVim
  • Sublime Text
  • Visual Studio Code
    • author: @EmilySeville7cfg
    • comment: waiting other contributors to close help wanted issues
  • Intellij IDEA-compatible IDEs
  • Visual Studio

Minimal requirenments

Each plugin should at least highlight found errors via tldr-lint (or report them in another way, for instance just list them below the current TlDr page).

Advanced features

The following features are not necessary to be implemented:

  • snippets
  • code actions (to fix found errors or convert placeholders)

Contributor guide

Research direction
Investigate the existing tldr editor plugins (e.g., for Vim, Emacs, NeoVim) to understand their architecture. Then, for a chosen editor (e.g., Visual Studio Code), study how to create an extension that integrates tldr lint to provide linting feedback. Follow the official documentation for that editor's extension development and look for examples from similar linter extensions.
Tech stack
None
Domain
developer experience
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.
Half day
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45