mirror of
https://github.com/doomemacs/doomemacs.git
synced 2025-12-06 02:30:33 -08:00
feat!(javascript): add treesit support
BREAKING CHANGE: This commit removes a number of core packages and features from this module and only replaces a handful of them, so that we can lean more on LSP and tree-sitter. To be specific: - We used to rely on `rjsx-mode` (derived from js2-mode) for total JS/JSX support (though imperfect; Emacs was starved for options at the time). This has now been replaced with `js-ts-mode` (built-in after Emacs 29), falling back to `js-mode` (very rudimentary, but a decent fallback). - This also meant the removal of `js2-mode`, which `skewer-mode`, `js2-refactor`, and `xref-js2` depended on, so those were removed too, and have *somewhat* been replaced with LSP integration (offers jump-to-definition/references and *some* refactoring actions, but no replacement for skewer's functionality). - Typescript support no longer relies on the jury-rigged, web-mode-derived major mode (because TSX support in the upstream `typescript-mode` isn't great). We now use `typescript-ts-mode` (built-in into Emacs 29.1+), falling back to `typescript-mode`. - JSX/TSX support now *requires* tree-sitter (and Emacs 29.1+), where `tsx-ts-mode` is available and outshines all the alternatives (at the time of writing). Due to the absolute chaos that is webdev, this module sacrifices some of the graceful-degradation I've implemented for other modules and creates a hard requirement on tree-sitter and Emacs 29.1+ for JSX/TSX. It still tries to degrade gracefully for plain JS and TS, but the module's doctor and docs will actively recommend tree-sitter. Close: #5278 Fix: #6172 Fix: #7042 Close: #8447 Co-authored-by: ribaricplusplus <ribaricplusplus@users.noreply.github.com>
This commit is contained in:
Henrik Lissner
parent
d20c5f1273
commit
bd0bee92cc
5 changed files with 96 additions and 395 deletions
|
|
@ -8,305 +8,101 @@
|
|||
;;
|
||||
;;; Major modes
|
||||
|
||||
(dolist (feature '(rjsx-mode
|
||||
typescript-mode
|
||||
web-mode
|
||||
(nodejs-repl-mode . nodejs-repl)))
|
||||
(let ((pkg (or (cdr-safe feature) feature))
|
||||
(mode (or (car-safe feature) feature)))
|
||||
(with-eval-after-load pkg
|
||||
(set-docsets! mode "JavaScript"
|
||||
"AngularJS" "Backbone" "BackboneJS" "Bootstrap" "D3JS" "EmberJS" "Express"
|
||||
"ExtJS" "JQuery" "JQuery_Mobile" "JQuery_UI" "KnockoutJS" "Lo-Dash"
|
||||
"MarionetteJS" "MomentJS" "NodeJS" "PrototypeJS" "React" "RequireJS"
|
||||
"SailsJS" "UnderscoreJS" "VueJS" "ZeptoJS")
|
||||
(set-ligatures! mode
|
||||
;; Functional
|
||||
:def "function"
|
||||
:lambda "() =>"
|
||||
:composition "compose"
|
||||
;; Types
|
||||
:null "null"
|
||||
:true "true" :false "false"
|
||||
;; Flow
|
||||
:not "!"
|
||||
:and "&&" :or "||"
|
||||
:for "for"
|
||||
:return "return"
|
||||
;; Other
|
||||
:yield "import"))))
|
||||
(defun +javascript-common-config (mode)
|
||||
(unless (eq mode 'nodejs-repl-mode)
|
||||
(set-repl-handler! mode #'+javascript/open-repl)
|
||||
(set-electric! mode :chars '(?\} ?\) ?. ?:))
|
||||
(set-ligatures! mode
|
||||
;; Functional
|
||||
:def "function"
|
||||
:lambda "() =>"
|
||||
:composition "compose"
|
||||
;; Types
|
||||
:null "null"
|
||||
:true "true" :false "false"
|
||||
;; Flow
|
||||
:not "!"
|
||||
:and "&&" :or "||"
|
||||
:for "for"
|
||||
:return "return"
|
||||
;; Other
|
||||
:yield "import")
|
||||
|
||||
(when (modulep! +lsp)
|
||||
(add-hook (intern (format "%s-local-vars-hook" mode)) #'lsp! 'append)))
|
||||
|
||||
(pcase mode
|
||||
((or 'js-mode 'js-ts-mode 'nodejs-repl-mode)
|
||||
(set-docsets! mode "JavaScript"
|
||||
"AngularJS" "Backbone" "BackboneJS" "Bootstrap" "D3JS" "EmberJS" "Express"
|
||||
"ExtJS" "JQuery" "JQuery_Mobile" "JQuery_UI" "KnockoutJS" "Lo-Dash"
|
||||
"MarionetteJS" "MomentJS" "NodeJS" "PrototypeJS" "React" "RequireJS"
|
||||
"SailsJS" "UnderscoreJS" "VueJS" "ZeptoJS"))
|
||||
((or 'typescript-mode 'typescript-ts-mode)
|
||||
(set-docsets! mode :add "TypeScript" "AngularTS")
|
||||
(set-electric! mode :chars '(?\} ?\)) :words '("||" "&&")))))
|
||||
|
||||
|
||||
(use-package! rjsx-mode
|
||||
(use-package! js-mode
|
||||
:mode "\\.[mc]?js\\'"
|
||||
:mode "\\.es6\\'"
|
||||
:mode "\\.pac\\'"
|
||||
:interpreter "node"
|
||||
:hook (rjsx-mode . rainbow-delimiters-mode)
|
||||
:init
|
||||
;; Parse node stack traces in the compilation buffer
|
||||
(after! compilation
|
||||
(add-to-list 'compilation-error-regexp-alist 'node)
|
||||
(add-to-list 'compilation-error-regexp-alist-alist
|
||||
'(node "^[[:blank:]]*at \\(.*(\\|\\)\\(.+?\\):\\([[:digit:]]+\\):\\([[:digit:]]+\\)"
|
||||
2 3 4)))
|
||||
:config
|
||||
(set-repl-handler! 'rjsx-mode #'+javascript/open-repl)
|
||||
(set-electric! 'rjsx-mode :chars '(?\} ?\) ?. ?:))
|
||||
(setq js-chain-indent t)
|
||||
(+javascript-common-config 'js-mode))
|
||||
|
||||
(setq js-chain-indent t
|
||||
;; These have become standard in the JS community
|
||||
js2-basic-offset 2
|
||||
;; Don't mishighlight shebang lines
|
||||
js2-skip-preprocessor-directives t
|
||||
;; let flycheck handle this
|
||||
js2-mode-show-parse-errors nil
|
||||
js2-mode-show-strict-warnings nil
|
||||
;; Flycheck provides these features, so disable them: conflicting with
|
||||
;; the eslint settings.
|
||||
js2-strict-missing-semi-warning nil
|
||||
;; maximum fontification
|
||||
js2-highlight-level 3
|
||||
js2-idle-timer-delay 0.15)
|
||||
|
||||
(setq-hook! 'rjsx-mode-hook
|
||||
;; Indent switch-case another step
|
||||
js-switch-indent-offset js2-basic-offset)
|
||||
|
||||
(use-package! xref-js2
|
||||
:when (modulep! :tools lookup)
|
||||
:init
|
||||
(setq xref-js2-search-program 'rg)
|
||||
(set-lookup-handlers! 'rjsx-mode
|
||||
:xref-backend #'xref-js2-xref-backend))
|
||||
|
||||
;; HACK `rjsx-electric-gt' relies on js2's parser to tell it when the cursor
|
||||
;; is in a self-closing tag, so that it can insert a matching ending tag
|
||||
;; at point. The parser doesn't run immediately however, so a fast typist
|
||||
;; can outrun it, causing tags to stay unclosed, so force it to parse:
|
||||
(defadvice! +javascript-reparse-a (n)
|
||||
;; if n != 1, rjsx-electric-gt calls rjsx-maybe-reparse itself
|
||||
:before #'rjsx-electric-gt
|
||||
(if (= n 1) (rjsx-maybe-reparse))))
|
||||
(use-package! js-ts-mode
|
||||
:when (modulep! +tree-sitter)
|
||||
:when (fboundp 'js-ts-mode) ; 29.1+ only
|
||||
:defer t
|
||||
:init
|
||||
(set-tree-sitter! 'js-mode 'js-ts-mode 'javascript)
|
||||
(+javascript-common-config 'js-ts-mode))
|
||||
|
||||
|
||||
(use-package! typescript-mode
|
||||
:hook (typescript-mode . rainbow-delimiters-mode)
|
||||
:hook (typescript-tsx-mode . rainbow-delimiters-mode)
|
||||
:init
|
||||
(when (modulep! :lang web)
|
||||
(autoload 'typescript-tsx-mode "typescript-mode" nil t))
|
||||
|
||||
;; REVIEW We associate TSX files with `typescript-tsx-mode' derived from
|
||||
;; `web-mode' because `typescript-mode' does not officially support
|
||||
;; JSX/TSX. See emacs-typescript/typescript.el#4
|
||||
(add-to-list 'auto-mode-alist
|
||||
(cons "\\.tsx\\'"
|
||||
(if (modulep! :lang web)
|
||||
#'typescript-tsx-mode
|
||||
#'typescript-mode)))
|
||||
|
||||
(when (modulep! :checkers syntax -flymake)
|
||||
(after! flycheck
|
||||
(flycheck-add-mode 'javascript-eslint 'web-mode)
|
||||
(flycheck-add-mode 'javascript-eslint 'typescript-mode)
|
||||
(flycheck-add-mode 'javascript-eslint 'typescript-tsx-mode)
|
||||
(flycheck-add-mode 'typescript-tslint 'typescript-tsx-mode)
|
||||
(unless (modulep! +lsp)
|
||||
(after! tide
|
||||
(flycheck-add-next-checker 'typescript-tide '(warning . javascript-eslint) 'append)
|
||||
(flycheck-add-mode 'typescript-tide 'typescript-tsx-mode)))
|
||||
(add-hook! 'typescript-tsx-mode-hook
|
||||
(defun +javascript-disable-tide-checkers-h ()
|
||||
(pushnew! flycheck-disabled-checkers
|
||||
'javascript-jshint
|
||||
'tsx-tide
|
||||
'jsx-tide)))))
|
||||
:unless (modulep! +tree-sitter)
|
||||
:mode "\\.ts\\'"
|
||||
:config
|
||||
(when (fboundp 'web-mode)
|
||||
(define-derived-mode typescript-tsx-mode web-mode "TypeScript-TSX")
|
||||
(when (modulep! +lsp)
|
||||
(after! lsp-mode
|
||||
(add-to-list 'lsp--formatting-indent-alist '(typescript-tsx-mode . typescript-indent-level))))
|
||||
(when (modulep! +tree-sitter)
|
||||
(after! evil-textobj-tree-sitter
|
||||
(pushnew! evil-textobj-tree-sitter-major-mode-language-alist '(typescript-tsx-mode . "tsx")))
|
||||
(after! tree-sitter
|
||||
(pushnew! tree-sitter-major-mode-language-alist '(typescript-tsx-mode . tsx)))
|
||||
;; HACK: the tsx grammer doesn't work with the hightlighting provided by
|
||||
;; font-lock-keywords. See emacs-tree-sitter/tree-sitter-langs#23
|
||||
(setq-hook! 'typescript-tsx-mode-hook
|
||||
tree-sitter-hl-use-font-lock-keywords nil)))
|
||||
(+javascript-common-config 'typescript-mode))
|
||||
|
||||
(set-docsets! '(typescript-mode typescript-tsx-mode)
|
||||
:add "TypeScript" "AngularTS")
|
||||
(set-electric! '(typescript-mode typescript-tsx-mode)
|
||||
:chars '(?\} ?\))
|
||||
:words '("||" "&&"))
|
||||
;; HACK Fixes comment continuation on newline
|
||||
(autoload 'js2-line-break "js2-mode" nil t)
|
||||
(setq-hook! 'typescript-mode-hook
|
||||
comment-line-break-function #'js2-line-break
|
||||
|
||||
;; Most projects use either eslint, prettier, .editorconfig, or tsf in order
|
||||
;; to specify indent level and formatting. In the event that no
|
||||
;; project-level config is specified (very rarely these days), the community
|
||||
;; default is 2, not 4. However, respect what is in tsfmt.json if it is
|
||||
;; present in the project
|
||||
typescript-indent-level
|
||||
(or (and (bound-and-true-p tide-mode)
|
||||
(plist-get (tide-tsfmt-options) :indentSize))
|
||||
typescript-indent-level)
|
||||
(use-package! typescript-ts-mode
|
||||
:when (modulep! +tree-sitter)
|
||||
:when (fboundp 'typescript-ts-mode) ; 29.1+ only
|
||||
:mode "\\.ts\\'"
|
||||
:init
|
||||
(set-tree-sitter! 'typescript-mode 'typescript-ts-mode 'typescript)
|
||||
:config
|
||||
(+javascript-common-config 'typescript-ts-mode))
|
||||
|
||||
;; Fix #5556: expand .x to className="x" instead of class="x", if
|
||||
;; `emmet-mode' is used.
|
||||
emmet-expand-jsx-className? t))
|
||||
|
||||
(use-package! tsx-ts-mode
|
||||
:when (modulep! +tree-sitter)
|
||||
:when (fboundp 'tsx-ts-mode) ; 29.1+ only
|
||||
:mode "\\.[tj]sx\\'"
|
||||
:defer t
|
||||
:config
|
||||
(+javascript-common-config 'tsx-ts-mode))
|
||||
|
||||
|
||||
;;
|
||||
;;; Tools
|
||||
;;; Extensions
|
||||
|
||||
(when (modulep! +tree-sitter)
|
||||
(add-hook! '(js2-mode-local-vars-hook
|
||||
typescript-mode-local-vars-hook
|
||||
typescript-tsx-mode-local-vars-hook
|
||||
rjsx-mode-local-vars-hook)
|
||||
:append #'tree-sitter!))
|
||||
|
||||
(add-hook! '(typescript-mode-local-vars-hook
|
||||
typescript-tsx-mode-local-vars-hook
|
||||
web-mode-local-vars-hook
|
||||
rjsx-mode-local-vars-hook)
|
||||
(defun +javascript-init-lsp-or-tide-maybe-h ()
|
||||
"Start `lsp' or `tide' in the current buffer.
|
||||
|
||||
LSP will be used if the +lsp flag is enabled for :lang javascript AND if the
|
||||
current buffer represents a file in a project.
|
||||
|
||||
If LSP fails to start (e.g. no available server or project), then we fall back
|
||||
to tide."
|
||||
(let ((buffer-file-name (buffer-file-name (buffer-base-buffer))))
|
||||
(when (derived-mode-p 'js-mode 'typescript-mode 'typescript-tsx-mode)
|
||||
(if (null buffer-file-name)
|
||||
;; necessary because `tide-setup' and `lsp' will error if not a
|
||||
;; file-visiting buffer
|
||||
(add-hook 'after-save-hook #'+javascript-init-lsp-or-tide-maybe-h
|
||||
nil 'local)
|
||||
(or (if (modulep! +lsp) (lsp!))
|
||||
;; fall back to tide
|
||||
(if (executable-find "node")
|
||||
(and (require 'tide nil t)
|
||||
(progn (tide-setup) tide-mode))
|
||||
(ignore
|
||||
(doom-log "Couldn't start tide because 'node' is missing"))))
|
||||
(remove-hook 'after-save-hook #'+javascript-init-lsp-or-tide-maybe-h
|
||||
'local))))))
|
||||
;; Parse node stack traces in the compilation buffer
|
||||
(after! compilation
|
||||
(add-to-list 'compilation-error-regexp-alist 'node)
|
||||
(add-to-list 'compilation-error-regexp-alist-alist
|
||||
'(node "^[[:blank:]]*at \\(.*(\\|\\)\\(.+?\\):\\([[:digit:]]+\\):\\([[:digit:]]+\\)"
|
||||
2 3 4)))
|
||||
|
||||
|
||||
(use-package! tide
|
||||
:hook (tide-mode . tide-hl-identifier-mode)
|
||||
:config
|
||||
(set-company-backend! 'tide-mode 'company-tide)
|
||||
;; navigation
|
||||
(set-lookup-handlers! 'tide-mode :async t
|
||||
:xref-backend #'xref-tide-xref-backend
|
||||
:documentation #'tide-documentation-at-point)
|
||||
(set-popup-rule! "^\\*tide-documentation" :quit t)
|
||||
|
||||
(setq tide-completion-detailed t
|
||||
tide-always-show-documentation t
|
||||
;; Fix #1792: by default, tide ignores payloads larger than 100kb. This
|
||||
;; is too small for larger projects that produce long completion lists,
|
||||
;; so we up it to 512kb.
|
||||
tide-server-max-response-length 524288
|
||||
;; We'll handle it
|
||||
tide-completion-setup-company-backend nil)
|
||||
|
||||
;; Resolve to `doom-project-root' if `tide-project-root' fails
|
||||
(advice-add #'tide-project-root :override #'+javascript-tide-project-root-a)
|
||||
|
||||
;; Cleanup tsserver when no tide buffers are left
|
||||
(add-hook! 'tide-mode-hook
|
||||
(add-hook 'kill-buffer-hook #'+javascript-cleanup-tide-processes-h
|
||||
nil 'local))
|
||||
|
||||
;; Eldoc is activated too soon and disables itself, thinking there is no eldoc
|
||||
;; support in the current buffer, so we must re-enable it later once eldoc
|
||||
;; support exists. It is set *after* tide-mode is enabled, so enabling it on
|
||||
;; `tide-mode-hook' is too early, so...
|
||||
(advice-add #'tide-setup :after #'eldoc-mode)
|
||||
|
||||
(map! :localleader
|
||||
:map tide-mode-map
|
||||
"R" #'tide-restart-server
|
||||
"f" #'tide-format
|
||||
"rrs" #'tide-rename-symbol
|
||||
"roi" #'tide-organize-imports))
|
||||
|
||||
|
||||
(use-package! js2-refactor
|
||||
:hook ((js2-mode rjsx-mode) . js2-refactor-mode)
|
||||
(use-package! nodejs-repl
|
||||
:defer t
|
||||
:init
|
||||
(map! :after js2-mode
|
||||
:map js2-mode-map
|
||||
:localleader
|
||||
(:prefix ("r" . "refactor")
|
||||
(:prefix ("a" . "add/arguments"))
|
||||
(:prefix ("b" . "barf"))
|
||||
(:prefix ("c" . "contract"))
|
||||
(:prefix ("d" . "debug"))
|
||||
(:prefix ("e" . "expand/extract"))
|
||||
(:prefix ("i" . "inject/inline/introduce"))
|
||||
(:prefix ("l" . "localize/log"))
|
||||
(:prefix ("o" . "organize"))
|
||||
(:prefix ("r" . "rename"))
|
||||
(:prefix ("s" . "slurp/split/string"))
|
||||
(:prefix ("t" . "toggle"))
|
||||
(:prefix ("u" . "unwrap"))
|
||||
(:prefix ("v" . "var"))
|
||||
(:prefix ("w" . "wrap"))
|
||||
(:prefix ("3" . "ternary"))))
|
||||
:config
|
||||
(when (modulep! :editor evil +everywhere)
|
||||
(add-hook 'js2-refactor-mode-hook #'evil-normalize-keymaps)
|
||||
(let ((js2-refactor-mode-map (evil-get-auxiliary-keymap js2-refactor-mode-map 'normal t t)))
|
||||
(js2r-add-keybindings-with-prefix (format "%s r" doom-localleader-key)))))
|
||||
|
||||
|
||||
;;;###package skewer-mode
|
||||
(map! :localleader
|
||||
(:after js2-mode
|
||||
:map js2-mode-map
|
||||
"S" #'+javascript/skewer-this-buffer
|
||||
:prefix ("s" . "skewer"))
|
||||
:prefix "s"
|
||||
(:after skewer-mode
|
||||
:map skewer-mode-map
|
||||
"E" #'skewer-eval-last-expression
|
||||
"e" #'skewer-eval-defun
|
||||
"f" #'skewer-load-buffer)
|
||||
|
||||
(:after skewer-css
|
||||
:map skewer-css-mode-map
|
||||
"e" #'skewer-css-eval-current-declaration
|
||||
"r" #'skewer-css-eval-current-rule
|
||||
"b" #'skewer-css-eval-buffer
|
||||
"c" #'skewer-css-clear-all)
|
||||
|
||||
(:after skewer-html
|
||||
:map skewer-html-mode-map
|
||||
"e" #'skewer-html-eval-tag))
|
||||
|
||||
|
||||
(use-package! npm-mode
|
||||
:hook ((js-mode typescript-mode) . npm-mode)
|
||||
:config
|
||||
(map! :localleader
|
||||
(:map npm-mode-keymap
|
||||
"n" npm-mode-command-keymap)
|
||||
(:after js2-mode
|
||||
:map js2-mode-map
|
||||
:prefix ("n" . "npm"))))
|
||||
(+javascript-common-config 'nodejs-repl-mode))
|
||||
|
||||
|
||||
;;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue