ratnesh1729 / dotfiles

my emacs configuration

dotfiles for emacs

Extended and modified from this repo for my usage.

Content

Clone - Use recursive clone to get sky-color-clock (sample in screenshot below)

Sample screenshot in python mode: Once you wait on a function in the pop-up - help-info comes a few seconds later -

• Some important features
  • auto install emacs and rtags (for cpp completion), including all packages when emacs loads first time.
  • Extensive usage of use-package commands. This helps me changing machines easily.
  • Automatically finds indentation scheme for existing files in python and c++.
  • Comprehensive C++ environment
    • Flycheck with clang.
    • Code navigation with rtags (based on on-the-fly compilation).
    • Improved gdb experience.
    • F8 compile, F9 recompile.
  • Python linting, code navigation and correct code completion.
    • Relies on Elpy mode - M-. and M-* for jumping into and jumping back.
    • Auto formatting using autopep8 package - Works really well: formats and indents to this standard format.
  • Comprehensive latex environment - C-c C-a for building - builds all - latex, pdflatex and bibtex in one shot
    • For adding to bib tex files - please refer to development/latex/_init.el file.
    • Post compilation - automatically opens up pdf in partitioned emacs-window with highlighting the changes using arrow.
  • Super comprehensive IPython mode using Ein.
  • Spellcheck everywhere (code comments, text).
  • Check content of .emacs for more details..
  • which-key package shows key bindings when you press a key. A super-important package if you forget bindings.
  • I also use treemacs when working on libraries. If you want to use enanle it inside navigation/_init.el.
  • Dockerfile mode - helps in building docker directly from emacs
  • Semantic grouping using expand-region - helpful in navigating foreign codebases with different formatting.
  • If automatically removing whitespace is not ON (Ipython mode) - use F12.
  • Kill a buffer by pause/break key.

Install on Linux - tested on Ubuntu 16.04 and 18.04

Run ./install.sh

• Alternatively you can just use hyperlink ~/.emacs.d folder to the folder here.

For Mac Users

• On mac use brew to install cmake, rtags, cask.
• Then just hyper link ~/.emacs.d to this repo's emacs.d.
• You will still need to follow sections below for a few stuffs and notes.
• For better colors on Mac terminals use color prefix before opening command TERM=xterm-256color emacs

Bug

• Rarely an error saying flycheck-mode failed will appear when opening a C++ buffer.
• Very rarely emacs will hang when working in a C++ buffer (seems related to rtags).
• If you experience display glitches or issue with indentation, make sure to upgrade to emacs 26.
• IPython mode's EIN currently cannot have automatic whitespace removal. Use f12 to remove whitespace.

Usage Notes

• For some reason cmake-ide install fails. Just install using emacs.
• Follow install section above.
• Make sure cask and Jedi and irony-server are installed.
• I change themes frequently so I have a lot of themes pre-installed in display/_init.el

Rtags for C/C++ code completion

• For Cmake based project use cmake to compile with output of compile commands.json
• For C: to create compile_commands.json (Makefile project) use Bear. If you do not want to use bear then follow - https://eklitzke.org/using-emacs-and-rtags-with-autotools-c++-projects (section - configuring gcc wrapper).
• Checkout full keybindings in development/c/_init.el file.
• Post rtags installtion, rtags's daemon needs to be started - ./rdm & - you can add this to your cron-job or in emacs too. I prefer to do it in cron-job.
• For C++17 - we should use clang5.0 and above during rtags compilation. Rdm sometimes fail to parse the correct headers and we can include them as shown in Andersbakken/rtags#1095 (section - see reply Nov 20, 2017).
• Another helpful note for RTAGS: weblink.

Python and IPython

• For jupyter make sure right kernels are installed. (refer virutalenv with Ipython/Jupyter)
• Please refer to EIN here for more info - on various ein functions and key strokes.
• For elpy, you can check M-x elpy-status - this will show all configuration info including virtualenv you're in.

Sky color mode

• Cloning recursively automatically installs sky-color-clock. In order to get weather info you need to replace variable API-Key in the display/_init.el file. Also include proper latitude and city id in the same place
• Clock on the right hand corner on the screenshots is from sky-color.

Org Mode

• I started using org mode for tasks, and also starting on using it for writing source code and converting from org to latex and related.
• I hope to update the org mode conf file as I use it more.

Shell Mode

• Use windkows-key+enter-key for opening shell. On Mac use command-key+return-key for openning ansi-term.
• Once inside shell you can switch to line mode by C-c C-j which is helpful for copy/paste and buffer selection. You can come back to char mode by C-c C-k.

Latex

• May need to do sudo apt-get install texlive-fonts-recommended and sudo apt-get install texlive-fonts-extra for some fonts mainly used in computer vision conferences.
• Latex mode also displays pdf on side and for pdf viewing - uncomment (only for the first time using this configuration repo) - (pdf-tools-install) in editing/_init.el . Else it will keep bothering with installation every time you run emacs.
• Sample screenshot for latex mode -