Repository files navigation

The ycmd code completion support for nano is found in the ymcd-code-completionbranch.

• The master branch contains upstreams gnu nano source code untouched.
• The ymcd-code-completion contains a modification to gnu nano that has ycmdsupport.

The latest may be broken.

You can use the following which have been tested:

Recognized ycmd core versions:

• Support for a particular ycmd core version is based on version availability ofPython and Clang dependencies of the distro.
• The End of Life (EOL) column is interpreted from the last tested commitsnapshot of nano-ycmd.

You can use nano-ycmd fairly quickly with Docker. More information can be foundathttps://github.com/orsonteodoro/docker-gentoo-nano-ycmd

• ycmd, confirmed working for 20180210 (commit1a83224202c4381d6d791c245a893ce25db7a974)
• >=jedi 0.10, for Python support and for completer commands to work.
• Latest jedihttp, for Python completion commands support.
• One cryptographic library of either Nettle, OpenSSL, or libgcrypt, to mitigateagainst a man-in-the-middle (MITM) attack between ycmd and the nano text editor.
• neon, for http interprocess communication between nano editor and ycmd server
• YCM-Generator (https://github.com/rdnetto/YCM-Generator), forC/C++/Objective-C/Objective-C++ support to generate a .ycm_extra_conf.py. Itrequires YCM-Generator to be patched for Python 3 support.
• Bear (https://github.com/rizsotto/Bear), for C/C++/Objective-C/Objective-C++support to generate a compile_commands.json.
• Clang, for C/C++/Objective-C/Objective-C++ code completion.
• GNU Make, to clean up the project files
• Sed, for patching .ycm_extra_conf.py
• Bash >=4, for&| support
• Unix, Linux, Cygwin for /dev/null and /dev/random support
• NXJSON, for server response parsing (A Makefile patch applied to NXJSONpackage needs to be appliedhttps://github.com/orsonteodoro/oiledmachine-overlay/blob/master/dev-libs/nxjson/files/nxjson-9999.20141019-create-libs.patchso that it is a shared library)
• compdb (https://github.com/Sarcasm/compdb) and Ninja, for Ninja build systemsupport
• jq (https://stedolan.github.io/jq/) (OPTIONAL) is json beautifier and filter.This is used to clean the DiagnosticResponse after parsing and inject an indexon the node to allow for nano-ymcd to conveniently to find a FixIt based on anindex selected by the user when the user hovers over this line/index with ashortcut key. Currently, theDisplay All FixIts is broken because of thenon-deterministic bug.
• GNU findutils, requires for the find utility to search for Makefile,configure, *.ninja, *.pro, files.
• GNU coreutils, nano-ycmd needs tac command to reverse the clang systemincludes order for SIMD headers.
• AVX512, AVX2, SSE2, MMX (OPTIONAL and undergoing testing, AVX2/AVX512 supportuntested) for string_replace and escape_json.
• OpenMP (OPTIONAL and undergoing testing) via --with-openmp for multicorestring_replace and escape_json.

You can look at my gentoo package overlayhttps://github.com/orsonteodoro/oiledmachine-overlay to see how to properlycompile them or you can research them to build packages for your distribution.

The hotkeys Ctrl-` brings up the completer commands menu. The table below inthe which completer commands work section lists additional hotkeys that follow.

Seehttps://github.com/orsonteodoro/nano-ycmd/blob/ymcd-code-completion/src/global.c#L1389 .

Some of these features require the user to begin to type their code before thecompletere commands menu shows.

Your distribution has not packaged the xml files properly. Compile nano-ycmd indebug mode and inspect the logs (ynano.txt, jedihttp_.log, omnisharp_.log) inthe /tmp folder to see which xml documentation files are required.

Just type and press Ctrl-letter when suggestions show.

Do Ctrl-X to exit the code completion suggestions list.

Completer commands add beyond code completion. It is optional but powerfulfeatures for the developer.

The features below are still in development. Some may be feature complete.

Do Alt-` to bring up the completer commands menu.

Do Ctrl-letter to execute a completer command.

Do Ctrl-space to exit the completer commands.

Some completer commands may not work or not made available for the particularlanguage that you working with.

• (1) It triggers randomly (in a not deterministic way). It works for %d->%sformat specifier, missing semicolon, identifier spelling errors. It was testedonly with the C language.
• (2) It needs more test cases.
• (3) Subserver problems were encountered.
• (4) Interactive testing is performed.
• (5) The results currently shown are from an older evaluated version. Breakagemay be encountered for newer versions.

ycmd allows to you use IntelliSense for C# sources usingomnisharp-server/omnisharp-roslyn that the big IDE editors have. It goes beyondword completion providing documentation about method signatures and real timesyntax checking (currently not supported in nano-ycmd).

• JavaScript (1)
• C# (2)
• C (3)
• C++ (3)
• CUDA
• Go
• Python
• Objective-C (3)
• Objective-C++ (3)
• Rust
• TypeScript

Working with some of these languages require additional requirements:

• (1) JavaScript support requires both .tern-project and .tern-config projectfiles to work.
• (2) C# support requires a .sln project file to work.
• (3) C, C++, Objective-C, Objective-C++ requires either a *.pro, configure,CMakeList.txt, GNUmakefile, Makefile, or makefile to work. An optional *.ninjafile may be supplied in your project and would require additional steps tohandle. build.meson is supported through the YCM-Generator's develop branch.

You may forgot to have a Makefile, makefile GNUmakefile for make, *.pro forqmake, configure for autotools, CMakeLists.txt for cmake or forgot to set theYCMG_PROJECT_PATH to point to your top level project folder. nano-ycmd willpass it to bear and YCM-Generator to properly create a .ycm_extra_conf.py andcompile_commands.json. The compile_commands.json is for clang compliationdatabase system (http://clang.llvm.org/docs/JSONCompilationDatabase.html)..ycm_extra_conf.py contains headers and constants that are per project defined.

Try deleting the compile_commands.json file and .ycm_extra_conf.py in thecurrent (working) directory. Those files should be only in the directorymentioned in the YCMG_PROJECT_PATH environmental variable passed into nano-ycmd.

You didn't set up ycmd correctly. It needs to see a sln file or maybeproject.json file if json is supported in ycmd.

I don't have an update bot yet.

I don't see any plugin support in nano.

Your setup may vary depending on if your distro patched ycmd. In my case, Imodified ycmd to use absolute paths. The vanilla ycmd uses relative path to thethirdparty folder.

• --with-libgcrypt

• --with-nettle

• --with-openssl

• For license compatibility reasons, do not use older than OpenSSL 3.x.

--enable-ycmd

(IMPORTANT) The python version must be the same as the compiled ycmd scripts.

YCMD_PATH="/usr/lib/python3.10/site-packages/ycmd"PYTHON_PATH="/usr/bin/python3.10"

RACERD_PATH="/usr/bin/racerd" RUST_SRC_PATH="/usr/share/rust/src"

GODEF_PATH="/usr/bin/godef" GOCODE_PATH="/usr/bin/gocode"

YCMG_PATH="/usr/bin/config_gen.py"

./autogen.shCFLAGS="-g" \YCMG_PATH="/usr/bin/config_gen.py" \YCMG_PYTHON_PATH="/usr/bin/python3" \YCMD_PYTHON_PATH="/usr/bin/python3" \RACERD_PATH="/usr/bin/racerd" \RUST_SRC_PATH="/usr/share/rust/src" \GODEF_PATH="/usr/bin/godef" \GOCODE_PATH="/usr/bin/gocode" \YCMD_PATH="/usr/lib/python3.10/site-packages/ycmd" \./configure --enable-ycmd --with-opensslmake

The -g adds debugging information for developers for the gdb debugger but notneeded for regular users.

• YCMG_PYTHON_PATH, YCMD_PYTHON_PATH is used in commit61b82be3e3b18b642ef75a1eee693f890127ba77. YCMG is refers to ycm-generator.

• PYTHON_PATH is used for earlier builds.

The following environmental variables are defined by nano-ycmd are required forC family support (C/C++/ObjC/ObjC++):

• YCMG_PROJECT_PATH - This should point to the folder containing the top-levelMakefile, configure, CMakeList.txt. (REQUIRED)
• YCMG_FLAGS - This adds extra parameters to config_gen.py. I recommend usingmake over autotools specifically-b make because more include files areexposed instead of allowing YCM-Generator autodetect. This environment variableis optional but recommended be in use in certain situations.

So to use it in combination of nano-ycmd (ynano) without Ninja, it would looklike:

YCMG_FLAGS="-b make" \YCMG_PROJECT_PATH="/var/tmp/portage/app-editors/nano-ycmd-9999.20170201/work/nano-ycmd-7611e4eb827980da1057f6768d00bd322fa1c58f" \ynano ycmd.c

Also, if you add new libraries or files, you should delete both the.ycm_extra_conf.py and compile_commands.json so that nano-ycmd can regeneratethem.

Also, if you change languages between C, C++, Objective-C, Objective-C++ becauseyour project uses multiple languages, you should regenerate them when using thembecause it will produce new header include lists for that particular language.Currently no hotkey exist to delete and regenerate those files. nano-ycmdautomatically skips generation to save time if they already exist.

We need the YCMG_PROJECT_PATH above plus the two required environment variablesbelow:

• NINJA_BUILD_PATH - This should point to the folder containing your *.ninjafile (REQUIRED)
• NINJA_BUILD_TARGETS - This should be the rule(s) space seperated and listedunder the# Rules for compiling comment section and having the line begin withcommand = clang or whatever compiler you are using. (REQUIRED)

For NINJA_BUILD_TARGETS, the contents of gst-transcoder's build.ninja ispresented below:

# This is the build file for project "gst-renderer"# It is autogenerated by the Meson build system.# Do not edit by hand.ninja_required_version = 1.5.1# Rules for compiling.rule c_COMPILER command = clang  $ARGS '-MMD' '-MQ' $out '-MF' '$DEPFILE' -o $out -c $in deps = gcc depfile = $DEPFILE description = Compiling c object $outrule c_PCH command = clang  $ARGS '-MMD' '-MQ' $out '-MF' '$DEPFILE' -o $out -c $in deps = gcc depfile = $DEPFILE description = Precompiling header $in# Rules for linking.rule STATIC_LINKER command = ar $LINK_ARGS $out $in description = Static linking library $out

NINJA_BUILD_TARGETS can only be c_COMPILER and/or c_PCH but not STATIC_LINKER.Also it only works if your project is using both YCMG_PROJECT_PATH andNINJA_BUILD_TARGETS for Ninja support.

In the above example, we have a Makefile and a configure. We override theYCM-Generator autodetection because the .ycm_extra_conf.py contains more headerswith the Makefile preference over the autodetected configure with first comefirst serve priority.

For Ninja + Other build system, it should look like:

NINJA_BUILD_PATH="/var/tmp/portage/media-plugins/gst-transcoder-1.8.2-r1/work/gst-transcoder-1.8.2/mesonbuild" \NINJA_BUILD_TARGETS="c_COMPILER" \YCMG_PROJECT_PATH="/var/tmp/portage/media-plugins/gst-transcoder-1.8.2-r1/work/gst-transcoder-1.8.2" \ynano gst/transcode/gst-cpu-throttling-clock.c 2>out.txt

In the above example there is only a configure script in/var/tmp/portage/media-plugins/gst-transcoder-1.8.2-r1/work/gst-transcoder-1.8.2folder and is autodetected by YCM-Generator. A build.ninja file is located in/var/tmp/portage/media-plugins/gst-transcoder-1.8.2-r1/work/gst-transcoder-1.8.2/mesonbuildfolder.

We are working on that. Feel free to merge your changes.

The example reference script used it that way.

Code completion as in looking outside of the current opened buffers in nano isfeature complete but the entire feature set of the completer commands is notfeature complete. The UX could also be improved.

GPL version 3 or newer

It is GPL version 3 or newer

Add better user interface or user interaction. Emacs-ycmd is a good example.

Fix bugs or improve the speed. Solve why clang/llvm 3.9.1 doesn't show FixIts100% of the time as expected.

After the UX has been polished and all the features are feature complete. Ifthey do not want to include this patchset, we will fork nano. I want thismerged eventually if possible or someone do it if I am gone or no longer workingon it.

Yes you can, but you need to change the src/Makefile.am. Rerun autogen.sh. Doconfigure again specifying features then make. Just keep the binary only. Irecommend installing both since nano-ycmd is still a work in progress.

If you compiled nano-ycmd with --enable-debug then you can redirect the stderrto a file to inspect it later. You should use --disable-debug if you are not adeveloper.

For example:

nano 2>/tmp/out.txt

This is a security precaution against automatically running a maliciouscompromised script or against exfiltrating sensitive data to an unauthorizedthreat actor. Before accepting it, you should inspect the contents carefullyfrom top to bottom for suspicious code. Do not accept if it containsunauthorized domains, obfuscated text, attempts to touch sensitivedata, attempts to access the network, etc.

ycmd will run this file after it has been confirmed safe to use by you in orderfor ycmd to work on this kind of project or this type of programming language.

marchelzo and twkm from freenode ##C channel for the clear excess stdin fix.

Also see --version or

1. Click fork at the top of this page to create a repository on your account
2. git clonehttps://github.com/orsonteodoro/nano-ycmd.git
3. cd into folder
4. git checkout -b myfeaturename
5. make changes
6. git commit -m "My description here"
7. git push -u origin myfeaturename
8. go to your repository
9. make pull request