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

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

The latest may be broken.

You can use the following which have been tested:

• 0a4cdc53bf38bb6cb2827ce4f5c236ba23b41495 (In testing, quick test working on May 24, 2020, for ycmd core version 43) zipped source tar.gz source
• 14e4255c52c9f64cabaa2af28354e9752d27ae65 (RECOMMENDED, tested working on Feb 11, 2018, for ycmd core version 39 (commit date circa Aug 21, 2018)) zipped source tar.gz source
• 1f1a50665877e6dd6f6d09999de3166f4b84a9a2 (works, recently tested but old; non-simd non-multicore. A Feb 11, 2017 build.) zipped source tar.gz source

You can use nano-ycmd fairly quickly with docker. More information can be found at https://github.com/orsonteodoro/docker-gentoo-nano-ycmd . It is still a work in progress. This image may be later be adapted for automated testing.

• ycmd, confirmed working for 20180210 (commit 1a83224202c4381d6d791c245a893ce25db7a974)
• >=jedi 0.10, for python support and for completer commands to work.
• Latest jedihttp, for python completion commands support.
• Either nettle, openssl, or "libgcrypt with glib" cryptographic library, to mitigate MITM attack between ycmd and nano text editor
• neon, for http interprocess communication between nano editor and ycmd server
• YCM-Generator (https://github.com/rdnetto/YCM-Generator), for C/C++/Objective-C/Objective-C++ support to generate a .ycm_extra_conf.py. It requires Python 2 and tested working on Python 2.7. To use YCM-Generator wit Python 3, YCM-Generator requires a patch.
• 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 NXJSON package needs to be applied https://github.com/orsonteodoro/oiledmachine-overlay/blob/master/dev-libs/nxjson/files/nxjson-9999.20141019-create-libs.patch so that it is a shared library)
• compdb (https://github.com/Sarcasm/compdb) and Ninja, for Ninja build system support
• jq (https://stedolan.github.io/jq/) (OPTIONAL) is json beautifier and filter. This is used to clean the DiagnosticResponse after parsing and inject an index on the node to allow for nano-ymcd to conveniently to find a FixIt based on an index selected by the user when the user hovers over this line/index with a shortcut key. Currently, the Display All FixIts is broken because of the non-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 system includes order for SIMD headers.
• AVX512, AVX2, SSE2, MMX (OPTIONAL and undergoing testing, AVX2/AVX512 support untested) for string_replace and escape_json.
• OpenMP (OPTIONAL and undergoing testing) via --with-openmp for multicore string_replace and escape_json.

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

See https://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 the menu shows.

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

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

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

Do Alt-` to bring up the completer commands menu

To execute a completer command do Ctrl-letter

To exit the completer commands do Ctrl-space

Some completer commands may not work for the particular language that you working with.

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

Just type and press CTRL-LETTER. Use Ctrl-space to exit the code completion selections.

python, javascript*, typescript, rust, go, C*, C++, Objective-C, Objective-C++, C#

Working with some of these languages require additional requirements:

• JavaScript support requires both .tern-project and .tern-config project file to work.

• C# support requires a .sln project file to work.

• C, C++, Objective-C, Objective-C++ requires either a *.pro, configure, CMakeList.txt, GNUmakefile, Makefile, or makefile to work. An optional *.ninja file may be supplied in your project and would require additional steps to handle.

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

Try deleting the compile_commands.json file and .ycm_extra_conf.py in the current (working) directory. Those files should be only in the directory mentioned 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 maybe project.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, I modified ycmd to use absolute paths. The vanilla ycmd uses relative path to the thirdparty folder.

--with-openssl

or

--with-nettle

or

--with-libgcrypt

--enable-ycmd

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

YCMD_PATH="/usr/lib64/python3.4/site-packages/ycmd" PYTHON_PATH="/usr/bin/python3.4"

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.sh

CFLAGS="-g" YCMG_PATH="/usr/bin/config_gen.py" YCMG_PYTHON_PATH="/usr/bin/python2" 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/lib64/python3.4/site-packages/ycmd" ./configure --enable-ycmd --with-openssl make

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

• YCMG_PYTHON_PATH, YCMD_PYTHON_PATH is used in commit 61b82be3e3b18b642ef75a1eee693f890127ba77. YCMG is refers to ycm-generator.

• PYTHON_PATH is used for earlier builds.

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

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

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

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 regenerate them.

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

We need the YCMG_PROJECT_PATH above plus the two required environment variables below:

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

For NINJA_BUILD_TARGETS, the contents of gst-transcoder's build.ninja is presented 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 $out
rule 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 and NINJA_BUILD_TARGETS for Ninja support.

In the above example, we have a Makefile and a configure. We override the YCM-Generator autodetection because the .ycm_extra_conf.py contains more headers with the Makefile preference over the autodetected configure with first come first 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.2 folder 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/mesonbuild folder.

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 is feature complete but the entire feature set of the completer commands is not feature 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 FixIts 100% of the time as expected.

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

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

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

For example: nano 2>/tmp/out.txt

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 clone https://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