`lsp-file-watch-ignored': use proper regexes (#2208)

* `lsp-file-watch-ignored': use proper regexes

Emacs regexes specify the end of string using \', not $ as was used in that
variable (the latter matching *either* the end of the line or the string, which
could cause issues with files that have newlines in them (Linux allows this)).
Fix that by using \' for the end of string character instead.

Also properly handle node_modules. It is not necessarily always at the root of
the project, as is the case with .pyi files needed by pyright, which are in a
node_modules folder somewhere in the user's home directory. This causes
annoyances after Emacs-restarts, with `lsp' prompting the user to watch 11+k
immutable files. Fix that by removing the `eos' matcher and matching a slash
after "node_modules".

* Don't watch node_modules at project root

After the previous commit, node_modules would only be watched in the
middle of a path, due to the slash at the end, which is possibly not
sent by language servers. Now, don't require a trailing slash when
ignoring node_modules. Files like node_modules<foobar> would still not
get watched though, but that shouldn't cause issues.

Also, in `lsp' auto-loading, remove the `featurep' check around
`require', since that is done by the former anyway.

* Revert the unless (featurep) check

It is unrelated to this PR, so remove it. Whether to change that should
be left to further discussion.

Author: nbfalcon

lsp-mode.el

@@ -480,32 +480,32 @@ the server has requested that."
 ;;;###autoload(put 'lsp-enable-file-watchers 'safe-local-variable #'booleanp)
 
 (defcustom lsp-file-watch-ignored '(; SCM tools
-                                    "[/\\\\]\\.git$"
-                                    "[/\\\\]\\.hg$"
-                                    "[/\\\\]\\.bzr$"
-                                    "[/\\\\]_darcs$"
-                                    "[/\\\\]\\.svn$"
-                                    "[/\\\\]_FOSSIL_$"
+                                    "[/\\\\]\\.git\\'"
+                                    "[/\\\\]\\.hg\\'"
+                                    "[/\\\\]\\.bzr\\'"
+                                    "[/\\\\]_darcs\\'"
+                                    "[/\\\\]\\.svn\\'"
+                                    "[/\\\\]_FOSSIL_\\'"
                                     ;; IDE or build tools
-                                    "[/\\\\]\\.idea$"
-                                    "[/\\\\]\\.ensime_cache$"
-                                    "[/\\\\]\\.eunit$"
-                                    "[/\\\\]node_modules$"
-                                    "[/\\\\]\\.fslckout$"
-                                    "[/\\\\]\\.tox$"
-                                    "[/\\\\]dist$"
-                                    "[/\\\\]dist-newstyle$"
-                                    "[/\\\\]\\.stack-work$"
-                                    "[/\\\\]\\.bloop$"
-                                    "[/\\\\]\\.metals$"
-                                    "[/\\\\]target$"
-                                    "[/\\\\]\\.ccls-cache$"
-                                    "[/\\\\]\\.vscode$"
+                                    "[/\\\\]\\.idea\\'"
+                                    "[/\\\\]\\.ensime_cache\\'"
+                                    "[/\\\\]\\.eunit\\'"
+                                    "[/\\\\]node_modules"
+                                    "[/\\\\]\\.fslckout\\'"
+                                    "[/\\\\]\\.tox\\'"
+                                    "[/\\\\]dist\\'"
+                                    "[/\\\\]dist-newstyle\\'"
+                                    "[/\\\\]\\.stack-work\\'"
+                                    "[/\\\\]\\.bloop\\'"
+                                    "[/\\\\]\\.metals\\'"
+                                    "[/\\\\]target\\'"
+                                    "[/\\\\]\\.ccls-cache\\'"
+                                    "[/\\\\]\\.vscode\\'"
                                     ;; Autotools output
-                                    "[/\\\\]\\.deps$"
-                                    "[/\\\\]build-aux$"
-                                    "[/\\\\]autom4te.cache$"
-                                    "[/\\\\]\\.reference$")
+                                    "[/\\\\]\\.deps\\'"
+                                    "[/\\\\]build-aux\\'"
+                                    "[/\\\\]autom4te.cache\\'"
+                                    "[/\\\\]\\.reference\\'")
   "List of regexps matching directory paths which won't be monitored when creating file watches."
   :group 'lsp-mode
   :type '(repeat string)
@@ -7678,13 +7678,14 @@ When ARG is t the lsp mode will start new language server even if
 there is language server which can handle current language. When
 ARG is nil current file will be opened in multi folder language
 server if there is such. When `lsp' is called with prefix
-argument ask the user to select which language server to start. "
+argument ask the user to select which language server to start."
   (interactive "P")
 
   (when (and lsp-auto-configure (not lsp--client-packages-required))
     (seq-do (lambda (package)
               ;; loading client is slow and `lsp' can be called repeatedly
-              (unless (featurep package) (require package nil t)))
+              (unless (featurep package)
+                (require package nil t)))
             lsp-client-packages)
     (setq lsp--client-packages-required t))