Updated Nvim setup in Linux (markdown)

Nvim-setup-in-Linux.md

@@ -1,39 +1,74 @@
-To set up a workable Neovim environment in Linux, I use the following script install necessary dependencies and Neovim itself:
+To set up a workable Neovim environment in Linux, I use the following script to install necessary dependencies and Neovim itself.
+
+The variable `PYTHON_INSTALLED`, `SYSTEM_PYTHON` and `ADD_TO_SYSTEM_PATH` should be set properly based on your situation.
 
 ```
 #!/bin/bash
+set -exu
+set -o pipefail
+
+# Whether to python has been installed
+PYTHON_INSTALLED=false
+
+# If Python has been installed, then we need to know whether Python is provided
+# by the system, or you have already installed Python under your HOME.
+SYSTEM_PYTHON=true
+
+# Whether to add the path of the installed executables to system PATH
+ADD_TO_SYSTEM_PATH=false
+
 #######################################################################
 #                    Anaconda or miniconda install                    #
 #######################################################################
 
+if [[ ! "$PYTHON_INSTALLED" = true ]]; then
+    echo "Installing Python in user HOME"
+
+    SYSTEM_PYTHON=false
+
+    # Whether to install Anaconda (INSTALL_ANACONDA=true) or Miniconda (INSTALL_ANACONDA=false)
     INSTALL_ANACONDA=false
-if [[ "$INSTALL_ANACONDA" == true ]]; then
+    if [[ "$INSTALL_ANACONDA" = true ]]; then
         CONDA_DIR=$HOME/tools/anaconda
-    CONDA_NAME=anaconda.sh
+        CONDA_NAME=Anaconda.sh
         CONDA_LINK="https://repo.anaconda.com/archive/Anaconda3-2019.07-Linux-x86_64.sh"
     else
         CONDA_DIR=$HOME/tools/miniconda
-    CONDA_NAME=miniconda.sh
+        CONDA_NAME=Miniconda.sh
         CONDA_LINK="https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh"
     fi
 
     echo "Downloading and installing conda"
 
-if [ ! -f "$HOME/packages/$CONDA_NAME" ]; then
+    if [[ ! -f "$HOME/packages/$CONDA_NAME" ]]; then
         curl -Lo "$HOME/packages/$CONDA_NAME" $CONDA_LINK
     fi
 
     # Install conda silently
-if [ -d $CONDA_DIR ]; then
+    if [[ -d $CONDA_DIR ]]; then
         rm -rf $CONDA_DIR
     fi
-
     bash $HOME/packages/$CONDA_NAME -b -p $CONDA_DIR
-export PATH="$CONDA_DIR/bin:$PATH"
+
+    # Setting up environment variables
+    if [[ "$ADD_TO_SYSTEM_PATH" = true ]]; then
+        echo "export PATH=$CONDA_DIR/bin:$PATH" >> $HOME/.bash_profile
+    fi
+fi
 
 # Install some Python packages
 echo "Install pynvim, pylint flake8, jedi"
+
+if [[ "$SYSTEM_PYTHON" = true ]]; then
+    echo "Using system Python"
+
+    # If we use system Python, we need to install these Python packages under user HOME,
+    # since we do not have permission to install them under system directories.
+    pip install --user pynvim pylint jedi flake8
+else
+    echo "Using custom Python"
     pip install pynvim pylint jedi flake8
+fi
 
 
 #######################################################################
@@ -43,21 +78,24 @@ pip install pynvim pylint jedi flake8
 echo "Install ripgrep"
 RIPGREP_DIR=$HOME/tools/ripgrep
 RIPGREP_SRC_NAME=$HOME/packages/ripgrep.tar.gz
-RIPGREP_LINK="https://github.com/BurntSushi/ripgrep/releases/download/11.0.0/ripgrep-11.0.0-x86_64-unknown-linux-musl.tar.gz"
+RIPGREP_LINK="https://github.com/BurntSushi/ripgrep/releases/download/11.0.2/ripgrep-11.0.2-x86_64-unknown-linux-musl.tar.gz"
 
+if [[ ! -f $RIPGREP_SRC_NAME ]]; then
     echo "Downloading ripgrep and renaming"
-if [ ! -f $RIPGREP_SRC_NAME ]; then
     wget $RIPGREP_LINK -O $RIPGREP_SRC_NAME
 fi
 
+if [[ ! -d "$RIPGREP_DIR" ]]; then
     echo "Creating ripgrep directory under tools directory"
-if [ ! -d "$RIPGREP_DIR" ]; then
     mkdir -p "$RIPGREP_DIR"
 fi
 
 echo "Extracting to $HOME/tools/ripgrep directory"
 tar zxvf $RIPGREP_SRC_NAME -C $RIPGREP_DIR --strip-components 1
 
+if [[ "$ADD_TO_SYSTEM_PATH" = true ]]; then
+    echo "export PATH=$RIPGREP_DIR:$PATH" >> $HOME/.bash_profile
+fi
 
 #######################################################################
 #                            Ctags install                            #
@@ -68,7 +106,7 @@ CTAGS_SRC_DIR=$HOME/packages/ctags
 CTAGS_DIR=$HOME/tools/ctags
 CTAGS_LINK="https://github.com/universal-ctags/ctags.git"
 
-if [ ! -d $CTAGS_SRC_DIR ]; then
+if [[ ! -d $CTAGS_SRC_DIR ]]; then
     mkdir -p $CTAGS_SRC_DIR
 fi
 
@@ -77,6 +115,9 @@ git clone $CTAGS_LINK .
 ./autogen.sh && ./configure --prefix=$CTAGS_DIR
 make -j$(nproc) && make install
 
+if [[ "$ADD_TO_SYSTEM_PATH" = true ]]; then
+    echo "export PATH=$CTAGS_DIR/bin:$PATH" >> $HOME/.bash_profile
+fi
 
 #######################################################################
 #                                Nvim install                         #
@@ -89,18 +130,30 @@ NVIM_SRC_NAME=$HOME/packages/nvim-linux64.tar.gz
 NVIM_CONFIG_DIR=$HOME/.config/nvim
 NVIM_LINK="https://github.com/neovim/neovim/releases/download/nightly/nvim-linux64.tar.gz"
 
-if [ ! -d "$NVIM_DIR" ]; then
+if [[ ! -d "$NVIM_DIR" ]]; then
     mkdir -p "$NVIM_DIR"
 fi
 
 echo "Downloading Neovim"
-if [ ! -f $NVIM_SRC_NAME ]; then
+if [[ ! -f $NVIM_SRC_NAME ]]; then
     wget $NVIM_LINK -O $NVIM_SRC_NAME
 fi
 
 echo "Extracting neovim"
 tar zxvf $NVIM_SRC_NAME --strip-components 1 -C $NVIM_DIR
 
+echo "Setting up config and installing plugins"
 git clone https://github.com/jdhao/nvim-config.git $NVIM_CONFIG_DIR \
     && $NVIM_DIR/bin/nvim +PlugInstall +qall
+
+if [[ "$ADD_TO_SYSTEM_PATH" = true ]]; then
+    echo "export PATH=$NVIM_DIR/bin:$PATH" >> $HOME/.bash_profile
+fi
+
+
+#######################################################################
+#                           Post processing                           #
+#######################################################################
+# Let PATH changes take effect
+source $HOME/.bash_profile
 ```