Merge pull request merrickluo#33 from aburtsev/docs-twinmacro-setup

merrickluo · web-flow · commit dc4d5246afe8 · 2021-12-15T22:23:54.000+08:00
[docs] twin.macro setup
diff --git a/README.org b/README.org
@@ -85,3 +85,19 @@ If you want to use lsp-tailwindcss in some other file types, like =erb=, you mig
 #+end_src
 
 This is a requirement for lsp-mode, not just for =lsp-tailwindcss=, see https://github.com/emacs-lsp/lsp-mode/blob/563233fe72de6f32ffc6a1b3db0ec7f49c12cb50/lsp-mode.el#L694 .
+
+** How to set up [[https://github.com/ben-rogerson/twin.macro][twin.macro]]?
+
+twin.macro can be integrated using =lsp-tailwindcss-experimental-class-regex= variable (which is alias to =tailwindCSS.experimental.classRegex= . see the reference to [[https://github.com/ben-rogerson/twin.macro/discussions/227][discussion]])
+
+#+begin_src emacs-lisp
+(use-package! lsp-tailwindcss :init (setq! lsp-tailwindcss-experimental-class-regex ["tw([^]*)" "tw=\"([^\"]*)" "tw={\"([^\"}]*)" "tw\\.\\w+([^]*)" "tw\\(.*?\\)([^]*)"]))
+#+end_src
+
+
+Take a note that it can lead to [[https://emacs-lsp.github.io/lsp-mode/page/faq/#i-have-multiple-language-servers-registered-for-language-foo-which-one-will-be-used-when-opening-a-project][the conflict of lsp-servers priorities]] (i.e. some of the servers will not start). To fix this you need to use =lsp-tailwindcss-add-on-mode= too.
+
+Set up with add-on mode:
+#+begin_src emacs-lisp
+(use-package! lsp-tailwindcss :init (setq! lsp-tailwindcss-experimental-class-regex ["tw`([^`]*)" "tw=\"([^\"]*)" "tw={\"([^\"}]*)" "tw\\.\\w+`([^`]*)" "tw\\(.*?\\)`([^`]*)"]) (setq! lsp-tailwindcss-add-on-mode t))
+#+end_src
