From f5bb64cca8a63a10c470b4f9bff647702b6de74c Mon Sep 17 00:00:00 2001 From: Markus Heiser Date: Fri, 29 Mar 2024 08:57:02 +0100 Subject: [fix] .dir-locals.el -> .dir-locals-template.el The settungs in the .dir-locals.el do not work well for every emacs setup: Add .dir-locals.el to the git-ignore list and move content to a template file. Signed-off-by: Markus Heiser --- .dir-locals-template.el | 163 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 163 insertions(+) create mode 100644 .dir-locals-template.el (limited to '.dir-locals-template.el') diff --git a/.dir-locals-template.el b/.dir-locals-template.el new file mode 100644 index 000000000..1e319357a --- /dev/null +++ b/.dir-locals-template.el @@ -0,0 +1,163 @@ +;;; .dir-locals.el +;; +;; Per-Directory Local Variables: +;; https://www.gnu.org/software/emacs/manual/html_node/emacs/Directory-Variables.html +;; +;; For full fledge developer tools install emacs packages: +;; +;; M-x package-install ... +;; +;; magit gitconfig +;; nvm lsp-mode lsp-pyright lsp-eslint +;; pyvenv pylint pip-requirements +;; jinja2-mode +;; json-mode +;; company company-jedi company-quickhelp company-shell +;; realgud +;; sphinx-doc markdown-mode graphviz-dot-mode +;; apache-mode nginx-mode +;; +;; To setup a developer environment, build target:: +;; +;; $ make node.env.dev pyenv.install +;; +;; Some buffer locals are referencing the project environment: +;; +;; - prj-root --> / +;; - nvm-dir --> /.nvm +;; - python-environment-directory --> /local +;; - python-environment-default-root-name --> py3 +;; - python-shell-virtualenv-root --> /local/py3 +;; When this variable is set with the path of the virtualenv to use, +;; `process-environment' and `exec-path' get proper values in order to run +;; shells inside the specified virtualenv, example:: +;; (setq python-shell-virtualenv-root "/path/to/env/") +;; - python-shell-interpreter --> /local/py3/bin/python +;; +;; Python development: +;; +;; Jedi, flycheck & other python stuff should use the 'python-shell-interpreter' +;; from the local py3 environment. +;; + +((nil + . ((fill-column . 80) + (indent-tabs-mode . nil) + (eval . (progn + + (add-to-list 'auto-mode-alist '("\\.html\\'" . jinja2-mode)) + + ;; project root folder is where the `.dir-locals.el' is located + (setq-local prj-root + (locate-dominating-file default-directory ".dir-locals.el")) + + (setq-local python-environment-directory + (expand-file-name "./local" prj-root)) + + ;; to get in use of NVM environment, install https://github.com/rejeep/nvm.el + (setq-local nvm-dir (expand-file-name "./.nvm" prj-root)) + + ;; use nodejs from the (local) NVM environment (see nvm-dir) + (nvm-use-for-buffer) + (ignore-errors (require 'lsp)) + (setq-local lsp-server-install-dir (car (cdr nvm-current-version))) + (setq-local lsp-enable-file-watchers nil) + + ;; use 'py3' environment as default + (setq-local python-environment-default-root-name + "py3") + + (setq-local python-shell-virtualenv-root + (expand-file-name + python-environment-default-root-name python-environment-directory)) + + (setq-local python-shell-interpreter + (expand-file-name + "bin/python" python-shell-virtualenv-root)))))) + (makefile-gmake-mode + . ((indent-tabs-mode . t))) + + (yaml-mode + . ((eval . (progn + + ;; flycheck should use the local py3 environment + (setq-local flycheck-yaml-yamllint-executable + (expand-file-name "bin/yamllint" python-shell-virtualenv-root)) + + (setq-local flycheck-yamllintrc + (expand-file-name ".yamllint.yml" prj-root)) + + (flycheck-checker . yaml-yamllint))))) + + (json-mode + . ((eval . (progn + (setq-local js-indent-level 4) + (flycheck-checker . json-python-json))))) + + (js-mode + . ((eval . (progn + (ignore-errors (require 'lsp-eslint)) + (setq-local js-indent-level 2) + ;; flycheck should use the eslint checker from developer tools + (setq-local flycheck-javascript-eslint-executable + (expand-file-name "node_modules/.bin/eslint" prj-root)) + ;; (flycheck-mode) + + (if (featurep 'lsp-eslint) + (lsp)) + )))) + + (python-mode + . ((eval . (progn + (ignore-errors (require 'jedi-core)) + (ignore-errors (require 'lsp-pyright)) + (ignore-errors (sphinx-doc-mode)) + (setq-local python-environment-virtualenv + (list (expand-file-name "bin/virtualenv" python-shell-virtualenv-root) + ;;"--system-site-packages" + "--quiet")) + + (setq-local pylint-command + (expand-file-name "bin/pylint" python-shell-virtualenv-root)) + + (if (featurep 'lsp-pyright) + (lsp)) + + ;; pylint will find the '.pylintrc' file next to the CWD + ;; https://pylint.readthedocs.io/en/latest/user_guide/run.html#command-line-options + (setq-local flycheck-pylintrc + ".pylintrc") + + ;; flycheck & other python stuff should use the local py3 environment + (setq-local flycheck-python-pylint-executable + python-shell-interpreter) + + ;; use 'M-x jedi:show-setup-info' and 'M-x epc:controller' to inspect jedi server + ;; https://tkf.github.io/emacs-jedi/latest/#jedi:environment-root -- You + ;; can specify a full path instead of a name (relative path). In that case, + ;; python-environment-directory is ignored and Python virtual environment + ;; is created at the specified path. + (setq-local jedi:environment-root + python-shell-virtualenv-root) + + ;; https://tkf.github.io/emacs-jedi/latest/#jedi:server-command + (setq-local jedi:server-command + (list python-shell-interpreter + jedi:server-script)) + + ;; jedi:environment-virtualenv --> see above 'python-environment-virtualenv' + ;; is set buffer local! No need to setup jedi:environment-virtualenv: + ;; + ;; Virtualenv command to use. A list of string. If it is nil, + ;; python-environment-virtualenv is used instead. You must set non-nil + ;; value to jedi:environment-root in order to make this setting work. + ;; + ;; https://tkf.github.io/emacs-jedi/latest/#jedi:environment-virtualenv + ;; + ;; (setq-local jedi:environment-virtualenv + ;; (list (expand-file-name "bin/virtualenv" python-shell-virtualenv-root) + ;; "--python" + ;; "/usr/bin/python3.4" + ;; )) + )))) + ) -- cgit v1.2.3