Mahlet-Inc / Mahlet-Inc/hobbits

Add a compilation option to use KTextEditor for a built-in KSY editor

Open
#125 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
751
Forks
49
PR merge metrics
No merged PRs in 30d

Description

https://api.kde.org/frameworks/ktexteditor/html/

It has syntax highlighting for yaml and blocks folding. One needs to [set mode (not highlight mode, but just mode)](https://github.com/KDE/kate/blob/f602a24eea43b4120136b2f25185632b09bbc4a5/addons/snippets/editsnippet.cpp#L72) into [`YAML`](https://github.com/KDE/ktexteditor/blob/7fa268f6b30dc1f011f8fc95a216ae06683ba0b9/src/data/katemoderc#L7)

For Windows probanly QScintilla can be used, but for KDE, I guess, it may make sense to use KTextEditor

Obstacles:

1. there is no `libqt5xml5-dev` package in Debian & Ubuntu. How have they built KF* packages without that? [Debian bug](https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=993340.)
2. It seems CMake doesn't properly discover KF packages. The workaround is to provide paths to their dirs, but it is extremily strange.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the referenced KTextEditor examples, especially editsnippet.cpp and katemoderc, then inspect the project's CMake configuration and existing KSY editor entry points. Done means an optional compilation path uses KTextEditor with YAML mode for the built-in editor and the KDE dependency-discovery obstacles are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp, python
Domain
build-system, desktop
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.