-
-
+
+
\ No newline at end of file
diff --git a/assets/js/49773175.6dabd148.js b/assets/js/49773175.c4af849a.js
similarity index 99%
rename from assets/js/49773175.6dabd148.js
rename to assets/js/49773175.c4af849a.js
index ce024670e43..5d8887a9dca 100644
--- a/assets/js/49773175.6dabd148.js
+++ b/assets/js/49773175.c4af849a.js
@@ -1 +1 @@
-"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4100],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),u=p(n),d=i,h=u["".concat(o,".").concat(d)]||u[d]||c[d]||r;return n?a.createElement(h,l(l({ref:t},m),{},{components:n})):a.createElement(h,l({ref:t},m))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=d;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[u]="string"==typeof e?e:i,l[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>p,toc:()=>u});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),l=["components"],s={id:"vim",sidebar_label:"Vim",title:"Vim"},o=void 0,p={unversionedId:"editors/vim",id:"editors/vim",title:"Vim",description:"nvim-metals demo",source:"@site/target/docs/editors/vim.md",sourceDirName:"editors",slug:"/editors/vim",permalink:"/metals/docs/editors/vim",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/vim.md",tags:[],version:"current",frontMatter:{id:"vim",sidebar_label:"Vim",title:"Vim"},sidebar:"docs",previous:{title:"VS Code",permalink:"/metals/docs/editors/vscode"},next:{title:"Sublime Text",permalink:"/metals/docs/editors/sublime"}},m={},u=[{value:"Requirements",id:"requirements",level:2},{value:"nvim-metals",id:"nvim-metals",level:2},{value:"Vim alternatives",id:"vim-alternatives",level:2},{value:"Using an alternative LSP Client",id:"using-an-alternative-lsp-client",level:3},{value:"Files and Directories to include in your Gitignore",id:"files-and-directories-to-include-in-your-gitignore",level:2},{value:"Running scalafix rules",id:"running-scalafix-rules",level:2},{value:"Getting help",id:"getting-help",level:2}],c={toc:u},d="wrapper";function h(e){var t=e.components,n=(0,i.Z)(e,l);return(0,r.kt)(d,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/BglIFli.gif",alt:"nvim-metals demo"})),(0,r.kt)("p",null,"While Metals works with most LSP clients for ",(0,r.kt)("a",{parentName:"p",href:"https://www.vim.org/"},"Vim")," and\n",(0,r.kt)("a",{parentName:"p",href:"https://neovim.io/"},"Neovim"),", we recommend using the dedicated Neovim plugin to\nget the best Metals support. Metals has many specific commands and LSP\nextensions that won't be available when not using the extension."),(0,r.kt)("h2",{id:"requirements"},"Requirements"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Java 8, 11, 17 provided by OpenJDK or Oracle"),". Eclipse OpenJ9 is not\nsupported, please make sure the ",(0,r.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable\npoints to a valid Java 8, 11 or 17 installation."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"macOS, Linux or Windows"),". Metals is developed on many operating systems and\nevery PR is tested on Ubuntu, Windows and MacOS."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Scala 2.13, 2.12, 2.11 and Scala 3"),". Metals supports these Scala versions:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 2.13"),":\n2.13.12, 2.13.11, 2.13.10, 2.13.9, 2.13.8, 2.13.7, 2.13.6, 2.13.5")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 2.12"),":\n2.12.18, 2.12.17, 2.12.16, 2.12.15, 2.12.14, 2.12.13, 2.12.12, 2.12.11")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 2.11"),":\n2.11.12")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 3"),":\n3.3.1, 3.3.0, 3.2.2, 3.2.1, 3.2.0, 3.1.3, 3.1.2, 3.1.1, 3.1.0"))),(0,r.kt)("p",null,"Note that 2.11.x support is deprecated and it will be removed in future releases.\nIt's recommended to upgrade to Scala 2.12 or Scala 2.13"),(0,r.kt)("h2",{id:"nvim-metals"},"nvim-metals"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals"},(0,r.kt)("inlineCode",{parentName:"a"},"nvim-metals"))," Is the the dedicated\nMetals extension for the ",(0,r.kt)("a",{parentName:"p",href:"https://neovim.io/doc/user/lsp.html"},"built-in LSP\nsupport")," in Neovim."),(0,r.kt)("p",null,"To get started with installation please see the ",(0,r.kt)("inlineCode",{parentName:"p"},"nvim-metals"),"\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals#prerequisites"},"prerequisites")," and\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals#installation"},"installation steps"),"."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("th",null,"Version"),(0,r.kt)("th",null,"Published"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1"),(0,r.kt)("td",null,"28 Aug 2023 14:46")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1+60-26f1e686-SNAPSHOT"),(0,r.kt)("td",null,"29 Sep 2023 18:42")))),(0,r.kt)("p",null,"Keep in mind that by default Neovim doesn't have default mappings for the\nfunctionality you'll want like, hovers, goto definition, method signatures, etc.\nYou can find a full example configuration of these in the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/discussions/39"},"example\nconfiguration"),"."),(0,r.kt)("p",null,"For a guide on all the available features in ",(0,r.kt)("inlineCode",{parentName:"p"},"nvim-metals"),", refer to the\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/discussions/279"},"features list"),"."),(0,r.kt)("h2",{id:"vim-alternatives"},"Vim alternatives"),(0,r.kt)("p",null,"There are multiple Vim alternatives if you're not a Neovim user. Metals did have\na Metals-specific plugin that worked with Vim,\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/coc-metals"},(0,r.kt)("inlineCode",{parentName:"a"},"coc-metals")),", but it doesn't work\nwith the newest versions of Metals and is currently ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/coc-metals/issues/460"},"deprecated and\nunmaintained"),"."),(0,r.kt)("h3",{id:"using-an-alternative-lsp-client"},"Using an alternative LSP Client"),(0,r.kt)("p",null,"There are multiple other LSP clients that work with Vim. Here are a few:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/natebosch/vim-lsc/"},(0,r.kt)("inlineCode",{parentName:"a"},"natebosch/vim-lsc")),": simple installation and written in Vimscript."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/prabirshrestha/vim-lsp"},(0,r.kt)("inlineCode",{parentName:"a"},"vim-lsp")),": simple installation and written in\nVimscript."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/yegappan/lsp"},(0,r.kt)("inlineCode",{parentName:"a"},"yegappan/lsp")),": Very new and targeting\nVim9.")),(0,r.kt)("p",null,"Keep in mind that they have varying levels of LSP support, don't support Metals\nspecific commands (like build import), or Metals specific LSP extensions (like\ntree view), and you need to manage the Metals installation yourself."),(0,r.kt)("p",null,"There are two ways to install Metals yourself in order to work with an\nalternative client."),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},"Most easily is to just use ",(0,r.kt)("a",{parentName:"li",href:"https://get-coursier.io/"},"Coursier")," to do a ",(0,r.kt)("inlineCode",{parentName:"li"},"cs\ninstall metals"),"."),(0,r.kt)("li",{parentName:"ol"},"Generating a Metals binary yourself.")),(0,r.kt)("h2",{id:"files-and-directories-to-include-in-your-gitignore"},"Files and Directories to include in your Gitignore"),(0,r.kt)("p",null,"The Metals server places logs and other files in the ",(0,r.kt)("inlineCode",{parentName:"p"},".metals")," directory. The\nBloop compile server places logs and compilation artifacts in the ",(0,r.kt)("inlineCode",{parentName:"p"},".bloop"),"\ndirectory. The Bloop plugin that generates Bloop configuration is added in the\n",(0,r.kt)("inlineCode",{parentName:"p"},"metals.sbt")," file, which is added at ",(0,r.kt)("inlineCode",{parentName:"p"},"project/metals.sbt")," as well as further\n",(0,r.kt)("inlineCode",{parentName:"p"},"project")," directories depending on how deep ",(0,r.kt)("inlineCode",{parentName:"p"},"*.sbt")," files need to be supported.\nTo support each ",(0,r.kt)("inlineCode",{parentName:"p"},"*.sbt")," file Metals needs to create an additional file at\n",(0,r.kt)("inlineCode",{parentName:"p"},"./project/project/metals.sbt")," relative to the sbt file.\nWorking with Ammonite scripts will place compiled scripts into the ",(0,r.kt)("inlineCode",{parentName:"p"},".ammonite")," directory.\nIt's recommended to exclude these directories and files\nfrom version control systems like git."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"# ~/.gitignore\n.metals/\n.bloop/\n.ammonite/\nmetals.sbt\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"coursier bootstrap org.scalameta:metals_2.13:1.0.1 -o metals -f\n")),(0,r.kt)("p",null,"(optional) It's recommended to enable JVM string de-duplication and provide a\ngenerous stack size and memory options."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"coursier bootstrap \\\n --java-opt -XX:+UseG1GC \\\n --java-opt -XX:+UseStringDeduplication \\\n --java-opt -Xss4m \\\n --java-opt -Xms100m \\\n org.scalameta:metals_2.13:1.0.1 -o metals -f\n")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"-Dmetals.client=vim-lsc")," flag is there just as a helper to match your\npotential client. So make sure it matches your client name. This line isn't\nmandatory though as your client should be able to fully be configured via\n",(0,r.kt)("inlineCode",{parentName:"p"},"InitializationOptions"),". You can read more about his\n",(0,r.kt)("a",{parentName:"p",href:"https://scalameta.org/metals/blog/2020/07/23/configuring-a-client#initializationoptions"},"here"),"."),(0,r.kt)("h2",{id:"running-scalafix-rules"},"Running scalafix rules"),(0,r.kt)("p",null,"Scalafix allows users to specify some refactoring and linting rules that can be applied to your\ncodebase. Please checkout the ",(0,r.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix"},"scalafix website")," for more information."),(0,r.kt)("p",null,"Since Metals v0.11.7 it's now possible to run scalafix rules using a special\ncommand ",(0,r.kt)("inlineCode",{parentName:"p"},"metals.scalafix-run"),".\nThis should run all the rules defined in your ",(0,r.kt)("inlineCode",{parentName:"p"},".scalafix.conf")," file. All built-in rules\nand the ",(0,r.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix/docs/rules/community-rules.html#hygiene-rules"},"community hygiene ones")," can\nbe run without any additional settings. However, for all the other rules users need to\nadd an additional dependency in the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals.scalafixRulesDependencies")," user setting.\nThose rules need to be in form of strings such as ",(0,r.kt)("inlineCode",{parentName:"p"},"com.github.liancheng::organize-imports:0.6.0"),", which\nfollows the same convention as ",(0,r.kt)("a",{parentName:"p",href:"https://get-coursier.io/"},"coursier dependencies"),"."),(0,r.kt)("p",null,"A sample scalafix configuration can be seen below:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-hocon"},'rules = [\n OrganizeImports,\n ExplicitResultTypes,\n RemoveUnused\n]\n\nRemoveUnused.imports = false\n\nOrganizeImports.groupedImports = Explode\nOrganizeImports.expandRelative = true\nOrganizeImports.removeUnused = true\nOrganizeImports.groups = [\n "re:javax?\\."\n "scala."\n "scala.meta."\n "*"\n]\n\n')),(0,r.kt)("h2",{id:"getting-help"},"Getting help"),(0,r.kt)("p",null,"There is an active community using Vim and Metals. Apart from ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/issues/new/choose"},"creating an\nissue")," or ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/discussions"},"starting\na discussion")," for\n",(0,r.kt)("inlineCode",{parentName:"p"},"nvim-metals")," users, you can also ask questions in our ",(0,r.kt)("inlineCode",{parentName:"p"},"#vim-users")," ",(0,r.kt)("a",{parentName:"p",href:"https://discord.gg/FaVDrJegEh"},"Discord\nChannel")," or ",(0,r.kt)("a",{parentName:"p",href:"https://matrix.to/#/#scalameta:vim-users"},"Matrix\nBridge"),"."))}h.isMDXComponent=!0}}]);
\ No newline at end of file
+"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4100],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>h});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function r(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function l(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var o=a.createContext({}),p=function(e){var t=a.useContext(o),n=t;return e&&(n="function"==typeof e?e(t):l(l({},t),e)),n},m=function(e){var t=p(e.components);return a.createElement(o.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,r=e.originalType,o=e.parentName,m=s(e,["components","mdxType","originalType","parentName"]),u=p(n),d=i,h=u["".concat(o,".").concat(d)]||u[d]||c[d]||r;return n?a.createElement(h,l(l({ref:t},m),{},{components:n})):a.createElement(h,l({ref:t},m))}));function h(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var r=n.length,l=new Array(r);l[0]=d;var s={};for(var o in t)hasOwnProperty.call(t,o)&&(s[o]=t[o]);s.originalType=e,s[u]="string"==typeof e?e:i,l[1]=s;for(var p=2;p{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>o,default:()=>h,frontMatter:()=>s,metadata:()=>p,toc:()=>u});var a=n(7462),i=n(3366),r=(n(7294),n(3905)),l=["components"],s={id:"vim",sidebar_label:"Vim",title:"Vim"},o=void 0,p={unversionedId:"editors/vim",id:"editors/vim",title:"Vim",description:"nvim-metals demo",source:"@site/target/docs/editors/vim.md",sourceDirName:"editors",slug:"/editors/vim",permalink:"/metals/docs/editors/vim",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/vim.md",tags:[],version:"current",frontMatter:{id:"vim",sidebar_label:"Vim",title:"Vim"},sidebar:"docs",previous:{title:"VS Code",permalink:"/metals/docs/editors/vscode"},next:{title:"Sublime Text",permalink:"/metals/docs/editors/sublime"}},m={},u=[{value:"Requirements",id:"requirements",level:2},{value:"nvim-metals",id:"nvim-metals",level:2},{value:"Vim alternatives",id:"vim-alternatives",level:2},{value:"Using an alternative LSP Client",id:"using-an-alternative-lsp-client",level:3},{value:"Files and Directories to include in your Gitignore",id:"files-and-directories-to-include-in-your-gitignore",level:2},{value:"Running scalafix rules",id:"running-scalafix-rules",level:2},{value:"Getting help",id:"getting-help",level:2}],c={toc:u},d="wrapper";function h(e){var t=e.components,n=(0,i.Z)(e,l);return(0,r.kt)(d,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/BglIFli.gif",alt:"nvim-metals demo"})),(0,r.kt)("p",null,"While Metals works with most LSP clients for ",(0,r.kt)("a",{parentName:"p",href:"https://www.vim.org/"},"Vim")," and\n",(0,r.kt)("a",{parentName:"p",href:"https://neovim.io/"},"Neovim"),", we recommend using the dedicated Neovim plugin to\nget the best Metals support. Metals has many specific commands and LSP\nextensions that won't be available when not using the extension."),(0,r.kt)("h2",{id:"requirements"},"Requirements"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Java 8, 11, 17 provided by OpenJDK or Oracle"),". Eclipse OpenJ9 is not\nsupported, please make sure the ",(0,r.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable\npoints to a valid Java 8, 11 or 17 installation."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"macOS, Linux or Windows"),". Metals is developed on many operating systems and\nevery PR is tested on Ubuntu, Windows and MacOS."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Scala 2.13, 2.12, 2.11 and Scala 3"),". Metals supports these Scala versions:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 2.13"),":\n2.13.12, 2.13.11, 2.13.10, 2.13.9, 2.13.8, 2.13.7, 2.13.6, 2.13.5")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 2.12"),":\n2.12.18, 2.12.17, 2.12.16, 2.12.15, 2.12.14, 2.12.13, 2.12.12, 2.12.11")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 2.11"),":\n2.11.12")),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("p",{parentName:"li"},(0,r.kt)("strong",{parentName:"p"},"Scala 3"),":\n3.3.1, 3.3.0, 3.2.2, 3.2.1, 3.2.0, 3.1.3, 3.1.2, 3.1.1, 3.1.0"))),(0,r.kt)("p",null,"Note that 2.11.x support is deprecated and it will be removed in future releases.\nIt's recommended to upgrade to Scala 2.12 or Scala 2.13"),(0,r.kt)("h2",{id:"nvim-metals"},"nvim-metals"),(0,r.kt)("p",null,(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals"},(0,r.kt)("inlineCode",{parentName:"a"},"nvim-metals"))," Is the the dedicated\nMetals extension for the ",(0,r.kt)("a",{parentName:"p",href:"https://neovim.io/doc/user/lsp.html"},"built-in LSP\nsupport")," in Neovim."),(0,r.kt)("p",null,"To get started with installation please see the ",(0,r.kt)("inlineCode",{parentName:"p"},"nvim-metals"),"\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals#prerequisites"},"prerequisites")," and\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals#installation"},"installation steps"),"."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("th",null,"Version"),(0,r.kt)("th",null,"Published"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1"),(0,r.kt)("td",null,"28 Aug 2023 14:46")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1+61-abcc0e5c-SNAPSHOT"),(0,r.kt)("td",null,"01 Oct 2023 17:00")))),(0,r.kt)("p",null,"Keep in mind that by default Neovim doesn't have default mappings for the\nfunctionality you'll want like, hovers, goto definition, method signatures, etc.\nYou can find a full example configuration of these in the ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/discussions/39"},"example\nconfiguration"),"."),(0,r.kt)("p",null,"For a guide on all the available features in ",(0,r.kt)("inlineCode",{parentName:"p"},"nvim-metals"),", refer to the\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/discussions/279"},"features list"),"."),(0,r.kt)("h2",{id:"vim-alternatives"},"Vim alternatives"),(0,r.kt)("p",null,"There are multiple Vim alternatives if you're not a Neovim user. Metals did have\na Metals-specific plugin that worked with Vim,\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/coc-metals"},(0,r.kt)("inlineCode",{parentName:"a"},"coc-metals")),", but it doesn't work\nwith the newest versions of Metals and is currently ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/coc-metals/issues/460"},"deprecated and\nunmaintained"),"."),(0,r.kt)("h3",{id:"using-an-alternative-lsp-client"},"Using an alternative LSP Client"),(0,r.kt)("p",null,"There are multiple other LSP clients that work with Vim. Here are a few:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/natebosch/vim-lsc/"},(0,r.kt)("inlineCode",{parentName:"a"},"natebosch/vim-lsc")),": simple installation and written in Vimscript."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/prabirshrestha/vim-lsp"},(0,r.kt)("inlineCode",{parentName:"a"},"vim-lsp")),": simple installation and written in\nVimscript."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/yegappan/lsp"},(0,r.kt)("inlineCode",{parentName:"a"},"yegappan/lsp")),": Very new and targeting\nVim9.")),(0,r.kt)("p",null,"Keep in mind that they have varying levels of LSP support, don't support Metals\nspecific commands (like build import), or Metals specific LSP extensions (like\ntree view), and you need to manage the Metals installation yourself."),(0,r.kt)("p",null,"There are two ways to install Metals yourself in order to work with an\nalternative client."),(0,r.kt)("ol",null,(0,r.kt)("li",{parentName:"ol"},"Most easily is to just use ",(0,r.kt)("a",{parentName:"li",href:"https://get-coursier.io/"},"Coursier")," to do a ",(0,r.kt)("inlineCode",{parentName:"li"},"cs\ninstall metals"),"."),(0,r.kt)("li",{parentName:"ol"},"Generating a Metals binary yourself.")),(0,r.kt)("h2",{id:"files-and-directories-to-include-in-your-gitignore"},"Files and Directories to include in your Gitignore"),(0,r.kt)("p",null,"The Metals server places logs and other files in the ",(0,r.kt)("inlineCode",{parentName:"p"},".metals")," directory. The\nBloop compile server places logs and compilation artifacts in the ",(0,r.kt)("inlineCode",{parentName:"p"},".bloop"),"\ndirectory. The Bloop plugin that generates Bloop configuration is added in the\n",(0,r.kt)("inlineCode",{parentName:"p"},"metals.sbt")," file, which is added at ",(0,r.kt)("inlineCode",{parentName:"p"},"project/metals.sbt")," as well as further\n",(0,r.kt)("inlineCode",{parentName:"p"},"project")," directories depending on how deep ",(0,r.kt)("inlineCode",{parentName:"p"},"*.sbt")," files need to be supported.\nTo support each ",(0,r.kt)("inlineCode",{parentName:"p"},"*.sbt")," file Metals needs to create an additional file at\n",(0,r.kt)("inlineCode",{parentName:"p"},"./project/project/metals.sbt")," relative to the sbt file.\nWorking with Ammonite scripts will place compiled scripts into the ",(0,r.kt)("inlineCode",{parentName:"p"},".ammonite")," directory.\nIt's recommended to exclude these directories and files\nfrom version control systems like git."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"# ~/.gitignore\n.metals/\n.bloop/\n.ammonite/\nmetals.sbt\n")),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"coursier bootstrap org.scalameta:metals_2.13:1.0.1 -o metals -f\n")),(0,r.kt)("p",null,"(optional) It's recommended to enable JVM string de-duplication and provide a\ngenerous stack size and memory options."),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-sh"},"coursier bootstrap \\\n --java-opt -XX:+UseG1GC \\\n --java-opt -XX:+UseStringDeduplication \\\n --java-opt -Xss4m \\\n --java-opt -Xms100m \\\n org.scalameta:metals_2.13:1.0.1 -o metals -f\n")),(0,r.kt)("p",null,"The ",(0,r.kt)("inlineCode",{parentName:"p"},"-Dmetals.client=vim-lsc")," flag is there just as a helper to match your\npotential client. So make sure it matches your client name. This line isn't\nmandatory though as your client should be able to fully be configured via\n",(0,r.kt)("inlineCode",{parentName:"p"},"InitializationOptions"),". You can read more about his\n",(0,r.kt)("a",{parentName:"p",href:"https://scalameta.org/metals/blog/2020/07/23/configuring-a-client#initializationoptions"},"here"),"."),(0,r.kt)("h2",{id:"running-scalafix-rules"},"Running scalafix rules"),(0,r.kt)("p",null,"Scalafix allows users to specify some refactoring and linting rules that can be applied to your\ncodebase. Please checkout the ",(0,r.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix"},"scalafix website")," for more information."),(0,r.kt)("p",null,"Since Metals v0.11.7 it's now possible to run scalafix rules using a special\ncommand ",(0,r.kt)("inlineCode",{parentName:"p"},"metals.scalafix-run"),".\nThis should run all the rules defined in your ",(0,r.kt)("inlineCode",{parentName:"p"},".scalafix.conf")," file. All built-in rules\nand the ",(0,r.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix/docs/rules/community-rules.html#hygiene-rules"},"community hygiene ones")," can\nbe run without any additional settings. However, for all the other rules users need to\nadd an additional dependency in the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals.scalafixRulesDependencies")," user setting.\nThose rules need to be in form of strings such as ",(0,r.kt)("inlineCode",{parentName:"p"},"com.github.liancheng::organize-imports:0.6.0"),", which\nfollows the same convention as ",(0,r.kt)("a",{parentName:"p",href:"https://get-coursier.io/"},"coursier dependencies"),"."),(0,r.kt)("p",null,"A sample scalafix configuration can be seen below:"),(0,r.kt)("pre",null,(0,r.kt)("code",{parentName:"pre",className:"language-hocon"},'rules = [\n OrganizeImports,\n ExplicitResultTypes,\n RemoveUnused\n]\n\nRemoveUnused.imports = false\n\nOrganizeImports.groupedImports = Explode\nOrganizeImports.expandRelative = true\nOrganizeImports.removeUnused = true\nOrganizeImports.groups = [\n "re:javax?\\."\n "scala."\n "scala.meta."\n "*"\n]\n\n')),(0,r.kt)("h2",{id:"getting-help"},"Getting help"),(0,r.kt)("p",null,"There is an active community using Vim and Metals. Apart from ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/issues/new/choose"},"creating an\nissue")," or ",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalameta/nvim-metals/discussions"},"starting\na discussion")," for\n",(0,r.kt)("inlineCode",{parentName:"p"},"nvim-metals")," users, you can also ask questions in our ",(0,r.kt)("inlineCode",{parentName:"p"},"#vim-users")," ",(0,r.kt)("a",{parentName:"p",href:"https://discord.gg/FaVDrJegEh"},"Discord\nChannel")," or ",(0,r.kt)("a",{parentName:"p",href:"https://matrix.to/#/#scalameta:vim-users"},"Matrix\nBridge"),"."))}h.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/6048.96f00dfa.js b/assets/js/6048.da11638e.js
similarity index 99%
rename from assets/js/6048.96f00dfa.js
rename to assets/js/6048.da11638e.js
index 519354d77b9..81034523127 100644
--- a/assets/js/6048.96f00dfa.js
+++ b/assets/js/6048.da11638e.js
@@ -1 +1 @@
-"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6048],{9058:(e,t,a)=>{a.d(t,{Z:()=>f});var r=a(3366),l=a(7294),n=a(4334),i=a(5924),o=a(7524),s=a(9960),m=a(5999);const c={sidebar:"sidebar_re4s",sidebarItemTitle:"sidebarItemTitle_pO2u",sidebarItemList:"sidebarItemList_Yudw",sidebarItem:"sidebarItem__DBe",sidebarItemLink:"sidebarItemLink_mo7H",sidebarItemLinkActive:"sidebarItemLinkActive_I1ZP"};function u(e){var t=e.sidebar;return l.createElement("aside",{className:"col col--3"},l.createElement("nav",{className:(0,n.Z)(c.sidebar,"thin-scrollbar"),"aria-label":(0,m.I)({id:"theme.blog.sidebar.navAriaLabel",message:"Blog recent posts navigation",description:"The ARIA label for recent posts in the blog sidebar"})},l.createElement("div",{className:(0,n.Z)(c.sidebarItemTitle,"margin-bottom--md")},t.title),l.createElement("ul",{className:(0,n.Z)(c.sidebarItemList,"clean-list")},t.items.map((function(e){return l.createElement("li",{key:e.permalink,className:c.sidebarItem},l.createElement(s.Z,{isNavLink:!0,to:e.permalink,className:c.sidebarItemLink,activeClassName:c.sidebarItemLinkActive},e.title))})))))}var d=a(3102);function g(e){var t=e.sidebar;return l.createElement("ul",{className:"menu__list"},t.items.map((function(e){return l.createElement("li",{key:e.permalink,className:"menu__list-item"},l.createElement(s.Z,{isNavLink:!0,to:e.permalink,className:"menu__link",activeClassName:"menu__link--active"},e.title))})))}function v(e){return l.createElement(d.Zo,{component:g,props:e})}function h(e){var t=e.sidebar,a=(0,o.i)();return null!=t&&t.items.length?"mobile"===a?l.createElement(v,{sidebar:t}):l.createElement(u,{sidebar:t}):null}var p=["sidebar","toc","children"];function f(e){var t=e.sidebar,a=e.toc,o=e.children,s=(0,r.Z)(e,p),m=t&&t.items.length>0;return l.createElement(i.Z,s,l.createElement("div",{className:"container margin-vert--lg"},l.createElement("div",{className:"row"},l.createElement(h,{sidebar:t}),l.createElement("main",{className:(0,n.Z)("col",{"col--7":m,"col--9 col--offset-1":!m}),itemScope:!0,itemType:"http://schema.org/Blog"},o),a&&l.createElement("div",{className:"col col--2"},a))))}},390:(e,t,a)=>{a.d(t,{Z:()=>R});var r=a(7294),l=a(4334),n=a(9460),i=a(4996);function o(e){var t,a=e.children,l=e.className,o=(0,n.C)(),s=o.frontMatter,m=o.assets,c=(0,i.C)().withBaseUrl,u=null!=(t=m.image)?t:s.image;return r.createElement("article",{className:l,itemProp:"blogPost",itemScope:!0,itemType:"http://schema.org/BlogPosting"},u&&r.createElement("meta",{itemProp:"image",content:c(u,{absolute:!0})}),a)}var s=a(9960);const m={title:"title_f1Hy"};function c(e){var t=e.className,a=(0,n.C)(),i=a.metadata,o=a.isBlogPostPage,c=i.permalink,u=i.title,d=o?"h1":"h2";return r.createElement(d,{className:(0,l.Z)(m.title,t),itemProp:"headline"},o?u:r.createElement(s.Z,{itemProp:"url",to:c},u))}var u=a(5999),d=a(8824);const g={container:"container_mt6G"};function v(e){var t,a=e.readingTime,l=(t=(0,d.c)().selectMessage,function(e){var a=Math.ceil(e);return t(a,(0,u.I)({id:"theme.blog.post.readingTime.plurals",description:'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One min read|{readingTime} min read"},{readingTime:a}))});return r.createElement(r.Fragment,null,l(a))}function h(e){var t=e.date,a=e.formattedDate;return r.createElement("time",{dateTime:t,itemProp:"datePublished"},a)}function p(){return r.createElement(r.Fragment,null," \xb7 ")}function f(e){var t=e.className,a=(0,n.C)().metadata,i=a.date,o=a.formattedDate,s=a.readingTime;return r.createElement("div",{className:(0,l.Z)(g.container,"margin-vert--md",t)},r.createElement(h,{date:i,formattedDate:o}),void 0!==s&&r.createElement(r.Fragment,null,r.createElement(p,null),r.createElement(v,{readingTime:s})))}function b(e){return e.href?r.createElement(s.Z,e):r.createElement(r.Fragment,null,e.children)}function E(e){var t=e.author,a=e.className,n=t.name,i=t.title,o=t.url,s=t.imageURL,m=t.email,c=o||m&&"mailto:"+m||void 0;return r.createElement("div",{className:(0,l.Z)("avatar margin-bottom--sm",a)},s&&r.createElement(b,{href:c,className:"avatar__photo-link"},r.createElement("img",{className:"avatar__photo",src:s,alt:n})),n&&r.createElement("div",{className:"avatar__intro",itemProp:"author",itemScope:!0,itemType:"https://schema.org/Person"},r.createElement("div",{className:"avatar__name"},r.createElement(b,{href:c,itemProp:"url"},r.createElement("span",{itemProp:"name"},n))),i&&r.createElement("small",{className:"avatar__subtitle",itemProp:"description"},i)))}const P={authorCol:"authorCol_Hf19",imageOnlyAuthorRow:"imageOnlyAuthorRow_pa_O",imageOnlyAuthorCol:"imageOnlyAuthorCol_G86a"};function N(e){var t=e.className,a=(0,n.C)(),i=a.metadata.authors,o=a.assets;if(0===i.length)return null;var s=i.every((function(e){return!e.name}));return r.createElement("div",{className:(0,l.Z)("margin-top--md margin-bottom--sm",s?P.imageOnlyAuthorRow:"row",t)},i.map((function(e,t){var a;return r.createElement("div",{className:(0,l.Z)(!s&&"col col--6",s?P.imageOnlyAuthorCol:P.authorCol),key:t},r.createElement(E,{author:Object.assign({},e,{imageURL:null!=(a=o.authorsImageUrls[t])?a:e.imageURL})}))})))}function _(){return r.createElement("header",null,r.createElement(c,null),r.createElement(f,null),r.createElement(N,null))}var Z=a(8780),k=a(652);function I(e){var t=e.children,a=e.className,i=(0,n.C)().isBlogPostPage;return r.createElement("div",{id:i?Z.blogPostContainerID:void 0,className:(0,l.Z)("markdown",a),itemProp:"articleBody"},r.createElement(k.Z,null,t))}var C=a(4881),T=a(6233),w=a(7462),y=a(3366),F=["blogPostTitle"];function L(){return r.createElement("b",null,r.createElement(u.Z,{id:"theme.blog.post.readMore",description:"The label used in blog post item excerpts to link to full blog posts"},"Read More"))}function B(e){var t=e.blogPostTitle,a=(0,y.Z)(e,F);return r.createElement(s.Z,(0,w.Z)({"aria-label":(0,u.I)({message:"Read more about {title}",id:"theme.blog.post.readMoreLabel",description:"The ARIA label for the link to full blog posts from excerpts"},{title:t})},a),r.createElement(L,null))}const A={blogPostFooterDetailsFull:"blogPostFooterDetailsFull_mRVl"};function M(){var e=(0,n.C)(),t=e.metadata,a=e.isBlogPostPage,i=t.tags,o=t.title,s=t.editUrl,m=t.hasTruncateMarker,c=!a&&m,u=i.length>0;return u||c||s?r.createElement("footer",{className:(0,l.Z)("row docusaurus-mt-lg",a&&A.blogPostFooterDetailsFull)},u&&r.createElement("div",{className:(0,l.Z)("col",{"col--9":c})},r.createElement(T.Z,{tags:i})),a&&s&&r.createElement("div",{className:"col margin-top--sm"},r.createElement(C.Z,{editUrl:s})),c&&r.createElement("div",{className:(0,l.Z)("col text--right",{"col--3":u})},r.createElement(B,{blogPostTitle:o,to:t.permalink}))):null}function R(e){var t=e.children,a=e.className,i=(0,n.C)().isBlogPostPage?void 0:"margin-bottom--xl";return r.createElement(o,{className:(0,l.Z)(i,a)},r.createElement(_,null),r.createElement(I,null,t),r.createElement(M,null))}},9460:(e,t,a)=>{a.d(t,{C:()=>o,n:()=>i});var r=a(7294),l=a(9688),n=r.createContext(null);function i(e){var t=e.children,a=e.content,l=e.isBlogPostPage,i=function(e){var t=e.content,a=e.isBlogPostPage;return(0,r.useMemo)((function(){return{metadata:t.metadata,frontMatter:t.frontMatter,assets:t.assets,toc:t.toc,isBlogPostPage:a}}),[t,a])}({content:a,isBlogPostPage:void 0!==l&&l});return r.createElement(n.Provider,{value:i},t)}function o(){var e=(0,r.useContext)(n);if(null===e)throw new l.i6("BlogPostProvider");return e}},8824:(e,t,a)=>{a.d(t,{c:()=>m});var r=a(7294),l=a(2263),n=["zero","one","two","few","many","other"];function i(e){return n.filter((function(t){return e.includes(t)}))}var o={locale:"en",pluralForms:i(["one","other"]),select:function(e){return 1===e?"one":"other"}};function s(){var e=(0,l.Z)().i18n.currentLocale;return(0,r.useMemo)((function(){try{return t=e,a=new Intl.PluralRules(t),{locale:t,pluralForms:i(a.resolvedOptions().pluralCategories),select:function(e){return a.select(e)}}}catch(r){return console.error('Failed to use Intl.PluralRules for locale "'+e+'".\nDocusaurus will fallback to the default (English) implementation.\nError: '+r.message+"\n"),o}var t,a}),[e])}function m(){var e=s();return{selectMessage:function(t,a){return function(e,t,a){var r=e.split("|");if(1===r.length)return r[0];r.length>a.pluralForms.length&&console.error("For locale="+a.locale+", a maximum of "+a.pluralForms.length+" plural forms are expected ("+a.pluralForms.join(",")+"), but the message contains "+r.length+": "+e);var l=a.select(t),n=a.pluralForms.indexOf(l);return r[Math.min(n,r.length-1)]}(a,t,e)}}}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6048],{9058:(e,t,a)=>{a.d(t,{Z:()=>f});var r=a(3366),l=a(7294),n=a(4334),i=a(5924),o=a(7524),s=a(9960),m=a(5999);const c={sidebar:"sidebar_re4s",sidebarItemTitle:"sidebarItemTitle_pO2u",sidebarItemList:"sidebarItemList_Yudw",sidebarItem:"sidebarItem__DBe",sidebarItemLink:"sidebarItemLink_mo7H",sidebarItemLinkActive:"sidebarItemLinkActive_I1ZP"};function u(e){var t=e.sidebar;return l.createElement("aside",{className:"col col--3"},l.createElement("nav",{className:(0,n.Z)(c.sidebar,"thin-scrollbar"),"aria-label":(0,m.I)({id:"theme.blog.sidebar.navAriaLabel",message:"Blog recent posts navigation",description:"The ARIA label for recent posts in the blog sidebar"})},l.createElement("div",{className:(0,n.Z)(c.sidebarItemTitle,"margin-bottom--md")},t.title),l.createElement("ul",{className:(0,n.Z)(c.sidebarItemList,"clean-list")},t.items.map((function(e){return l.createElement("li",{key:e.permalink,className:c.sidebarItem},l.createElement(s.Z,{isNavLink:!0,to:e.permalink,className:c.sidebarItemLink,activeClassName:c.sidebarItemLinkActive},e.title))})))))}var d=a(3102);function g(e){var t=e.sidebar;return l.createElement("ul",{className:"menu__list"},t.items.map((function(e){return l.createElement("li",{key:e.permalink,className:"menu__list-item"},l.createElement(s.Z,{isNavLink:!0,to:e.permalink,className:"menu__link",activeClassName:"menu__link--active"},e.title))})))}function v(e){return l.createElement(d.Zo,{component:g,props:e})}function h(e){var t=e.sidebar,a=(0,o.i)();return null!=t&&t.items.length?"mobile"===a?l.createElement(v,{sidebar:t}):l.createElement(u,{sidebar:t}):null}var p=["sidebar","toc","children"];function f(e){var t=e.sidebar,a=e.toc,o=e.children,s=(0,r.Z)(e,p),m=t&&t.items.length>0;return l.createElement(i.Z,s,l.createElement("div",{className:"container margin-vert--lg"},l.createElement("div",{className:"row"},l.createElement(h,{sidebar:t}),l.createElement("main",{className:(0,n.Z)("col",{"col--7":m,"col--9 col--offset-1":!m}),itemScope:!0,itemType:"http://schema.org/Blog"},o),a&&l.createElement("div",{className:"col col--2"},a))))}},390:(e,t,a)=>{a.d(t,{Z:()=>R});var r=a(7294),l=a(4334),n=a(9460),i=a(4996);function o(e){var t,a=e.children,l=e.className,o=(0,n.C)(),s=o.frontMatter,m=o.assets,c=(0,i.C)().withBaseUrl,u=null!=(t=m.image)?t:s.image;return r.createElement("article",{className:l,itemProp:"blogPost",itemScope:!0,itemType:"http://schema.org/BlogPosting"},u&&r.createElement("meta",{itemProp:"image",content:c(u,{absolute:!0})}),a)}var s=a(9960);const m={title:"title_f1Hy"};function c(e){var t=e.className,a=(0,n.C)(),i=a.metadata,o=a.isBlogPostPage,c=i.permalink,u=i.title,d=o?"h1":"h2";return r.createElement(d,{className:(0,l.Z)(m.title,t),itemProp:"headline"},o?u:r.createElement(s.Z,{itemProp:"url",to:c},u))}var u=a(5999),d=a(8824);const g={container:"container_mt6G"};function v(e){var t,a=e.readingTime,l=(t=(0,d.c)().selectMessage,function(e){var a=Math.ceil(e);return t(a,(0,u.I)({id:"theme.blog.post.readingTime.plurals",description:'Pluralized label for "{readingTime} min read". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',message:"One min read|{readingTime} min read"},{readingTime:a}))});return r.createElement(r.Fragment,null,l(a))}function h(e){var t=e.date,a=e.formattedDate;return r.createElement("time",{dateTime:t,itemProp:"datePublished"},a)}function p(){return r.createElement(r.Fragment,null," \xb7 ")}function f(e){var t=e.className,a=(0,n.C)().metadata,i=a.date,o=a.formattedDate,s=a.readingTime;return r.createElement("div",{className:(0,l.Z)(g.container,"margin-vert--md",t)},r.createElement(h,{date:i,formattedDate:o}),void 0!==s&&r.createElement(r.Fragment,null,r.createElement(p,null),r.createElement(v,{readingTime:s})))}function b(e){return e.href?r.createElement(s.Z,e):r.createElement(r.Fragment,null,e.children)}function E(e){var t=e.author,a=e.className,n=t.name,i=t.title,o=t.url,s=t.imageURL,m=t.email,c=o||m&&"mailto:"+m||void 0;return r.createElement("div",{className:(0,l.Z)("avatar margin-bottom--sm",a)},s&&r.createElement(b,{href:c,className:"avatar__photo-link"},r.createElement("img",{className:"avatar__photo",src:s,alt:n})),n&&r.createElement("div",{className:"avatar__intro",itemProp:"author",itemScope:!0,itemType:"https://schema.org/Person"},r.createElement("div",{className:"avatar__name"},r.createElement(b,{href:c,itemProp:"url"},r.createElement("span",{itemProp:"name"},n))),i&&r.createElement("small",{className:"avatar__subtitle",itemProp:"description"},i)))}const P={authorCol:"authorCol_Hf19",imageOnlyAuthorRow:"imageOnlyAuthorRow_pa_O",imageOnlyAuthorCol:"imageOnlyAuthorCol_G86a"};function N(e){var t=e.className,a=(0,n.C)(),i=a.metadata.authors,o=a.assets;if(0===i.length)return null;var s=i.every((function(e){return!e.name}));return r.createElement("div",{className:(0,l.Z)("margin-top--md margin-bottom--sm",s?P.imageOnlyAuthorRow:"row",t)},i.map((function(e,t){var a;return r.createElement("div",{className:(0,l.Z)(!s&&"col col--6",s?P.imageOnlyAuthorCol:P.authorCol),key:t},r.createElement(E,{author:Object.assign({},e,{imageURL:null!=(a=o.authorsImageUrls[t])?a:e.imageURL})}))})))}function _(){return r.createElement("header",null,r.createElement(c,null),r.createElement(f,null),r.createElement(N,null))}var Z=a(9356),k=a(652);function I(e){var t=e.children,a=e.className,i=(0,n.C)().isBlogPostPage;return r.createElement("div",{id:i?Z.blogPostContainerID:void 0,className:(0,l.Z)("markdown",a),itemProp:"articleBody"},r.createElement(k.Z,null,t))}var C=a(4881),T=a(6233),w=a(7462),y=a(3366),F=["blogPostTitle"];function L(){return r.createElement("b",null,r.createElement(u.Z,{id:"theme.blog.post.readMore",description:"The label used in blog post item excerpts to link to full blog posts"},"Read More"))}function B(e){var t=e.blogPostTitle,a=(0,y.Z)(e,F);return r.createElement(s.Z,(0,w.Z)({"aria-label":(0,u.I)({message:"Read more about {title}",id:"theme.blog.post.readMoreLabel",description:"The ARIA label for the link to full blog posts from excerpts"},{title:t})},a),r.createElement(L,null))}const A={blogPostFooterDetailsFull:"blogPostFooterDetailsFull_mRVl"};function M(){var e=(0,n.C)(),t=e.metadata,a=e.isBlogPostPage,i=t.tags,o=t.title,s=t.editUrl,m=t.hasTruncateMarker,c=!a&&m,u=i.length>0;return u||c||s?r.createElement("footer",{className:(0,l.Z)("row docusaurus-mt-lg",a&&A.blogPostFooterDetailsFull)},u&&r.createElement("div",{className:(0,l.Z)("col",{"col--9":c})},r.createElement(T.Z,{tags:i})),a&&s&&r.createElement("div",{className:"col margin-top--sm"},r.createElement(C.Z,{editUrl:s})),c&&r.createElement("div",{className:(0,l.Z)("col text--right",{"col--3":u})},r.createElement(B,{blogPostTitle:o,to:t.permalink}))):null}function R(e){var t=e.children,a=e.className,i=(0,n.C)().isBlogPostPage?void 0:"margin-bottom--xl";return r.createElement(o,{className:(0,l.Z)(i,a)},r.createElement(_,null),r.createElement(I,null,t),r.createElement(M,null))}},9460:(e,t,a)=>{a.d(t,{C:()=>o,n:()=>i});var r=a(7294),l=a(9688),n=r.createContext(null);function i(e){var t=e.children,a=e.content,l=e.isBlogPostPage,i=function(e){var t=e.content,a=e.isBlogPostPage;return(0,r.useMemo)((function(){return{metadata:t.metadata,frontMatter:t.frontMatter,assets:t.assets,toc:t.toc,isBlogPostPage:a}}),[t,a])}({content:a,isBlogPostPage:void 0!==l&&l});return r.createElement(n.Provider,{value:i},t)}function o(){var e=(0,r.useContext)(n);if(null===e)throw new l.i6("BlogPostProvider");return e}},8824:(e,t,a)=>{a.d(t,{c:()=>m});var r=a(7294),l=a(2263),n=["zero","one","two","few","many","other"];function i(e){return n.filter((function(t){return e.includes(t)}))}var o={locale:"en",pluralForms:i(["one","other"]),select:function(e){return 1===e?"one":"other"}};function s(){var e=(0,l.Z)().i18n.currentLocale;return(0,r.useMemo)((function(){try{return t=e,a=new Intl.PluralRules(t),{locale:t,pluralForms:i(a.resolvedOptions().pluralCategories),select:function(e){return a.select(e)}}}catch(r){return console.error('Failed to use Intl.PluralRules for locale "'+e+'".\nDocusaurus will fallback to the default (English) implementation.\nError: '+r.message+"\n"),o}var t,a}),[e])}function m(){var e=s();return{selectMessage:function(t,a){return function(e,t,a){var r=e.split("|");if(1===r.length)return r[0];r.length>a.pluralForms.length&&console.error("For locale="+a.locale+", a maximum of "+a.pluralForms.length+" plural forms are expected ("+a.pluralForms.join(",")+"), but the message contains "+r.length+": "+e);var l=a.select(t),n=a.pluralForms.indexOf(l);return r[Math.min(n,r.length-1)]}(a,t,e)}}}}}]);
\ No newline at end of file
diff --git a/assets/js/8a0b8ece.274c5da6.js b/assets/js/8a0b8ece.ebbea43f.js
similarity index 99%
rename from assets/js/8a0b8ece.274c5da6.js
rename to assets/js/8a0b8ece.ebbea43f.js
index e3c37f1d2d2..754807d229a 100644
--- a/assets/js/8a0b8ece.274c5da6.js
+++ b/assets/js/8a0b8ece.ebbea43f.js
@@ -1 +1 @@
-"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4782],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,s=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),u=p(n),d=i,k=u["".concat(s,".").concat(d)]||u[d]||c[d]||l;return n?a.createElement(k,o(o({ref:t},m),{},{components:n})):a.createElement(k,o({ref:t},m))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,o=new Array(l);o[0]=d;var r={};for(var s in t)hasOwnProperty.call(t,s)&&(r[s]=t[s]);r.originalType=e,r[u]="string"==typeof e?e:i,o[1]=r;for(var p=2;p{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>k,frontMatter:()=>r,metadata:()=>p,toc:()=>u});var a=n(7462),i=n(3366),l=(n(7294),n(3905)),o=["components"],r={id:"sublime",title:"Sublime Text"},s=void 0,p={unversionedId:"editors/sublime",id:"editors/sublime",title:"Sublime Text",description:"Metals works with Sublime Text (build 4000 or later) thanks to the",source:"@site/target/docs/editors/sublime.md",sourceDirName:"editors",slug:"/editors/sublime",permalink:"/metals/docs/editors/sublime",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/sublime.md",tags:[],version:"current",frontMatter:{id:"sublime",title:"Sublime Text"},sidebar:"docs",previous:{title:"Vim",permalink:"/metals/docs/editors/vim"},next:{title:"Emacs",permalink:"/metals/docs/editors/emacs"}},m={},u=[{value:"Requirements",id:"requirements",level:2},{value:"Installing the plugins",id:"installing-the-plugins",level:2},{value:"Importing a build",id:"importing-a-build",level:2},{value:"Server logs",id:"server-logs",level:2},{value:"Find symbol references",id:"find-symbol-references",level:2},{value:"Goto symbol in workspace",id:"goto-symbol-in-workspace",level:2},{value:"Manually trigger build import",id:"manually-trigger-build-import",level:2},{value:"Tweaking Sublime Text for a better productivity",id:"tweaking-sublime-text-for-a-better-productivity",level:2},{value:"Optional LSP client tweaks",id:"optional-lsp-client-tweaks",level:3},{value:"Additional key mappings",id:"additional-key-mappings",level:3},{value:"Keymapping for formatting document via scalafmt",id:"keymapping-for-formatting-document-via-scalafmt",level:4},{value:"Add key mapping for Goto symbol in workspace",id:"add-key-mapping-for-goto-symbol-in-workspace",level:3},{value:"Enabling auto-import on completion",id:"enabling-auto-import-on-completion",level:3},{value:"Using latest Metals SNAPSHOT",id:"using-latest-metals-snapshot",level:2},{value:"Files and Directories to include in your Gitignore",id:"files-and-directories-to-include-in-your-gitignore",level:2},{value:"Worksheets",id:"worksheets",level:2},{value:"Getting started with Worksheets",id:"getting-started-with-worksheets",level:3},{value:"Evaluations",id:"evaluations",level:3},{value:"Using dependencies in worksheets",id:"using-dependencies-in-worksheets",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Running scalafix rules",id:"running-scalafix-rules",level:2}],c={toc:u},d="wrapper";function k(e){var t=e.components,n=(0,i.Z)(e,o);return(0,l.kt)(d,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,"Metals works with Sublime Text (build 4000 or later) thanks to the\n",(0,l.kt)("a",{parentName:"p",href:"https://github.com/sublimelsp/LSP"},"sublimelsp/LSP")," and ",(0,l.kt)("a",{parentName:"p",href:"https://github.com/scalameta/metals-sublime"},"scalameta/metals-sublime")," plugins."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/vJKP0T3.gif",alt:"Sublime Text demo"})),(0,l.kt)("h2",{id:"requirements"},"Requirements"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Java 8, 11, 17 provided by OpenJDK or Oracle"),". Eclipse OpenJ9 is not\nsupported, please make sure the ",(0,l.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable\npoints to a valid Java 8, 11 or 17 installation."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"macOS, Linux or Windows"),". Metals is developed on many operating systems and\nevery PR is tested on Ubuntu, Windows and MacOS."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Scala 2.13, 2.12, 2.11 and Scala 3"),". Metals supports these Scala versions:"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 2.13"),":\n2.13.12, 2.13.11, 2.13.10, 2.13.9, 2.13.8, 2.13.7, 2.13.6, 2.13.5")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 2.12"),":\n2.12.18, 2.12.17, 2.12.16, 2.12.15, 2.12.14, 2.12.13, 2.12.12, 2.12.11")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 2.11"),":\n2.11.12")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 3"),":\n3.3.1, 3.3.0, 3.2.2, 3.2.1, 3.2.0, 3.1.3, 3.1.2, 3.1.1, 3.1.0"))),(0,l.kt)("p",null,"Note that 2.11.x support is deprecated and it will be removed in future releases.\nIt's recommended to upgrade to Scala 2.12 or Scala 2.13"),(0,l.kt)("h2",{id:"installing-the-plugins"},"Installing the plugins"),(0,l.kt)("p",null,"Install the following packages:"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"https://github.com/sublimelsp/LSP"},"sublimelsp/LSP"),": Language Server Protocol support for Sublime Text.",(0,l.kt)("br",{parentName:"p"}),"\n",(0,l.kt)("inlineCode",{parentName:"p"},"Command Palette (Cmd + Shift + P) > Install package > LSP"))),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"https://github.com/scalameta/metals-sublime"},"scalameta/metals-sublime"),": For automatic installation of metals and custom commands.\n",(0,l.kt)("inlineCode",{parentName:"p"},"Command Palette (Cmd + Shift + P) > Install package > LSP-metals")))),(0,l.kt)("p",null,"Finally restart sublime text."),(0,l.kt)("p",null,'Next, open "Preferences > Key Binding" and register ',(0,l.kt)("inlineCode",{parentName:"p"},"F12")," to trigger goto\ndefinition."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[\n // ...\n {\n "keys": ["f12"],\n "command": "lsp_symbol_definition"\n }\n]\n')),(0,l.kt)("h2",{id:"importing-a-build"},"Importing a build"),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/eUk30Zy.png",alt:"Build Import"})),(0,l.kt)("p",null,"Open Sublime in the base directory of your Scala project and it will then prompt you to import the build as long as you're using one of the ",(0,l.kt)("a",{parentName:"p",href:"https://scalameta.org/metals/docs/build-tools/overview.html"},"supported build tools"),'. Click "Import build" to start the installation step.'),(0,l.kt)("p",null,"This starts the Metal language server but no functionality will work yet because the\nbuild has not been imported. "),(0,l.kt)("p",null,"This step can take a long time, especially the first time you run it in a new\nworkspace. The exact time depends on the complexity of the build and if the library dependencies are cached or need to be downloaded. For example, this step can take anywhere from 10 seconds in small cached builds up to 10-15 minutes in large un-cached builds."),(0,l.kt)("h2",{id:"server-logs"},"Server logs"),(0,l.kt)("p",null,"For more detailed information about what is happening behind the scenes during\n",(0,l.kt)("inlineCode",{parentName:"p"},"sbt bloopInstall")," run ",(0,l.kt)("inlineCode",{parentName:"p"},"lsp toggle server panel")," in the command palette. You can optionally add key binding for this command."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/PilER2E.png",alt:"Server logs"})),(0,l.kt)("p",null,"Once the import step completes, compilation starts for your open ",(0,l.kt)("inlineCode",{parentName:"p"},"*.scala"),'\nfiles. Once the sources have compiled successfully, you can navigate the\nsources with "Goto definition" by pressing ',(0,l.kt)("inlineCode",{parentName:"p"},"F12"),"."),(0,l.kt)("h2",{id:"find-symbol-references"},"Find symbol references"),(0,l.kt)("p",null,"The default key binding is ",(0,l.kt)("inlineCode",{parentName:"p"},"shift+F12"),". If you use vim-bindings, you need to be\nin insert-mode."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/BJDkczD.gif",alt:"Find references"})),(0,l.kt)("h2",{id:"goto-symbol-in-workspace"},"Goto symbol in workspace"),(0,l.kt)("p",null,"You can search for symbols in your dependency source using the command palette."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/8X0XNi2.gif",alt:"workspace symbols"})),(0,l.kt)("h2",{id:"manually-trigger-build-import"},"Manually trigger build import"),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/LViPc95.png",alt:"Import build command"})),(0,l.kt)("p",null,"You can optionally register a key binding for the command."),(0,l.kt)("h2",{id:"tweaking-sublime-text-for-a-better-productivity"},"Tweaking Sublime Text for a better productivity"),(0,l.kt)("p",null,"This paragraph contains a few tips & trick that can improve your daily productivity with Metals."),(0,l.kt)("h3",{id:"optional-lsp-client-tweaks"},"Optional LSP client tweaks"),(0,l.kt)("p",null,'If you prefer to only enable Metals completions\n(without mixing them with the default ones from Sublime) set the following setting\nin the "Preferences > Preferences: LSP Settings":'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n // ...\n "only_show_lsp_completions": true,\n}\n')),(0,l.kt)("p",null,'Also, if you prefer to show symbol references in Sublime\'s quick panel instead of the bottom panel\nset following setting in the "Preferences > Preferences: LSP Settings":'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n // ...\n "show_references_in_quick_panel": true,\n}\n')),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/7tSiEfX.gif",alt:"Symbol references in the popup"})),(0,l.kt)("h3",{id:"additional-key-mappings"},"Additional key mappings"),(0,l.kt)("p",null,"You can set a few optional key mappings for enable useful action shortcuts and perform some tweaks for the completion popup."),(0,l.kt)("h4",{id:"keymapping-for-formatting-document-via-scalafmt"},"Keymapping for formatting document via scalafmt"),(0,l.kt)("p",null,'Open "Preferences > Key Binding" and register ',(0,l.kt)("inlineCode",{parentName:"p"},"ctrl+alt+l")," to trigger formatting document.\ndefinition."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[\n // ...\n {\n "keys": ["ctrl+alt+l"],\n "command": "lsp_format_document"\n }\n]\n')),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/wVjC1Ij.gif",alt:"Add key mapping for formatting document via scalafmt"})),(0,l.kt)("h3",{id:"add-key-mapping-for-goto-symbol-in-workspace"},"Add key mapping for Goto symbol in workspace"),(0,l.kt)("p",null,'This an optional step if you want to have a shortcut for looking up symbols in the workspace.\nOpen "Preferences > Key Binding" and add:'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[\n // ...\n { \n "keys": ["ctrl+t"], \n "command": "show_overlay",\n "args": {"overlay": "command_palette", "command": "lsp_workspace_symbols" }\n }\n]\n')),(0,l.kt)("h3",{id:"enabling-auto-import-on-completion"},"Enabling auto-import on completion"),(0,l.kt)("p",null,'Metals can complete symbols from your workspace scope and automatically import them.\nBy default, however, if you hit "Enter" to select a completion, the LSP client will\ncomplete the class without importing it, but you can easy remap to use also "Enter" key.\nOpen "Preferences > Key Binding" and add:'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[ \n // ...\n { "keys": ["enter"], "command": "commit_completion", "context": [{ "key": "auto_complete_visible" } ] },\n { "keys": ["tab"], "command": "commit_completion", "context": [{ "key": "auto_complete_visible" } ] }\n]\n')),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/RDYx9mB.gif",alt:"Import after Enter key was hit"})),(0,l.kt)("h2",{id:"using-latest-metals-snapshot"},"Using latest Metals SNAPSHOT"),(0,l.kt)("p",null,'Update the "server_version" setting to try out the latest pending Metals\nfeatures by accessing ',(0,l.kt)("inlineCode",{parentName:"p"},"Preferences > Package Settings > LSP > Servers > LSP-metals")),(0,l.kt)("table",null,(0,l.kt)("thead",null,(0,l.kt)("tr",null,(0,l.kt)("th",null,"Version"),(0,l.kt)("th",null,"Published"))),(0,l.kt)("tbody",null,(0,l.kt)("tr",null,(0,l.kt)("td",null,"1.0.1"),(0,l.kt)("td",null,"28 Aug 2023 14:46")),(0,l.kt)("tr",null,(0,l.kt)("td",null,"1.0.1+60-26f1e686-SNAPSHOT"),(0,l.kt)("td",null,"29 Sep 2023 18:42")))),(0,l.kt)("h2",{id:"files-and-directories-to-include-in-your-gitignore"},"Files and Directories to include in your Gitignore"),(0,l.kt)("p",null,"The Metals server places logs and other files in the ",(0,l.kt)("inlineCode",{parentName:"p"},".metals")," directory. The\nBloop compile server places logs and compilation artifacts in the ",(0,l.kt)("inlineCode",{parentName:"p"},".bloop"),"\ndirectory. The Bloop plugin that generates Bloop configuration is added in the\n",(0,l.kt)("inlineCode",{parentName:"p"},"metals.sbt")," file, which is added at ",(0,l.kt)("inlineCode",{parentName:"p"},"project/metals.sbt")," as well as further\n",(0,l.kt)("inlineCode",{parentName:"p"},"project")," directories depending on how deep ",(0,l.kt)("inlineCode",{parentName:"p"},"*.sbt")," files need to be supported.\nTo support each ",(0,l.kt)("inlineCode",{parentName:"p"},"*.sbt")," file Metals needs to create an additional file at\n",(0,l.kt)("inlineCode",{parentName:"p"},"./project/project/metals.sbt")," relative to the sbt file.\nWorking with Ammonite scripts will place compiled scripts into the ",(0,l.kt)("inlineCode",{parentName:"p"},".ammonite")," directory.\nIt's recommended to exclude these directories and files\nfrom version control systems like git."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-sh"},"# ~/.gitignore\n.metals/\n.bloop/\n.ammonite/\nmetals.sbt\n")),(0,l.kt)("h2",{id:"worksheets"},"Worksheets"),(0,l.kt)("p",null,"Worksheets are a great way to explore an api, try out an idea, or code\nup an example and quickly see the evaluated expression or result. Behind\nthe scenes worksheets are powered by the great work done in\n",(0,l.kt)("a",{parentName:"p",href:"https://scalameta.org/mdoc/"},"mdoc"),"."),(0,l.kt)("h3",{id:"getting-started-with-worksheets"},"Getting started with Worksheets"),(0,l.kt)("p",null,"To get started with a worksheet you can either use the ",(0,l.kt)("inlineCode",{parentName:"p"},"metals.new-scala-file"),"\ncommand and select ",(0,l.kt)("em",{parentName:"p"},"Worksheet")," or create a file called ",(0,l.kt)("inlineCode",{parentName:"p"},"*.worksheet.sc"),".\nThis format is important since this is what tells Metals that it's meant to be\ntreated as a worksheet and not just a Scala script. Where you create the\nscript also matters. If you'd like to use classes and values from your\nproject, you need to make sure the worksheet is created inside of your ",(0,l.kt)("inlineCode",{parentName:"p"},"src"),"\ndirectory. You can still create a worksheet in other places, but you will\nonly have access to the standard library and your dependencies."),(0,l.kt)("h3",{id:"evaluations"},"Evaluations"),(0,l.kt)("p",null,"After saving you'll see the result of the expression as a comment as the end of the line.\nYou may not see the full result for example if it's too long, so you are also\nable to hover on the comment to expand."),(0,l.kt)("p",null,"Keep in mind that you don't need to wrap your code in an ",(0,l.kt)("inlineCode",{parentName:"p"},"object"),". In worksheets\neverything can be evaluated at the top level."),(0,l.kt)("h3",{id:"using-dependencies-in-worksheets"},"Using dependencies in worksheets"),(0,l.kt)("p",null,"You are able to include an external dependency in your worksheet by including\nit in one of the following two ways."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-scala"},"// $dep.`organisation`::artifact:version` style\nimport $dep.`com.lihaoyi::scalatags:0.7.0`\n\n// $ivy.`organisation::artifact:version` style\nimport $ivy.`com.lihaoyi::scalatags:0.7.0`\n")),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"::")," is the same as ",(0,l.kt)("inlineCode",{parentName:"p"},"%%")," in sbt, which will append the current Scala binary version\nto the artifact name."),(0,l.kt)("p",null,"You can also import ",(0,l.kt)("inlineCode",{parentName:"p"},"scalac")," options in a special ",(0,l.kt)("inlineCode",{parentName:"p"},"$scalac")," import like below:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-scala"},"import $scalac.`-Ywarn-unused`\n")),(0,l.kt)("h3",{id:"troubleshooting"},"Troubleshooting"),(0,l.kt)("p",null,"Since worksheets are not standard Scala files, you may run into issues with some constructs.\nFor example, you may see an error like this:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"value classes may not be a member of another class - mdoc\n")),(0,l.kt)("p",null,"This means that one of the classes defined in the worksheet extends AnyVal, which is\nnot currently supported. You can work around this by moving the class to a separate file or removing\nthe AnyVal parent."),(0,l.kt)("h2",{id:"running-scalafix-rules"},"Running scalafix rules"),(0,l.kt)("p",null,"Scalafix allows users to specify some refactoring and linting rules that can be applied to your\ncodebase. Please checkout the ",(0,l.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix"},"scalafix website")," for more information."),(0,l.kt)("p",null,"Since Metals v0.11.7 it's now possible to run scalafix rules using a special\ncommand ",(0,l.kt)("inlineCode",{parentName:"p"},"metals.scalafix-run"),".\nThis should run all the rules defined in your ",(0,l.kt)("inlineCode",{parentName:"p"},".scalafix.conf")," file. All built-in rules\nand the ",(0,l.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix/docs/rules/community-rules.html#hygiene-rules"},"community hygiene ones")," can\nbe run without any additional settings. However, for all the other rules users need to\nadd an additional dependency in the ",(0,l.kt)("inlineCode",{parentName:"p"},"metals.scalafixRulesDependencies")," user setting.\nThose rules need to be in form of strings such as ",(0,l.kt)("inlineCode",{parentName:"p"},"com.github.liancheng::organize-imports:0.6.0"),", which\nfollows the same convention as ",(0,l.kt)("a",{parentName:"p",href:"https://get-coursier.io/"},"coursier dependencies"),"."),(0,l.kt)("p",null,"A sample scalafix configuration can be seen below:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-hocon"},'rules = [\n OrganizeImports,\n ExplicitResultTypes,\n RemoveUnused\n]\n\nRemoveUnused.imports = false\n\nOrganizeImports.groupedImports = Explode\nOrganizeImports.expandRelative = true\nOrganizeImports.removeUnused = true\nOrganizeImports.groups = [\n "re:javax?\\."\n "scala."\n "scala.meta."\n "*"\n]\n\n')))}k.isMDXComponent=!0}}]);
\ No newline at end of file
+"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[4782],{3905:(e,t,n)=>{n.d(t,{Zo:()=>m,kt:()=>k});var a=n(7294);function i(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function l(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function o(e){for(var t=1;t=0||(i[n]=e[n]);return i}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(i[n]=e[n])}return i}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):o(o({},t),e)),n},m=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},u="mdxType",c={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},d=a.forwardRef((function(e,t){var n=e.components,i=e.mdxType,l=e.originalType,s=e.parentName,m=r(e,["components","mdxType","originalType","parentName"]),u=p(n),d=i,k=u["".concat(s,".").concat(d)]||u[d]||c[d]||l;return n?a.createElement(k,o(o({ref:t},m),{},{components:n})):a.createElement(k,o({ref:t},m))}));function k(e,t){var n=arguments,i=t&&t.mdxType;if("string"==typeof e||i){var l=n.length,o=new Array(l);o[0]=d;var r={};for(var s in t)hasOwnProperty.call(t,s)&&(r[s]=t[s]);r.originalType=e,r[u]="string"==typeof e?e:i,o[1]=r;for(var p=2;p{n.r(t),n.d(t,{assets:()=>m,contentTitle:()=>s,default:()=>k,frontMatter:()=>r,metadata:()=>p,toc:()=>u});var a=n(7462),i=n(3366),l=(n(7294),n(3905)),o=["components"],r={id:"sublime",title:"Sublime Text"},s=void 0,p={unversionedId:"editors/sublime",id:"editors/sublime",title:"Sublime Text",description:"Metals works with Sublime Text (build 4000 or later) thanks to the",source:"@site/target/docs/editors/sublime.md",sourceDirName:"editors",slug:"/editors/sublime",permalink:"/metals/docs/editors/sublime",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/sublime.md",tags:[],version:"current",frontMatter:{id:"sublime",title:"Sublime Text"},sidebar:"docs",previous:{title:"Vim",permalink:"/metals/docs/editors/vim"},next:{title:"Emacs",permalink:"/metals/docs/editors/emacs"}},m={},u=[{value:"Requirements",id:"requirements",level:2},{value:"Installing the plugins",id:"installing-the-plugins",level:2},{value:"Importing a build",id:"importing-a-build",level:2},{value:"Server logs",id:"server-logs",level:2},{value:"Find symbol references",id:"find-symbol-references",level:2},{value:"Goto symbol in workspace",id:"goto-symbol-in-workspace",level:2},{value:"Manually trigger build import",id:"manually-trigger-build-import",level:2},{value:"Tweaking Sublime Text for a better productivity",id:"tweaking-sublime-text-for-a-better-productivity",level:2},{value:"Optional LSP client tweaks",id:"optional-lsp-client-tweaks",level:3},{value:"Additional key mappings",id:"additional-key-mappings",level:3},{value:"Keymapping for formatting document via scalafmt",id:"keymapping-for-formatting-document-via-scalafmt",level:4},{value:"Add key mapping for Goto symbol in workspace",id:"add-key-mapping-for-goto-symbol-in-workspace",level:3},{value:"Enabling auto-import on completion",id:"enabling-auto-import-on-completion",level:3},{value:"Using latest Metals SNAPSHOT",id:"using-latest-metals-snapshot",level:2},{value:"Files and Directories to include in your Gitignore",id:"files-and-directories-to-include-in-your-gitignore",level:2},{value:"Worksheets",id:"worksheets",level:2},{value:"Getting started with Worksheets",id:"getting-started-with-worksheets",level:3},{value:"Evaluations",id:"evaluations",level:3},{value:"Using dependencies in worksheets",id:"using-dependencies-in-worksheets",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Running scalafix rules",id:"running-scalafix-rules",level:2}],c={toc:u},d="wrapper";function k(e){var t=e.components,n=(0,i.Z)(e,o);return(0,l.kt)(d,(0,a.Z)({},c,n,{components:t,mdxType:"MDXLayout"}),(0,l.kt)("p",null,"Metals works with Sublime Text (build 4000 or later) thanks to the\n",(0,l.kt)("a",{parentName:"p",href:"https://github.com/sublimelsp/LSP"},"sublimelsp/LSP")," and ",(0,l.kt)("a",{parentName:"p",href:"https://github.com/scalameta/metals-sublime"},"scalameta/metals-sublime")," plugins."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/vJKP0T3.gif",alt:"Sublime Text demo"})),(0,l.kt)("h2",{id:"requirements"},"Requirements"),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Java 8, 11, 17 provided by OpenJDK or Oracle"),". Eclipse OpenJ9 is not\nsupported, please make sure the ",(0,l.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable\npoints to a valid Java 8, 11 or 17 installation."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"macOS, Linux or Windows"),". Metals is developed on many operating systems and\nevery PR is tested on Ubuntu, Windows and MacOS."),(0,l.kt)("p",null,(0,l.kt)("strong",{parentName:"p"},"Scala 2.13, 2.12, 2.11 and Scala 3"),". Metals supports these Scala versions:"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 2.13"),":\n2.13.12, 2.13.11, 2.13.10, 2.13.9, 2.13.8, 2.13.7, 2.13.6, 2.13.5")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 2.12"),":\n2.12.18, 2.12.17, 2.12.16, 2.12.15, 2.12.14, 2.12.13, 2.12.12, 2.12.11")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 2.11"),":\n2.11.12")),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("strong",{parentName:"p"},"Scala 3"),":\n3.3.1, 3.3.0, 3.2.2, 3.2.1, 3.2.0, 3.1.3, 3.1.2, 3.1.1, 3.1.0"))),(0,l.kt)("p",null,"Note that 2.11.x support is deprecated and it will be removed in future releases.\nIt's recommended to upgrade to Scala 2.12 or Scala 2.13"),(0,l.kt)("h2",{id:"installing-the-plugins"},"Installing the plugins"),(0,l.kt)("p",null,"Install the following packages:"),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"https://github.com/sublimelsp/LSP"},"sublimelsp/LSP"),": Language Server Protocol support for Sublime Text.",(0,l.kt)("br",{parentName:"p"}),"\n",(0,l.kt)("inlineCode",{parentName:"p"},"Command Palette (Cmd + Shift + P) > Install package > LSP"))),(0,l.kt)("li",{parentName:"ul"},(0,l.kt)("p",{parentName:"li"},(0,l.kt)("a",{parentName:"p",href:"https://github.com/scalameta/metals-sublime"},"scalameta/metals-sublime"),": For automatic installation of metals and custom commands.\n",(0,l.kt)("inlineCode",{parentName:"p"},"Command Palette (Cmd + Shift + P) > Install package > LSP-metals")))),(0,l.kt)("p",null,"Finally restart sublime text."),(0,l.kt)("p",null,'Next, open "Preferences > Key Binding" and register ',(0,l.kt)("inlineCode",{parentName:"p"},"F12")," to trigger goto\ndefinition."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[\n // ...\n {\n "keys": ["f12"],\n "command": "lsp_symbol_definition"\n }\n]\n')),(0,l.kt)("h2",{id:"importing-a-build"},"Importing a build"),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/eUk30Zy.png",alt:"Build Import"})),(0,l.kt)("p",null,"Open Sublime in the base directory of your Scala project and it will then prompt you to import the build as long as you're using one of the ",(0,l.kt)("a",{parentName:"p",href:"https://scalameta.org/metals/docs/build-tools/overview.html"},"supported build tools"),'. Click "Import build" to start the installation step.'),(0,l.kt)("p",null,"This starts the Metal language server but no functionality will work yet because the\nbuild has not been imported. "),(0,l.kt)("p",null,"This step can take a long time, especially the first time you run it in a new\nworkspace. The exact time depends on the complexity of the build and if the library dependencies are cached or need to be downloaded. For example, this step can take anywhere from 10 seconds in small cached builds up to 10-15 minutes in large un-cached builds."),(0,l.kt)("h2",{id:"server-logs"},"Server logs"),(0,l.kt)("p",null,"For more detailed information about what is happening behind the scenes during\n",(0,l.kt)("inlineCode",{parentName:"p"},"sbt bloopInstall")," run ",(0,l.kt)("inlineCode",{parentName:"p"},"lsp toggle server panel")," in the command palette. You can optionally add key binding for this command."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/PilER2E.png",alt:"Server logs"})),(0,l.kt)("p",null,"Once the import step completes, compilation starts for your open ",(0,l.kt)("inlineCode",{parentName:"p"},"*.scala"),'\nfiles. Once the sources have compiled successfully, you can navigate the\nsources with "Goto definition" by pressing ',(0,l.kt)("inlineCode",{parentName:"p"},"F12"),"."),(0,l.kt)("h2",{id:"find-symbol-references"},"Find symbol references"),(0,l.kt)("p",null,"The default key binding is ",(0,l.kt)("inlineCode",{parentName:"p"},"shift+F12"),". If you use vim-bindings, you need to be\nin insert-mode."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/BJDkczD.gif",alt:"Find references"})),(0,l.kt)("h2",{id:"goto-symbol-in-workspace"},"Goto symbol in workspace"),(0,l.kt)("p",null,"You can search for symbols in your dependency source using the command palette."),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/8X0XNi2.gif",alt:"workspace symbols"})),(0,l.kt)("h2",{id:"manually-trigger-build-import"},"Manually trigger build import"),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/LViPc95.png",alt:"Import build command"})),(0,l.kt)("p",null,"You can optionally register a key binding for the command."),(0,l.kt)("h2",{id:"tweaking-sublime-text-for-a-better-productivity"},"Tweaking Sublime Text for a better productivity"),(0,l.kt)("p",null,"This paragraph contains a few tips & trick that can improve your daily productivity with Metals."),(0,l.kt)("h3",{id:"optional-lsp-client-tweaks"},"Optional LSP client tweaks"),(0,l.kt)("p",null,'If you prefer to only enable Metals completions\n(without mixing them with the default ones from Sublime) set the following setting\nin the "Preferences > Preferences: LSP Settings":'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n // ...\n "only_show_lsp_completions": true,\n}\n')),(0,l.kt)("p",null,'Also, if you prefer to show symbol references in Sublime\'s quick panel instead of the bottom panel\nset following setting in the "Preferences > Preferences: LSP Settings":'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'{\n // ...\n "show_references_in_quick_panel": true,\n}\n')),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/7tSiEfX.gif",alt:"Symbol references in the popup"})),(0,l.kt)("h3",{id:"additional-key-mappings"},"Additional key mappings"),(0,l.kt)("p",null,"You can set a few optional key mappings for enable useful action shortcuts and perform some tweaks for the completion popup."),(0,l.kt)("h4",{id:"keymapping-for-formatting-document-via-scalafmt"},"Keymapping for formatting document via scalafmt"),(0,l.kt)("p",null,'Open "Preferences > Key Binding" and register ',(0,l.kt)("inlineCode",{parentName:"p"},"ctrl+alt+l")," to trigger formatting document.\ndefinition."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[\n // ...\n {\n "keys": ["ctrl+alt+l"],\n "command": "lsp_format_document"\n }\n]\n')),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/wVjC1Ij.gif",alt:"Add key mapping for formatting document via scalafmt"})),(0,l.kt)("h3",{id:"add-key-mapping-for-goto-symbol-in-workspace"},"Add key mapping for Goto symbol in workspace"),(0,l.kt)("p",null,'This an optional step if you want to have a shortcut for looking up symbols in the workspace.\nOpen "Preferences > Key Binding" and add:'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[\n // ...\n { \n "keys": ["ctrl+t"], \n "command": "show_overlay",\n "args": {"overlay": "command_palette", "command": "lsp_workspace_symbols" }\n }\n]\n')),(0,l.kt)("h3",{id:"enabling-auto-import-on-completion"},"Enabling auto-import on completion"),(0,l.kt)("p",null,'Metals can complete symbols from your workspace scope and automatically import them.\nBy default, however, if you hit "Enter" to select a completion, the LSP client will\ncomplete the class without importing it, but you can easy remap to use also "Enter" key.\nOpen "Preferences > Key Binding" and add:'),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-json"},'[ \n // ...\n { "keys": ["enter"], "command": "commit_completion", "context": [{ "key": "auto_complete_visible" } ] },\n { "keys": ["tab"], "command": "commit_completion", "context": [{ "key": "auto_complete_visible" } ] }\n]\n')),(0,l.kt)("p",null,(0,l.kt)("img",{parentName:"p",src:"https://i.imgur.com/RDYx9mB.gif",alt:"Import after Enter key was hit"})),(0,l.kt)("h2",{id:"using-latest-metals-snapshot"},"Using latest Metals SNAPSHOT"),(0,l.kt)("p",null,'Update the "server_version" setting to try out the latest pending Metals\nfeatures by accessing ',(0,l.kt)("inlineCode",{parentName:"p"},"Preferences > Package Settings > LSP > Servers > LSP-metals")),(0,l.kt)("table",null,(0,l.kt)("thead",null,(0,l.kt)("tr",null,(0,l.kt)("th",null,"Version"),(0,l.kt)("th",null,"Published"))),(0,l.kt)("tbody",null,(0,l.kt)("tr",null,(0,l.kt)("td",null,"1.0.1"),(0,l.kt)("td",null,"28 Aug 2023 14:46")),(0,l.kt)("tr",null,(0,l.kt)("td",null,"1.0.1+61-abcc0e5c-SNAPSHOT"),(0,l.kt)("td",null,"01 Oct 2023 17:00")))),(0,l.kt)("h2",{id:"files-and-directories-to-include-in-your-gitignore"},"Files and Directories to include in your Gitignore"),(0,l.kt)("p",null,"The Metals server places logs and other files in the ",(0,l.kt)("inlineCode",{parentName:"p"},".metals")," directory. The\nBloop compile server places logs and compilation artifacts in the ",(0,l.kt)("inlineCode",{parentName:"p"},".bloop"),"\ndirectory. The Bloop plugin that generates Bloop configuration is added in the\n",(0,l.kt)("inlineCode",{parentName:"p"},"metals.sbt")," file, which is added at ",(0,l.kt)("inlineCode",{parentName:"p"},"project/metals.sbt")," as well as further\n",(0,l.kt)("inlineCode",{parentName:"p"},"project")," directories depending on how deep ",(0,l.kt)("inlineCode",{parentName:"p"},"*.sbt")," files need to be supported.\nTo support each ",(0,l.kt)("inlineCode",{parentName:"p"},"*.sbt")," file Metals needs to create an additional file at\n",(0,l.kt)("inlineCode",{parentName:"p"},"./project/project/metals.sbt")," relative to the sbt file.\nWorking with Ammonite scripts will place compiled scripts into the ",(0,l.kt)("inlineCode",{parentName:"p"},".ammonite")," directory.\nIt's recommended to exclude these directories and files\nfrom version control systems like git."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-sh"},"# ~/.gitignore\n.metals/\n.bloop/\n.ammonite/\nmetals.sbt\n")),(0,l.kt)("h2",{id:"worksheets"},"Worksheets"),(0,l.kt)("p",null,"Worksheets are a great way to explore an api, try out an idea, or code\nup an example and quickly see the evaluated expression or result. Behind\nthe scenes worksheets are powered by the great work done in\n",(0,l.kt)("a",{parentName:"p",href:"https://scalameta.org/mdoc/"},"mdoc"),"."),(0,l.kt)("h3",{id:"getting-started-with-worksheets"},"Getting started with Worksheets"),(0,l.kt)("p",null,"To get started with a worksheet you can either use the ",(0,l.kt)("inlineCode",{parentName:"p"},"metals.new-scala-file"),"\ncommand and select ",(0,l.kt)("em",{parentName:"p"},"Worksheet")," or create a file called ",(0,l.kt)("inlineCode",{parentName:"p"},"*.worksheet.sc"),".\nThis format is important since this is what tells Metals that it's meant to be\ntreated as a worksheet and not just a Scala script. Where you create the\nscript also matters. If you'd like to use classes and values from your\nproject, you need to make sure the worksheet is created inside of your ",(0,l.kt)("inlineCode",{parentName:"p"},"src"),"\ndirectory. You can still create a worksheet in other places, but you will\nonly have access to the standard library and your dependencies."),(0,l.kt)("h3",{id:"evaluations"},"Evaluations"),(0,l.kt)("p",null,"After saving you'll see the result of the expression as a comment as the end of the line.\nYou may not see the full result for example if it's too long, so you are also\nable to hover on the comment to expand."),(0,l.kt)("p",null,"Keep in mind that you don't need to wrap your code in an ",(0,l.kt)("inlineCode",{parentName:"p"},"object"),". In worksheets\neverything can be evaluated at the top level."),(0,l.kt)("h3",{id:"using-dependencies-in-worksheets"},"Using dependencies in worksheets"),(0,l.kt)("p",null,"You are able to include an external dependency in your worksheet by including\nit in one of the following two ways."),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-scala"},"// $dep.`organisation`::artifact:version` style\nimport $dep.`com.lihaoyi::scalatags:0.7.0`\n\n// $ivy.`organisation::artifact:version` style\nimport $ivy.`com.lihaoyi::scalatags:0.7.0`\n")),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"::")," is the same as ",(0,l.kt)("inlineCode",{parentName:"p"},"%%")," in sbt, which will append the current Scala binary version\nto the artifact name."),(0,l.kt)("p",null,"You can also import ",(0,l.kt)("inlineCode",{parentName:"p"},"scalac")," options in a special ",(0,l.kt)("inlineCode",{parentName:"p"},"$scalac")," import like below:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-scala"},"import $scalac.`-Ywarn-unused`\n")),(0,l.kt)("h3",{id:"troubleshooting"},"Troubleshooting"),(0,l.kt)("p",null,"Since worksheets are not standard Scala files, you may run into issues with some constructs.\nFor example, you may see an error like this:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre"},"value classes may not be a member of another class - mdoc\n")),(0,l.kt)("p",null,"This means that one of the classes defined in the worksheet extends AnyVal, which is\nnot currently supported. You can work around this by moving the class to a separate file or removing\nthe AnyVal parent."),(0,l.kt)("h2",{id:"running-scalafix-rules"},"Running scalafix rules"),(0,l.kt)("p",null,"Scalafix allows users to specify some refactoring and linting rules that can be applied to your\ncodebase. Please checkout the ",(0,l.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix"},"scalafix website")," for more information."),(0,l.kt)("p",null,"Since Metals v0.11.7 it's now possible to run scalafix rules using a special\ncommand ",(0,l.kt)("inlineCode",{parentName:"p"},"metals.scalafix-run"),".\nThis should run all the rules defined in your ",(0,l.kt)("inlineCode",{parentName:"p"},".scalafix.conf")," file. All built-in rules\nand the ",(0,l.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix/docs/rules/community-rules.html#hygiene-rules"},"community hygiene ones")," can\nbe run without any additional settings. However, for all the other rules users need to\nadd an additional dependency in the ",(0,l.kt)("inlineCode",{parentName:"p"},"metals.scalafixRulesDependencies")," user setting.\nThose rules need to be in form of strings such as ",(0,l.kt)("inlineCode",{parentName:"p"},"com.github.liancheng::organize-imports:0.6.0"),", which\nfollows the same convention as ",(0,l.kt)("a",{parentName:"p",href:"https://get-coursier.io/"},"coursier dependencies"),"."),(0,l.kt)("p",null,"A sample scalafix configuration can be seen below:"),(0,l.kt)("pre",null,(0,l.kt)("code",{parentName:"pre",className:"language-hocon"},'rules = [\n OrganizeImports,\n ExplicitResultTypes,\n RemoveUnused\n]\n\nRemoveUnused.imports = false\n\nOrganizeImports.groupedImports = Explode\nOrganizeImports.expandRelative = true\nOrganizeImports.removeUnused = true\nOrganizeImports.groups = [\n "re:javax?\\."\n "scala."\n "scala.meta."\n "*"\n]\n\n')))}k.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/970a5f4e.3ff18fe3.js b/assets/js/970a5f4e.ff83099d.js
similarity index 99%
rename from assets/js/970a5f4e.3ff18fe3.js
rename to assets/js/970a5f4e.ff83099d.js
index a22df8f7632..2e62010b39a 100644
--- a/assets/js/970a5f4e.3ff18fe3.js
+++ b/assets/js/970a5f4e.ff83099d.js
@@ -1 +1 @@
-"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6561],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>h});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),d=p(n),c=o,h=d["".concat(s,".").concat(c)]||d[c]||m[c]||i;return n?a.createElement(h,r(r({ref:t},u),{},{components:n})):a.createElement(h,r({ref:t},u))}));function h(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,r=new Array(i);r[0]=c;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:o,r[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>p,toc:()=>d});var a=n(7462),o=n(3366),i=(n(7294),n(3905)),r=["components"],l={id:"vscode",sidebar_label:"VS Code",title:"Visual Studio Code"},s=void 0,p={unversionedId:"editors/vscode",id:"editors/vscode",title:"Visual Studio Code",description:"Goto Definition",source:"@site/target/docs/editors/vscode.md",sourceDirName:"editors",slug:"/editors/vscode",permalink:"/metals/docs/editors/vscode",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/vscode.md",tags:[],version:"current",frontMatter:{id:"vscode",sidebar_label:"VS Code",title:"Visual Studio Code"},sidebar:"docs",previous:{title:"Overview",permalink:"/metals/docs/"},next:{title:"Vim",permalink:"/metals/docs/editors/vim"}},u={},d=[{value:"Requirements",id:"requirements",level:2},{value:"Installation",id:"installation",level:2},{value:"Importing a build",id:"importing-a-build",level:2},{value:"Custom sbt launcher",id:"custom-sbt-launcher",level:3},{value:"Speeding up import",id:"speeding-up-import",level:3},{value:"Importing changes",id:"importing-changes",level:3},{value:"Manually trigger build import",id:"manually-trigger-build-import",level:3},{value:"Run doctor",id:"run-doctor",level:2},{value:"Configure Java version",id:"configure-java-version",level:2},{value:"macOS",id:"macos",level:3},{value:"Custom artifact repositories (Maven or Ivy resolvers)",id:"custom-artifact-repositories-maven-or-ivy-resolvers",level:2},{value:"HTTP proxy",id:"http-proxy",level:2},{value:'Using latest Metals SNAPSHOT',id:"using-latest-metals-snapshot",level:2},{value:"Files and Directories to include in your Gitignore",id:"files-and-directories-to-include-in-your-gitignore",level:2},{value:"Show document symbols",id:"show-document-symbols",level:2},{value:"Go to parent code lenses",id:"go-to-parent-code-lenses",level:2},{value:"Create new project from template",id:"create-new-project-from-template",level:2},{value:"Running and debugging your code",id:"running-and-debugging-your-code",level:2},{value:"via code lenses",id:"via-code-lenses",level:3},{value:"via a launch.json configuration",id:"via-a-launchjson-configuration",level:3},{value:"via Metals' commands",id:"via-metals-commands",level:3},{value:"On type formatting for multiline string formatting",id:"on-type-formatting-for-multiline-string-formatting",level:2},{value:"Formatting on paste for multiline strings",id:"formatting-on-paste-for-multiline-strings",level:2},{value:"Worksheets",id:"worksheets",level:2},{value:"Getting started with Worksheets",id:"getting-started-with-worksheets",level:3},{value:"Evaluations",id:"evaluations",level:3},{value:"Using dependencies in worksheets",id:"using-dependencies-in-worksheets",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Running scalafix rules",id:"running-scalafix-rules",level:2},{value:"Searching a symbol in the workspace",id:"searching-a-symbol-in-the-workspace",level:2},{value:"Test Explorer",id:"test-explorer",level:2},{value:"Coming from IntelliJ",id:"coming-from-intellij",level:2},{value:"GitHub Codespaces and GitHub.dev support",id:"github-codespaces-and-githubdev-support",level:2}],m={toc:d},c="wrapper";function h(e){var t=e.components,n=(0,o.Z)(e,r);return(0,i.kt)(c,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/48776422-1f764f00-ecd0-11e8-96d1-170f2354d50e.gif",alt:"Goto Definition"})),(0,i.kt)("h2",{id:"requirements"},"Requirements"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Java 8, 11, 17 provided by OpenJDK or Oracle"),". Eclipse OpenJ9 is not\nsupported, please make sure the ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable\npoints to a valid Java 8, 11 or 17 installation."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"macOS, Linux or Windows"),". Metals is developed on many operating systems and\nevery PR is tested on Ubuntu, Windows and MacOS."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Scala 2.13, 2.12, 2.11 and Scala 3"),". Metals supports these Scala versions:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 2.13"),":\n2.13.12, 2.13.11, 2.13.10, 2.13.9, 2.13.8, 2.13.7, 2.13.6, 2.13.5")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 2.12"),":\n2.12.18, 2.12.17, 2.12.16, 2.12.15, 2.12.14, 2.12.13, 2.12.12, 2.12.11")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 2.11"),":\n2.11.12")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 3"),":\n3.3.1, 3.3.0, 3.2.2, 3.2.1, 3.2.0, 3.1.3, 3.1.2, 3.1.1, 3.1.0"))),(0,i.kt)("p",null,"Note that 2.11.x support is deprecated and it will be removed in future releases.\nIt's recommended to upgrade to Scala 2.12 or Scala 2.13"),(0,i.kt)("h2",{id:"installation"},"Installation"),(0,i.kt)("p",null,"Install the Metals extension from the\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=scalameta.metals"},"Marketplace")," by clicking on this badge ",(0,i.kt)("a",{parentName:"p",href:"vscode:extension/scalameta.metals"},(0,i.kt)("img",{parentName:"a",src:"https://img.shields.io/badge/metals-vscode-blue.png",alt:"Install Metals extension"}))," or via the VS Code editor:"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://imgur.com/Qew0fNH.png",alt:"install stable version"})),(0,i.kt)("blockquote",null,(0,i.kt)("p",{parentName:"blockquote"},"Make sure to disable the extensions\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=dragos.scala-lsp"},"Scala Language Server"),"\nand\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=lightbend.vscode-sbt-scala"},"Scala (sbt)"),"\nif they are installed. The\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=lampepfl.dotty"},"Dotty Language Server"),"\ndoes ",(0,i.kt)("strong",{parentName:"p"},"not")," need to be disabled because the Metals and Dotty extensions don't\nconflict with each other. However, if you want to work on Scala 3 code in a\nworkspace that was previously opened with ",(0,i.kt)("inlineCode",{parentName:"p"},"Dotty Language Server")," you need to\nfirst remove ",(0,i.kt)("inlineCode",{parentName:"p"},".dotty-ide-artifact")," before opening the workspace with Metals.")),(0,i.kt)("p",null,"Next, open a directory containing your Scala code. The extension activates when\nthe main directory contains ",(0,i.kt)("inlineCode",{parentName:"p"},"build.sbt")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"build.sc")," file, a Scala file is\nopened, which includes ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sbt"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"*.scala")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sc")," file, or a standard Scala\ndirectory structure ",(0,i.kt)("inlineCode",{parentName:"p"},"src/main/scala")," is detected."),(0,i.kt)("p",null,"It is also possible to opt in to install the pre-release version and try out the latest cutting edge features from Metals server.\nApart from new features, pre-release versions also include many bugfixes. It's encouraged to use them with ",(0,i.kt)("a",{parentName:"p",href:"#SNAPSHOT"},"SNAPSHOT")," releases of Metals server. Using pre-release versions may result in less stable experience and it is not indented for beginners.\nPre-release versions follow ",(0,i.kt)("inlineCode",{parentName:"p"},"major.minor.PATCH")," versioning."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://imgur.com/CzOTleE.png",alt:"Install the pre-release extension"})),(0,i.kt)("h2",{id:"importing-a-build"},"Importing a build"),(0,i.kt)("p",null,'The first time you open Metals in a new workspace it prompts you to import the build.\nClick "Import build" to start the installation step.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/0VqZWay.png",alt:"Import build"})),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},'"Not now" disables this prompt for 2 minutes.'),(0,i.kt)("li",{parentName:"ul"},'"Don\'t show again" disables this prompt forever, use ',(0,i.kt)("inlineCode",{parentName:"li"},"rm -rf .metals/")," to re-enable\nthe prompt."),(0,i.kt)("li",{parentName:"ul"},"Use ",(0,i.kt)("inlineCode",{parentName:"li"},"tail -f .metals/metals.log")," to watch the build import progress."),(0,i.kt)("li",{parentName:"ul"},"Behind the scenes, Metals uses ",(0,i.kt)("a",{parentName:"li",href:"https://scalacenter.github.io/bloop/"},"Bloop")," to\nimport sbt builds, but you don't need Bloop installed on your machine to run this step.")),(0,i.kt)("p",null,"Once the import step completes, compilation starts for your open ",(0,i.kt)("inlineCode",{parentName:"p"},"*.scala"),"\nfiles."),(0,i.kt)("p",null,"Once the sources have compiled successfully, you can navigate the codebase with\ngoto definition."),(0,i.kt)("h3",{id:"custom-sbt-launcher"},"Custom sbt launcher"),(0,i.kt)("p",null,"By default, Metals runs an embedded ",(0,i.kt)("inlineCode",{parentName:"p"},"sbt-launch.jar")," launcher that respects ",(0,i.kt)("inlineCode",{parentName:"p"},".sbtopts")," and ",(0,i.kt)("inlineCode",{parentName:"p"},".jvmopts"),".\nHowever, the environment variables ",(0,i.kt)("inlineCode",{parentName:"p"},"SBT_OPTS")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_OPTS")," are not respected."),(0,i.kt)("p",null,'Update the "Sbt Script" setting to use a custom ',(0,i.kt)("inlineCode",{parentName:"p"},"sbt")," script instead of the\ndefault Metals launcher if you need further customizations like reading environment\nvariables."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/NuwEBe4.png",alt:"Sbt Launcher"})),(0,i.kt)("h3",{id:"speeding-up-import"},"Speeding up import"),(0,i.kt)("p",null,'The "Import build" step can take a long time, especially the first time you\nrun it in a new build. The exact time depends on the complexity of the build and\nif library dependencies need to be downloaded. For example, this step can take\neverything from 10 seconds in small cached builds up to 10-15 minutes in large\nuncached builds.'),(0,i.kt)("p",null,"Consult the ",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/bloop/docs/build-tools/sbt#speeding-up-build-export"},"Bloop documentation"),"\nto learn how to speed up build import."),(0,i.kt)("h3",{id:"importing-changes"},"Importing changes"),(0,i.kt)("p",null,"When you change ",(0,i.kt)("inlineCode",{parentName:"p"},"build.sbt")," or sources under ",(0,i.kt)("inlineCode",{parentName:"p"},"project/"),", you will be prompted to\nre-import the build."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/72kdZkL.png",alt:"Import sbt changes"})),(0,i.kt)("h3",{id:"manually-trigger-build-import"},"Manually trigger build import"),(0,i.kt)("p",null,'To manually trigger a build import, execute the "Import build" command through\nthe command palette (',(0,i.kt)("inlineCode",{parentName:"p"},"Cmd + Shift + P"),")."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/QHLKt8u.png",alt:"Import build command"})),(0,i.kt)("h2",{id:"run-doctor"},"Run doctor"),(0,i.kt)("p",null,'Execute the "Run Doctor" through the command palette to troubleshoot potential\nconfiguration problems in your workspace.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/K02g0UM.png",alt:"Run doctor command"})),(0,i.kt)("h2",{id:"configure-java-version"},"Configure Java version"),(0,i.kt)("p",null,"The VS Code plugin uses by default the ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable (via\n",(0,i.kt)("a",{parentName:"p",href:"https://www.npmjs.com/package/locate-java-home"},(0,i.kt)("inlineCode",{parentName:"a"},"locate-java-home")),") to locate\nthe ",(0,i.kt)("inlineCode",{parentName:"p"},"java"),' executable. To override the default Java home location, update the\n"Java Home" variable in the settings menu.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/sKrPKk2.png",alt:"Java Home setting"})),(0,i.kt)("p",null,"If this setting is defined, the VS Code plugin uses the custom path instead of\nthe ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable."),(0,i.kt)("h3",{id:"macos"},"macOS"),(0,i.kt)("p",null,"To globally configure ",(0,i.kt)("inlineCode",{parentName:"p"},"$JAVA_HOME")," for all GUI applications, see\n",(0,i.kt)("a",{parentName:"p",href:"https://stackoverflow.com/questions/135688/setting-environment-variables-on-os-x"},"this Stackoverflow answer"),"."),(0,i.kt)("p",null,"If you prefer to manually configure Java home through VS Code, run the following\ncommand to copy the Java 8 home path."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"/usr/libexec/java_home -v 1.8 | pbcopy\n")),(0,i.kt)("h2",{id:"custom-artifact-repositories-maven-or-ivy-resolvers"},"Custom artifact repositories (Maven or Ivy resolvers)"),(0,i.kt)("p",null,"Use the 'Custom Repositories' setting for the Metals VS Code extension to tell\n",(0,i.kt)("a",{parentName:"p",href:"https://get-coursier.io/docs/other-proxy"},"Coursier")," to try to download Metals\nartifacts from your private artifact repository."),(0,i.kt)("p",null,"Use ",(0,i.kt)("inlineCode",{parentName:"p"},".jvmopts")," to set sbt options\n(",(0,i.kt)("a",{parentName:"p",href:"https://www.scala-sbt.org/1.0/docs/Proxy-Repositories.html"},"https://www.scala-sbt.org/1.0/docs/Proxy-Repositories.html"),") for\n",(0,i.kt)("inlineCode",{parentName:"p"},"sbt bloopInstall")," which resolves library dependencies. You can also provide a\ncustom sbt script (see 'Custom sbt launcher')."),(0,i.kt)("h2",{id:"http-proxy"},"HTTP proxy"),(0,i.kt)("p",null,"Metals uses ",(0,i.kt)("a",{parentName:"p",href:"https://get-coursier.io/docs/other-proxy"},"Coursier")," to download\nartifacts from Maven Central. To use Metals behind an HTTP proxy, configure the\nsystem properties ",(0,i.kt)("inlineCode",{parentName:"p"},"-Dhttps.proxyHost=\u2026 -Dhttps.proxyPort=\u2026")," in one of the\nfollowing locations:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},".jvmopts")," file in the workspace directory."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"JAVA_OPTS")," environment variable, make sure to start ",(0,i.kt)("inlineCode",{parentName:"li"},"code")," from your terminal\nwhen using this option since environment variables don't always propagate\ncorrectly when opening VS Code as a GUI application outside a terminal."),(0,i.kt)("li",{parentName:"ul"},'"Server Properties" setting for the Metals VS Code extension, which can be\nconfigured per-workspace or per-user.')),(0,i.kt)("h2",{id:"using-latest-metals-snapshot"},"Using latest Metals ",(0,i.kt)("a",{name:"SNAPSHOT"},"SNAPSHOT")),(0,i.kt)("p",null,'Update the "Server Version" setting to try out the latest pending Metals\nfeatures.'),(0,i.kt)("table",null,(0,i.kt)("thead",null,(0,i.kt)("tr",null,(0,i.kt)("th",null,"Version"),(0,i.kt)("th",null,"Published"))),(0,i.kt)("tbody",null,(0,i.kt)("tr",null,(0,i.kt)("td",null,"1.0.1"),(0,i.kt)("td",null,"28 Aug 2023 14:46")),(0,i.kt)("tr",null,(0,i.kt)("td",null,"1.0.1+60-26f1e686-SNAPSHOT"),(0,i.kt)("td",null,"29 Sep 2023 18:42")))),'Run the "Reload Window" command after updating the setting for the new version to take effect.',(0,i.kt)("h2",{id:"files-and-directories-to-include-in-your-gitignore"},"Files and Directories to include in your Gitignore"),(0,i.kt)("p",null,"The Metals server places logs and other files in the ",(0,i.kt)("inlineCode",{parentName:"p"},".metals")," directory. The\nBloop compile server places logs and compilation artifacts in the ",(0,i.kt)("inlineCode",{parentName:"p"},".bloop"),"\ndirectory. The Bloop plugin that generates Bloop configuration is added in the\n",(0,i.kt)("inlineCode",{parentName:"p"},"metals.sbt")," file, which is added at ",(0,i.kt)("inlineCode",{parentName:"p"},"project/metals.sbt")," as well as further\n",(0,i.kt)("inlineCode",{parentName:"p"},"project")," directories depending on how deep ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sbt")," files need to be supported.\nTo support each ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sbt")," file Metals needs to create an additional file at\n",(0,i.kt)("inlineCode",{parentName:"p"},"./project/project/metals.sbt")," relative to the sbt file.\nWorking with Ammonite scripts will place compiled scripts into the ",(0,i.kt)("inlineCode",{parentName:"p"},".ammonite")," directory.\nIt's recommended to exclude these directories and files\nfrom version control systems like git."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"# ~/.gitignore\n.metals/\n.bloop/\n.ammonite/\nmetals.sbt\n")),(0,i.kt)("h2",{id:"show-document-symbols"},"Show document symbols"),(0,i.kt)("p",null,'Run the "Explorer: Focus on Outline View" command to open the symbol outline for\nthe current file in the sidebar.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/T0kVJsr.gif",alt:"Document Symbols Outline"})),(0,i.kt)("p",null,'Run the "Open Symbol in File" command to search for a symbol in the current file\nwithout opening the sidebar.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/0PJ4brd.png",alt:"Document Symbols Command"})),(0,i.kt)("p",null,"As you type, the symbol outline is also visible at the top of the file.\n",(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/L217n4q.png",alt:"Document Symbols Outline"})),(0,i.kt)("h2",{id:"go-to-parent-code-lenses"},"Go to parent code lenses"),(0,i.kt)("p",null,"Metals has the ability to display code lenses that, when invoked,\nwill go to the parent class that contains the definition of the method or symbol.\nUnfortunately, it might cause some lag in larger code bases,\nwhich is why it is not enabled currently by default."),(0,i.kt)("p",null,"To enable the feature you need to modify the setting ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.superMethodLensesEnabled")," to ",(0,i.kt)("inlineCode",{parentName:"p"},"true"),"."),(0,i.kt)("p",null,"Even without using the code lenses it's still possible to navigate the method hierarchy\nusing two commands:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"Metals: Go to super method")," - immediately goes to the parent of the method the cursor is pointing to")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"Metals: Reveal super method hierachy")," - displays the full method hierachy and enables to move to any parent,\nit is best used with the Metals Quick Pick extension."))),(0,i.kt)("p",null,"You can also bind those commands to a shortcut."),(0,i.kt)("h2",{id:"create-new-project-from-template"},"Create new project from template"),(0,i.kt)("p",null,"It is possible using Metals to easily setup a new project using the exiting ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/foundweekends/giter8/wiki/giter8-templates"},"giter8")," templates.\nThis is an equivalent to the ",(0,i.kt)("inlineCode",{parentName:"p"},"sbt new")," command, which uses the same mechanism.\nThere is a great number of templates already available and it should be easy to find something for yourself.\nTo start the setup you can use the Metals: New Scala project command, which works as following:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Choose the template and then:"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"Use the proposed templates."),(0,i.kt)("li",{parentName:"ol"},'Choose "Discover more" and then choose from the list downloaded from the Giter8 wiki page.'),(0,i.kt)("li",{parentName:"ol"},"Input a custom Github repository following the ",(0,i.kt)("inlineCode",{parentName:"li"},"organization/repo")," schema."))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Navigate to the parent directory that you want to create your new project in.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Choose the name or accept the default one.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Choose whether to open a new window for the created project or use the existing one."))),(0,i.kt)("p",null,'The same command will be invoked when clicking the "New Scala Project" button in the Metals view.'),(0,i.kt)("p",null,"If you feel like a template should be included in the default displayed ones do not hesitate to create a\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/scalameta/metals/blob/cda5b8c2029e5f201fb8d0636e0365d796407bd9/metals/src/main/scala/scala/meta/internal/builds/NewProjectProvider.scala#L308"},"PR"),"\nor file an issue."),(0,i.kt)("h2",{id:"running-and-debugging-your-code"},"Running and debugging your code"),(0,i.kt)("p",null,"Metals supports running and debugging tests and main methods via the\n",(0,i.kt)("a",{parentName:"p",href:"https://microsoft.github.io/debug-adapter-protocol/"},"Debug Adapter Protocol"),".\nThe protocol is used to communicate between the editor and debugger, which means\nthat applications can be run the same as for any other language in the natively\nsupported ",(0,i.kt)("inlineCode",{parentName:"p"},"Run")," view. When using Metals the debugger itself is\n",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/bloop/"},"Bloop"),", which is also responsible for\nstarting the actual process."),(0,i.kt)("p",null,"Users can begin the debugging session in two ways:"),(0,i.kt)("h3",{id:"via-code-lenses"},"via code lenses"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/5nTnrcS.png",alt:"lenses"})),(0,i.kt)("p",null,"For each main or test class Metals shows two code lenses ",(0,i.kt)("inlineCode",{parentName:"p"},"run | debug")," or\n",(0,i.kt)("inlineCode",{parentName:"p"},"test | test debug"),", which show up above the definition as a kind of virtual\ntext. Clicking ",(0,i.kt)("inlineCode",{parentName:"p"},"run")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"test")," will start running the main class or test without\nstopping at any breakpoints, while clicking ",(0,i.kt)("inlineCode",{parentName:"p"},"debug")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"test debug")," will pause\nonce any of them are hit. It's not possible to add any arguments or java\nproperties when running using this method."),(0,i.kt)("h3",{id:"via-a-launchjson-configuration"},"via a ",(0,i.kt)("inlineCode",{parentName:"h3"},"launch.json")," configuration"),(0,i.kt)("p",null,"Visual Studio Code uses ",(0,i.kt)("inlineCode",{parentName:"p"},".vscode/launch.json")," to store user defined\nconfigurations, which can be run using:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"The ",(0,i.kt)("inlineCode",{parentName:"li"},"Run -> Start Debugging")," menu item or ",(0,i.kt)("inlineCode",{parentName:"li"},"workbench.action.debug.start"),"\nshortcut."),(0,i.kt)("li",{parentName:"ul"},"The ",(0,i.kt)("inlineCode",{parentName:"li"},"Run -> Run Without Debugging")," menu item or ",(0,i.kt)("inlineCode",{parentName:"li"},"workbench.action.debug.run"),"\nshortcut.")),(0,i.kt)("p",null,"If a user doesn't have anything yet saved, a configuration wizard will pop up to\nguide them. In the end users should end up with something like this:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "version": "0.2.0",\n "configurations": [\n // Main class configuration\n {\n "type": "scala",\n "request": "launch",\n // configuration name visible for the user\n "name": "Launch Main",\n // full name of the class to run\n "mainClass": "com.example.Main",\n // optional arguments for the main class\n "args": [],\n // optional jvm properties to use\n "jvmOptions": []\n },\n // Test class configuration\n {\n "type": "scala",\n "request": "launch",\n // configuration name visible for the user\n "name": "Launch Test",\n // full name of the class to run\n "testClass": "com.example.Test"\n },\n // Attach debugger when running via:\n // `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=localhost:5005`\n {\n "type": "scala",\n "request": "attach",\n "name": "Attach debugger",\n // name of the module that is being debugging\n "buildTarget": "root",\n // Host of the jvm to connect to\n "hostName": "localhost",\n // Port to connect to\n "port": 5005\n }\n ]\n}\n')),(0,i.kt)("p",null,"You can also add an optional build target name, which is needed in case there\nare more than one class with the same name or when launching a class from\noutside the project. Inside ",(0,i.kt)("inlineCode",{parentName:"p"},'"configurations":')," add the key ",(0,i.kt)("inlineCode",{parentName:"p"},"buildTarget")," with\nyour target name, e.g. ",(0,i.kt)("inlineCode",{parentName:"p"},"root"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},' "buildTarget": "root"\n')),(0,i.kt)("p",null,"The build target name corresponds to your project name. For example in sbt for\n",(0,i.kt)("inlineCode",{parentName:"p"},"lazy val interfaces = project")," the name of the build target will be\n",(0,i.kt)("inlineCode",{parentName:"p"},"interfaces")," for sources and ",(0,i.kt)("inlineCode",{parentName:"p"},"interfaces-test")," for tests. To make sure you have\nthe correct target names please run the command ",(0,i.kt)("inlineCode",{parentName:"p"},"Metals: Run Doctor"),"."),(0,i.kt)("p",null,"Multiple configurations can be stored in that file and can be chosen either\nmanually in the ",(0,i.kt)("inlineCode",{parentName:"p"},"Run")," view or can be picked by invoking a shortcut defined under\n",(0,i.kt)("inlineCode",{parentName:"p"},"workbench.action.debug.selectandstart"),"."),(0,i.kt)("h3",{id:"via-metals-commands"},"via Metals' commands"),(0,i.kt)("p",null,"You can also use commands that can be easily bound to shortcuts:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"metals.run-current-file")," - Run main class in the current file."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"metals.test-current-file")," - Run test class in the current file"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"metals.test-current-target")," - Run all tests in the current project.")),(0,i.kt)("p",null,"To assign shortcuts just go to the Keyboard Shortcuts page (",(0,i.kt)("inlineCode",{parentName:"p"},"File")," ->\n",(0,i.kt)("inlineCode",{parentName:"p"},"Preferences")," -> ",(0,i.kt)("inlineCode",{parentName:"p"},"Keyboard Shortcuts"),") and search for a command, click on it and\nuse your preferred shortcut."),(0,i.kt)("h2",{id:"on-type-formatting-for-multiline-string-formatting"},"On type formatting for multiline string formatting"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://imgur.com/a0O2vCs.gif",alt:"on-type"})),(0,i.kt)("p",null,"To properly support adding ",(0,i.kt)("inlineCode",{parentName:"p"},"|")," in multiline strings we are using the\n",(0,i.kt)("inlineCode",{parentName:"p"},"onTypeFormatting")," method. The functionality is enabled by default, but you can\ndisable/enable ",(0,i.kt)("inlineCode",{parentName:"p"},"onTypeFormatting")," inside Visual Studio Code settings by checking\n",(0,i.kt)("inlineCode",{parentName:"p"},"Editor: Format On Type"),":"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/s6nT9rC.png",alt:"on-type-setting"})),(0,i.kt)("h2",{id:"formatting-on-paste-for-multiline-strings"},"Formatting on paste for multiline strings"),(0,i.kt)("p",null,"Whenever text is paste into a multiline string with ",(0,i.kt)("inlineCode",{parentName:"p"},"|")," it will be properly\nformatted by Metals:"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/fF0XWYC.gif",alt:"format-on-paste"})),(0,i.kt)("p",null,"This feature is enabled by default. If you need to disable/enable formatting on\npaste in Visual Studio Code you can check the ",(0,i.kt)("inlineCode",{parentName:"p"},"Editor: Format On Paste")," setting:"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/rMrk27F.png",alt:"format-on-paste-setting"})),(0,i.kt)("h2",{id:"worksheets"},"Worksheets"),(0,i.kt)("p",null,"Worksheets are a great way to explore an api, try out an idea, or code\nup an example and quickly see the evaluated expression or result. Behind\nthe scenes worksheets are powered by the great work done in\n",(0,i.kt)("a",{parentName:"p",href:"https://scalameta.org/mdoc/"},"mdoc"),"."),(0,i.kt)("h3",{id:"getting-started-with-worksheets"},"Getting started with Worksheets"),(0,i.kt)("p",null,"To get started with a worksheet you can either use the ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.new-scala-file"),"\ncommand and select ",(0,i.kt)("em",{parentName:"p"},"Worksheet")," or create a file called ",(0,i.kt)("inlineCode",{parentName:"p"},"*.worksheet.sc"),".\nThis format is important since this is what tells Metals that it's meant to be\ntreated as a worksheet and not just a Scala script. Where you create the\nscript also matters. If you'd like to use classes and values from your\nproject, you need to make sure the worksheet is created inside of your ",(0,i.kt)("inlineCode",{parentName:"p"},"src"),"\ndirectory. You can still create a worksheet in other places, but you will\nonly have access to the standard library and your dependencies."),(0,i.kt)("h3",{id:"evaluations"},"Evaluations"),(0,i.kt)("p",null,"After saving you'll see the result of the expression as a decoration at the end of the line.\nYou may not see the full result for example if it's too long, so you are also\nable to hover on the decoration to expand the decoration."),(0,i.kt)("p",null,"Keep in mind that you don't need to wrap your code in an ",(0,i.kt)("inlineCode",{parentName:"p"},"object"),". In worksheets\neverything can be evaluated at the top level."),(0,i.kt)("h3",{id:"using-dependencies-in-worksheets"},"Using dependencies in worksheets"),(0,i.kt)("p",null,"You are able to include an external dependency in your worksheet by including\nit in one of the following two ways."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-scala"},"// $dep.`organisation`::artifact:version` style\nimport $dep.`com.lihaoyi::scalatags:0.7.0`\n\n// $ivy.`organisation::artifact:version` style\nimport $ivy.`com.lihaoyi::scalatags:0.7.0`\n")),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"::")," is the same as ",(0,i.kt)("inlineCode",{parentName:"p"},"%%")," in sbt, which will append the current Scala binary version\nto the artifact name."),(0,i.kt)("p",null,"You can also import ",(0,i.kt)("inlineCode",{parentName:"p"},"scalac")," options in a special ",(0,i.kt)("inlineCode",{parentName:"p"},"$scalac")," import like below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-scala"},"import $scalac.`-Ywarn-unused`\n")),(0,i.kt)("h3",{id:"troubleshooting"},"Troubleshooting"),(0,i.kt)("p",null,"Since worksheets are not standard Scala files, you may run into issues with some constructs.\nFor example, you may see an error like this:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"value classes may not be a member of another class - mdoc\n")),(0,i.kt)("p",null,"This means that one of the classes defined in the worksheet extends AnyVal, which is\nnot currently supported. You can work around this by moving the class to a separate file or removing\nthe AnyVal parent."),(0,i.kt)("h2",{id:"running-scalafix-rules"},"Running scalafix rules"),(0,i.kt)("p",null,"Scalafix allows users to specify some refactoring and linting rules that can be applied to your\ncodebase. Please checkout the ",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix"},"scalafix website")," for more information."),(0,i.kt)("p",null,"Since Metals v0.11.7 it's now possible to run scalafix rules using a special\ncommand ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.scalafix-run"),". In VS Code can be also run using the default shortcut of ",(0,i.kt)("inlineCode",{parentName:"p"},"shift + alt + ctrl + o"),".\nThis should run all the rules defined in your ",(0,i.kt)("inlineCode",{parentName:"p"},".scalafix.conf")," file. All built-in rules\nand the ",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix/docs/rules/community-rules.html#hygiene-rules"},"community hygiene ones")," can\nbe run without any additional settings. However, for all the other rules users need to\nadd an additional dependency in the ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.scalafixRulesDependencies")," user setting.\nThose rules need to be in form of strings such as ",(0,i.kt)("inlineCode",{parentName:"p"},"com.github.liancheng::organize-imports:0.6.0"),", which\nfollows the same convention as ",(0,i.kt)("a",{parentName:"p",href:"https://get-coursier.io/"},"coursier dependencies"),"."),(0,i.kt)("p",null,"A sample scalafix configuration can be seen below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-hocon"},'rules = [\n OrganizeImports,\n ExplicitResultTypes,\n RemoveUnused\n]\n\nRemoveUnused.imports = false\n\nOrganizeImports.groupedImports = Explode\nOrganizeImports.expandRelative = true\nOrganizeImports.removeUnused = true\nOrganizeImports.groups = [\n "re:javax?\\."\n "scala."\n "scala.meta."\n "*"\n]\n\n')),(0,i.kt)("h2",{id:"searching-a-symbol-in-the-workspace"},"Searching a symbol in the workspace"),(0,i.kt)("p",null,'Metals provides an alternative command to the native "Go to symbol in workspace..." command, in order to work around some VS Code limitations (see ',(0,i.kt)("a",{parentName:"p",href:"https://github.com/microsoft/vscode/issues/98125"},"this issue")," for more context) and provide richer search capabilities."),(0,i.kt)("p",null,'You can invoke this command from the command palette (look for "Metals: Search symbol in workspace").\nOptionally you can also bind this command to a shortcut. For example, if you want to replace the native command with the Metals one you can configure this shortcut:'),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},' {\n "key": "ctrl+t", // or "cmd+t" if you\'re on macOS\n "command": "metals.symbol-search",\n "when": "editorLangId == scala"\n }\n')),(0,i.kt)("h2",{id:"test-explorer"},"Test Explorer"),(0,i.kt)("p",null,"Metals 0.11.0 implements Visual Studio Code's ",(0,i.kt)("a",{parentName:"p",href:"https://code.visualstudio.com/api/extension-guides/testing"},"Testing API"),". "),(0,i.kt)("p",null,"Test Explorer UI is a new default way to run/debug test suites and replaces Code\nLenses. The new UI adds a testing view, which shows all test suites declared in\nproject's modules. From this panel it's possible to"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"view all discovered test suites grouped by build targets (modules) and filter them"),(0,i.kt)("li",{parentName:"ul"},"run/debug test"),(0,i.kt)("li",{parentName:"ul"},"navigate to test's definition.")),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/Z3VtS0O.gif",alt:"test-explorer"})),(0,i.kt)("p",null,"NOTE: While Metals detects test suites for most of existing testing\nframeworks, support for recognizing individual tests is more limited.\nMetals supports the current set of test frameworks when it comes to\nindividual test discovery:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Junit"),(0,i.kt)("li",{parentName:"ul"},"MUnit"),(0,i.kt)("li",{parentName:"ul"},"ScalatestIf you encounter an error, create an ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/scalameta/metals/issues"},"issue"),".")),(0,i.kt)("h2",{id:"coming-from-intellij"},"Coming from IntelliJ"),(0,i.kt)("p",null,"Install the\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=k--kato.intellij-idea-keybindings"},"IntelliJ IDEA Keybindings"),"\nextension to use default IntelliJ shortcuts with VS Code."),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:null},"IntelliJ"),(0,i.kt)("th",{parentName:"tr",align:null},"VS Code"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Go to class"),(0,i.kt)("td",{parentName:"tr",align:null},"Go to symbol in workspace")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Parameter info"),(0,i.kt)("td",{parentName:"tr",align:null},"Trigger parameter hints")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Basic completion"),(0,i.kt)("td",{parentName:"tr",align:null},"Trigger suggest")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Type info"),(0,i.kt)("td",{parentName:"tr",align:null},"Show hover")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Expand"),(0,i.kt)("td",{parentName:"tr",align:null},"Fold")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Extend Selection"),(0,i.kt)("td",{parentName:"tr",align:null},"Expand selection")))),(0,i.kt)("h2",{id:"github-codespaces-and-githubdev-support"},"GitHub Codespaces and GitHub.dev support"),(0,i.kt)("p",null,"See ",(0,i.kt)("a",{parentName:"p",href:"https://scalameta.org/metals/docs/editors/online-ides#github-codespaces-and-githubdev"},"https://scalameta.org/metals/docs/editors/online-ides#github-codespaces-and-githubdev")))}h.isMDXComponent=!0}}]);
\ No newline at end of file
+"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[6561],{3905:(e,t,n)=>{n.d(t,{Zo:()=>u,kt:()=>h});var a=n(7294);function o(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function i(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function r(e){for(var t=1;t=0||(o[n]=e[n]);return o}(e,t);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(o[n]=e[n])}return o}var s=a.createContext({}),p=function(e){var t=a.useContext(s),n=t;return e&&(n="function"==typeof e?e(t):r(r({},t),e)),n},u=function(e){var t=p(e.components);return a.createElement(s.Provider,{value:t},e.children)},d="mdxType",m={inlineCode:"code",wrapper:function(e){var t=e.children;return a.createElement(a.Fragment,{},t)}},c=a.forwardRef((function(e,t){var n=e.components,o=e.mdxType,i=e.originalType,s=e.parentName,u=l(e,["components","mdxType","originalType","parentName"]),d=p(n),c=o,h=d["".concat(s,".").concat(c)]||d[c]||m[c]||i;return n?a.createElement(h,r(r({ref:t},u),{},{components:n})):a.createElement(h,r({ref:t},u))}));function h(e,t){var n=arguments,o=t&&t.mdxType;if("string"==typeof e||o){var i=n.length,r=new Array(i);r[0]=c;var l={};for(var s in t)hasOwnProperty.call(t,s)&&(l[s]=t[s]);l.originalType=e,l[d]="string"==typeof e?e:o,r[1]=l;for(var p=2;p{n.r(t),n.d(t,{assets:()=>u,contentTitle:()=>s,default:()=>h,frontMatter:()=>l,metadata:()=>p,toc:()=>d});var a=n(7462),o=n(3366),i=(n(7294),n(3905)),r=["components"],l={id:"vscode",sidebar_label:"VS Code",title:"Visual Studio Code"},s=void 0,p={unversionedId:"editors/vscode",id:"editors/vscode",title:"Visual Studio Code",description:"Goto Definition",source:"@site/target/docs/editors/vscode.md",sourceDirName:"editors",slug:"/editors/vscode",permalink:"/metals/docs/editors/vscode",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/vscode.md",tags:[],version:"current",frontMatter:{id:"vscode",sidebar_label:"VS Code",title:"Visual Studio Code"},sidebar:"docs",previous:{title:"Overview",permalink:"/metals/docs/"},next:{title:"Vim",permalink:"/metals/docs/editors/vim"}},u={},d=[{value:"Requirements",id:"requirements",level:2},{value:"Installation",id:"installation",level:2},{value:"Importing a build",id:"importing-a-build",level:2},{value:"Custom sbt launcher",id:"custom-sbt-launcher",level:3},{value:"Speeding up import",id:"speeding-up-import",level:3},{value:"Importing changes",id:"importing-changes",level:3},{value:"Manually trigger build import",id:"manually-trigger-build-import",level:3},{value:"Run doctor",id:"run-doctor",level:2},{value:"Configure Java version",id:"configure-java-version",level:2},{value:"macOS",id:"macos",level:3},{value:"Custom artifact repositories (Maven or Ivy resolvers)",id:"custom-artifact-repositories-maven-or-ivy-resolvers",level:2},{value:"HTTP proxy",id:"http-proxy",level:2},{value:'Using latest Metals SNAPSHOT',id:"using-latest-metals-snapshot",level:2},{value:"Files and Directories to include in your Gitignore",id:"files-and-directories-to-include-in-your-gitignore",level:2},{value:"Show document symbols",id:"show-document-symbols",level:2},{value:"Go to parent code lenses",id:"go-to-parent-code-lenses",level:2},{value:"Create new project from template",id:"create-new-project-from-template",level:2},{value:"Running and debugging your code",id:"running-and-debugging-your-code",level:2},{value:"via code lenses",id:"via-code-lenses",level:3},{value:"via a launch.json configuration",id:"via-a-launchjson-configuration",level:3},{value:"via Metals' commands",id:"via-metals-commands",level:3},{value:"On type formatting for multiline string formatting",id:"on-type-formatting-for-multiline-string-formatting",level:2},{value:"Formatting on paste for multiline strings",id:"formatting-on-paste-for-multiline-strings",level:2},{value:"Worksheets",id:"worksheets",level:2},{value:"Getting started with Worksheets",id:"getting-started-with-worksheets",level:3},{value:"Evaluations",id:"evaluations",level:3},{value:"Using dependencies in worksheets",id:"using-dependencies-in-worksheets",level:3},{value:"Troubleshooting",id:"troubleshooting",level:3},{value:"Running scalafix rules",id:"running-scalafix-rules",level:2},{value:"Searching a symbol in the workspace",id:"searching-a-symbol-in-the-workspace",level:2},{value:"Test Explorer",id:"test-explorer",level:2},{value:"Coming from IntelliJ",id:"coming-from-intellij",level:2},{value:"GitHub Codespaces and GitHub.dev support",id:"github-codespaces-and-githubdev-support",level:2}],m={toc:d},c="wrapper";function h(e){var t=e.components,n=(0,o.Z)(e,r);return(0,i.kt)(c,(0,a.Z)({},m,n,{components:t,mdxType:"MDXLayout"}),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/48776422-1f764f00-ecd0-11e8-96d1-170f2354d50e.gif",alt:"Goto Definition"})),(0,i.kt)("h2",{id:"requirements"},"Requirements"),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Java 8, 11, 17 provided by OpenJDK or Oracle"),". Eclipse OpenJ9 is not\nsupported, please make sure the ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable\npoints to a valid Java 8, 11 or 17 installation."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"macOS, Linux or Windows"),". Metals is developed on many operating systems and\nevery PR is tested on Ubuntu, Windows and MacOS."),(0,i.kt)("p",null,(0,i.kt)("strong",{parentName:"p"},"Scala 2.13, 2.12, 2.11 and Scala 3"),". Metals supports these Scala versions:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 2.13"),":\n2.13.12, 2.13.11, 2.13.10, 2.13.9, 2.13.8, 2.13.7, 2.13.6, 2.13.5")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 2.12"),":\n2.12.18, 2.12.17, 2.12.16, 2.12.15, 2.12.14, 2.12.13, 2.12.12, 2.12.11")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 2.11"),":\n2.11.12")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("strong",{parentName:"p"},"Scala 3"),":\n3.3.1, 3.3.0, 3.2.2, 3.2.1, 3.2.0, 3.1.3, 3.1.2, 3.1.1, 3.1.0"))),(0,i.kt)("p",null,"Note that 2.11.x support is deprecated and it will be removed in future releases.\nIt's recommended to upgrade to Scala 2.12 or Scala 2.13"),(0,i.kt)("h2",{id:"installation"},"Installation"),(0,i.kt)("p",null,"Install the Metals extension from the\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=scalameta.metals"},"Marketplace")," by clicking on this badge ",(0,i.kt)("a",{parentName:"p",href:"vscode:extension/scalameta.metals"},(0,i.kt)("img",{parentName:"a",src:"https://img.shields.io/badge/metals-vscode-blue.png",alt:"Install Metals extension"}))," or via the VS Code editor:"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://imgur.com/Qew0fNH.png",alt:"install stable version"})),(0,i.kt)("blockquote",null,(0,i.kt)("p",{parentName:"blockquote"},"Make sure to disable the extensions\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=dragos.scala-lsp"},"Scala Language Server"),"\nand\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=lightbend.vscode-sbt-scala"},"Scala (sbt)"),"\nif they are installed. The\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=lampepfl.dotty"},"Dotty Language Server"),"\ndoes ",(0,i.kt)("strong",{parentName:"p"},"not")," need to be disabled because the Metals and Dotty extensions don't\nconflict with each other. However, if you want to work on Scala 3 code in a\nworkspace that was previously opened with ",(0,i.kt)("inlineCode",{parentName:"p"},"Dotty Language Server")," you need to\nfirst remove ",(0,i.kt)("inlineCode",{parentName:"p"},".dotty-ide-artifact")," before opening the workspace with Metals.")),(0,i.kt)("p",null,"Next, open a directory containing your Scala code. The extension activates when\nthe main directory contains ",(0,i.kt)("inlineCode",{parentName:"p"},"build.sbt")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"build.sc")," file, a Scala file is\nopened, which includes ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sbt"),", ",(0,i.kt)("inlineCode",{parentName:"p"},"*.scala")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sc")," file, or a standard Scala\ndirectory structure ",(0,i.kt)("inlineCode",{parentName:"p"},"src/main/scala")," is detected."),(0,i.kt)("p",null,"It is also possible to opt in to install the pre-release version and try out the latest cutting edge features from Metals server.\nApart from new features, pre-release versions also include many bugfixes. It's encouraged to use them with ",(0,i.kt)("a",{parentName:"p",href:"#SNAPSHOT"},"SNAPSHOT")," releases of Metals server. Using pre-release versions may result in less stable experience and it is not indented for beginners.\nPre-release versions follow ",(0,i.kt)("inlineCode",{parentName:"p"},"major.minor.PATCH")," versioning."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://imgur.com/CzOTleE.png",alt:"Install the pre-release extension"})),(0,i.kt)("h2",{id:"importing-a-build"},"Importing a build"),(0,i.kt)("p",null,'The first time you open Metals in a new workspace it prompts you to import the build.\nClick "Import build" to start the installation step.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/0VqZWay.png",alt:"Import build"})),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},'"Not now" disables this prompt for 2 minutes.'),(0,i.kt)("li",{parentName:"ul"},'"Don\'t show again" disables this prompt forever, use ',(0,i.kt)("inlineCode",{parentName:"li"},"rm -rf .metals/")," to re-enable\nthe prompt."),(0,i.kt)("li",{parentName:"ul"},"Use ",(0,i.kt)("inlineCode",{parentName:"li"},"tail -f .metals/metals.log")," to watch the build import progress."),(0,i.kt)("li",{parentName:"ul"},"Behind the scenes, Metals uses ",(0,i.kt)("a",{parentName:"li",href:"https://scalacenter.github.io/bloop/"},"Bloop")," to\nimport sbt builds, but you don't need Bloop installed on your machine to run this step.")),(0,i.kt)("p",null,"Once the import step completes, compilation starts for your open ",(0,i.kt)("inlineCode",{parentName:"p"},"*.scala"),"\nfiles."),(0,i.kt)("p",null,"Once the sources have compiled successfully, you can navigate the codebase with\ngoto definition."),(0,i.kt)("h3",{id:"custom-sbt-launcher"},"Custom sbt launcher"),(0,i.kt)("p",null,"By default, Metals runs an embedded ",(0,i.kt)("inlineCode",{parentName:"p"},"sbt-launch.jar")," launcher that respects ",(0,i.kt)("inlineCode",{parentName:"p"},".sbtopts")," and ",(0,i.kt)("inlineCode",{parentName:"p"},".jvmopts"),".\nHowever, the environment variables ",(0,i.kt)("inlineCode",{parentName:"p"},"SBT_OPTS")," and ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_OPTS")," are not respected."),(0,i.kt)("p",null,'Update the "Sbt Script" setting to use a custom ',(0,i.kt)("inlineCode",{parentName:"p"},"sbt")," script instead of the\ndefault Metals launcher if you need further customizations like reading environment\nvariables."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/NuwEBe4.png",alt:"Sbt Launcher"})),(0,i.kt)("h3",{id:"speeding-up-import"},"Speeding up import"),(0,i.kt)("p",null,'The "Import build" step can take a long time, especially the first time you\nrun it in a new build. The exact time depends on the complexity of the build and\nif library dependencies need to be downloaded. For example, this step can take\neverything from 10 seconds in small cached builds up to 10-15 minutes in large\nuncached builds.'),(0,i.kt)("p",null,"Consult the ",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/bloop/docs/build-tools/sbt#speeding-up-build-export"},"Bloop documentation"),"\nto learn how to speed up build import."),(0,i.kt)("h3",{id:"importing-changes"},"Importing changes"),(0,i.kt)("p",null,"When you change ",(0,i.kt)("inlineCode",{parentName:"p"},"build.sbt")," or sources under ",(0,i.kt)("inlineCode",{parentName:"p"},"project/"),", you will be prompted to\nre-import the build."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/72kdZkL.png",alt:"Import sbt changes"})),(0,i.kt)("h3",{id:"manually-trigger-build-import"},"Manually trigger build import"),(0,i.kt)("p",null,'To manually trigger a build import, execute the "Import build" command through\nthe command palette (',(0,i.kt)("inlineCode",{parentName:"p"},"Cmd + Shift + P"),")."),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/QHLKt8u.png",alt:"Import build command"})),(0,i.kt)("h2",{id:"run-doctor"},"Run doctor"),(0,i.kt)("p",null,'Execute the "Run Doctor" through the command palette to troubleshoot potential\nconfiguration problems in your workspace.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/K02g0UM.png",alt:"Run doctor command"})),(0,i.kt)("h2",{id:"configure-java-version"},"Configure Java version"),(0,i.kt)("p",null,"The VS Code plugin uses by default the ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable (via\n",(0,i.kt)("a",{parentName:"p",href:"https://www.npmjs.com/package/locate-java-home"},(0,i.kt)("inlineCode",{parentName:"a"},"locate-java-home")),") to locate\nthe ",(0,i.kt)("inlineCode",{parentName:"p"},"java"),' executable. To override the default Java home location, update the\n"Java Home" variable in the settings menu.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/sKrPKk2.png",alt:"Java Home setting"})),(0,i.kt)("p",null,"If this setting is defined, the VS Code plugin uses the custom path instead of\nthe ",(0,i.kt)("inlineCode",{parentName:"p"},"JAVA_HOME")," environment variable."),(0,i.kt)("h3",{id:"macos"},"macOS"),(0,i.kt)("p",null,"To globally configure ",(0,i.kt)("inlineCode",{parentName:"p"},"$JAVA_HOME")," for all GUI applications, see\n",(0,i.kt)("a",{parentName:"p",href:"https://stackoverflow.com/questions/135688/setting-environment-variables-on-os-x"},"this Stackoverflow answer"),"."),(0,i.kt)("p",null,"If you prefer to manually configure Java home through VS Code, run the following\ncommand to copy the Java 8 home path."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"/usr/libexec/java_home -v 1.8 | pbcopy\n")),(0,i.kt)("h2",{id:"custom-artifact-repositories-maven-or-ivy-resolvers"},"Custom artifact repositories (Maven or Ivy resolvers)"),(0,i.kt)("p",null,"Use the 'Custom Repositories' setting for the Metals VS Code extension to tell\n",(0,i.kt)("a",{parentName:"p",href:"https://get-coursier.io/docs/other-proxy"},"Coursier")," to try to download Metals\nartifacts from your private artifact repository."),(0,i.kt)("p",null,"Use ",(0,i.kt)("inlineCode",{parentName:"p"},".jvmopts")," to set sbt options\n(",(0,i.kt)("a",{parentName:"p",href:"https://www.scala-sbt.org/1.0/docs/Proxy-Repositories.html"},"https://www.scala-sbt.org/1.0/docs/Proxy-Repositories.html"),") for\n",(0,i.kt)("inlineCode",{parentName:"p"},"sbt bloopInstall")," which resolves library dependencies. You can also provide a\ncustom sbt script (see 'Custom sbt launcher')."),(0,i.kt)("h2",{id:"http-proxy"},"HTTP proxy"),(0,i.kt)("p",null,"Metals uses ",(0,i.kt)("a",{parentName:"p",href:"https://get-coursier.io/docs/other-proxy"},"Coursier")," to download\nartifacts from Maven Central. To use Metals behind an HTTP proxy, configure the\nsystem properties ",(0,i.kt)("inlineCode",{parentName:"p"},"-Dhttps.proxyHost=\u2026 -Dhttps.proxyPort=\u2026")," in one of the\nfollowing locations:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},".jvmopts")," file in the workspace directory."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"JAVA_OPTS")," environment variable, make sure to start ",(0,i.kt)("inlineCode",{parentName:"li"},"code")," from your terminal\nwhen using this option since environment variables don't always propagate\ncorrectly when opening VS Code as a GUI application outside a terminal."),(0,i.kt)("li",{parentName:"ul"},'"Server Properties" setting for the Metals VS Code extension, which can be\nconfigured per-workspace or per-user.')),(0,i.kt)("h2",{id:"using-latest-metals-snapshot"},"Using latest Metals ",(0,i.kt)("a",{name:"SNAPSHOT"},"SNAPSHOT")),(0,i.kt)("p",null,'Update the "Server Version" setting to try out the latest pending Metals\nfeatures.'),(0,i.kt)("table",null,(0,i.kt)("thead",null,(0,i.kt)("tr",null,(0,i.kt)("th",null,"Version"),(0,i.kt)("th",null,"Published"))),(0,i.kt)("tbody",null,(0,i.kt)("tr",null,(0,i.kt)("td",null,"1.0.1"),(0,i.kt)("td",null,"28 Aug 2023 14:46")),(0,i.kt)("tr",null,(0,i.kt)("td",null,"1.0.1+61-abcc0e5c-SNAPSHOT"),(0,i.kt)("td",null,"01 Oct 2023 17:00")))),'Run the "Reload Window" command after updating the setting for the new version to take effect.',(0,i.kt)("h2",{id:"files-and-directories-to-include-in-your-gitignore"},"Files and Directories to include in your Gitignore"),(0,i.kt)("p",null,"The Metals server places logs and other files in the ",(0,i.kt)("inlineCode",{parentName:"p"},".metals")," directory. The\nBloop compile server places logs and compilation artifacts in the ",(0,i.kt)("inlineCode",{parentName:"p"},".bloop"),"\ndirectory. The Bloop plugin that generates Bloop configuration is added in the\n",(0,i.kt)("inlineCode",{parentName:"p"},"metals.sbt")," file, which is added at ",(0,i.kt)("inlineCode",{parentName:"p"},"project/metals.sbt")," as well as further\n",(0,i.kt)("inlineCode",{parentName:"p"},"project")," directories depending on how deep ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sbt")," files need to be supported.\nTo support each ",(0,i.kt)("inlineCode",{parentName:"p"},"*.sbt")," file Metals needs to create an additional file at\n",(0,i.kt)("inlineCode",{parentName:"p"},"./project/project/metals.sbt")," relative to the sbt file.\nWorking with Ammonite scripts will place compiled scripts into the ",(0,i.kt)("inlineCode",{parentName:"p"},".ammonite")," directory.\nIt's recommended to exclude these directories and files\nfrom version control systems like git."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-sh"},"# ~/.gitignore\n.metals/\n.bloop/\n.ammonite/\nmetals.sbt\n")),(0,i.kt)("h2",{id:"show-document-symbols"},"Show document symbols"),(0,i.kt)("p",null,'Run the "Explorer: Focus on Outline View" command to open the symbol outline for\nthe current file in the sidebar.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/T0kVJsr.gif",alt:"Document Symbols Outline"})),(0,i.kt)("p",null,'Run the "Open Symbol in File" command to search for a symbol in the current file\nwithout opening the sidebar.'),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/0PJ4brd.png",alt:"Document Symbols Command"})),(0,i.kt)("p",null,"As you type, the symbol outline is also visible at the top of the file.\n",(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/L217n4q.png",alt:"Document Symbols Outline"})),(0,i.kt)("h2",{id:"go-to-parent-code-lenses"},"Go to parent code lenses"),(0,i.kt)("p",null,"Metals has the ability to display code lenses that, when invoked,\nwill go to the parent class that contains the definition of the method or symbol.\nUnfortunately, it might cause some lag in larger code bases,\nwhich is why it is not enabled currently by default."),(0,i.kt)("p",null,"To enable the feature you need to modify the setting ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.superMethodLensesEnabled")," to ",(0,i.kt)("inlineCode",{parentName:"p"},"true"),"."),(0,i.kt)("p",null,"Even without using the code lenses it's still possible to navigate the method hierarchy\nusing two commands:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"Metals: Go to super method")," - immediately goes to the parent of the method the cursor is pointing to")),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("p",{parentName:"li"},(0,i.kt)("inlineCode",{parentName:"p"},"Metals: Reveal super method hierachy")," - displays the full method hierachy and enables to move to any parent,\nit is best used with the Metals Quick Pick extension."))),(0,i.kt)("p",null,"You can also bind those commands to a shortcut."),(0,i.kt)("h2",{id:"create-new-project-from-template"},"Create new project from template"),(0,i.kt)("p",null,"It is possible using Metals to easily setup a new project using the exiting ",(0,i.kt)("a",{parentName:"p",href:"https://github.com/foundweekends/giter8/wiki/giter8-templates"},"giter8")," templates.\nThis is an equivalent to the ",(0,i.kt)("inlineCode",{parentName:"p"},"sbt new")," command, which uses the same mechanism.\nThere is a great number of templates already available and it should be easy to find something for yourself.\nTo start the setup you can use the Metals: New Scala project command, which works as following:"),(0,i.kt)("ol",null,(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Choose the template and then:"),(0,i.kt)("ol",{parentName:"li"},(0,i.kt)("li",{parentName:"ol"},"Use the proposed templates."),(0,i.kt)("li",{parentName:"ol"},'Choose "Discover more" and then choose from the list downloaded from the Giter8 wiki page.'),(0,i.kt)("li",{parentName:"ol"},"Input a custom Github repository following the ",(0,i.kt)("inlineCode",{parentName:"li"},"organization/repo")," schema."))),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Navigate to the parent directory that you want to create your new project in.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Choose the name or accept the default one.")),(0,i.kt)("li",{parentName:"ol"},(0,i.kt)("p",{parentName:"li"},"Choose whether to open a new window for the created project or use the existing one."))),(0,i.kt)("p",null,'The same command will be invoked when clicking the "New Scala Project" button in the Metals view.'),(0,i.kt)("p",null,"If you feel like a template should be included in the default displayed ones do not hesitate to create a\n",(0,i.kt)("a",{parentName:"p",href:"https://github.com/scalameta/metals/blob/cda5b8c2029e5f201fb8d0636e0365d796407bd9/metals/src/main/scala/scala/meta/internal/builds/NewProjectProvider.scala#L308"},"PR"),"\nor file an issue."),(0,i.kt)("h2",{id:"running-and-debugging-your-code"},"Running and debugging your code"),(0,i.kt)("p",null,"Metals supports running and debugging tests and main methods via the\n",(0,i.kt)("a",{parentName:"p",href:"https://microsoft.github.io/debug-adapter-protocol/"},"Debug Adapter Protocol"),".\nThe protocol is used to communicate between the editor and debugger, which means\nthat applications can be run the same as for any other language in the natively\nsupported ",(0,i.kt)("inlineCode",{parentName:"p"},"Run")," view. When using Metals the debugger itself is\n",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/bloop/"},"Bloop"),", which is also responsible for\nstarting the actual process."),(0,i.kt)("p",null,"Users can begin the debugging session in two ways:"),(0,i.kt)("h3",{id:"via-code-lenses"},"via code lenses"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/5nTnrcS.png",alt:"lenses"})),(0,i.kt)("p",null,"For each main or test class Metals shows two code lenses ",(0,i.kt)("inlineCode",{parentName:"p"},"run | debug")," or\n",(0,i.kt)("inlineCode",{parentName:"p"},"test | test debug"),", which show up above the definition as a kind of virtual\ntext. Clicking ",(0,i.kt)("inlineCode",{parentName:"p"},"run")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"test")," will start running the main class or test without\nstopping at any breakpoints, while clicking ",(0,i.kt)("inlineCode",{parentName:"p"},"debug")," or ",(0,i.kt)("inlineCode",{parentName:"p"},"test debug")," will pause\nonce any of them are hit. It's not possible to add any arguments or java\nproperties when running using this method."),(0,i.kt)("h3",{id:"via-a-launchjson-configuration"},"via a ",(0,i.kt)("inlineCode",{parentName:"h3"},"launch.json")," configuration"),(0,i.kt)("p",null,"Visual Studio Code uses ",(0,i.kt)("inlineCode",{parentName:"p"},".vscode/launch.json")," to store user defined\nconfigurations, which can be run using:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"The ",(0,i.kt)("inlineCode",{parentName:"li"},"Run -> Start Debugging")," menu item or ",(0,i.kt)("inlineCode",{parentName:"li"},"workbench.action.debug.start"),"\nshortcut."),(0,i.kt)("li",{parentName:"ul"},"The ",(0,i.kt)("inlineCode",{parentName:"li"},"Run -> Run Without Debugging")," menu item or ",(0,i.kt)("inlineCode",{parentName:"li"},"workbench.action.debug.run"),"\nshortcut.")),(0,i.kt)("p",null,"If a user doesn't have anything yet saved, a configuration wizard will pop up to\nguide them. In the end users should end up with something like this:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},'{\n "version": "0.2.0",\n "configurations": [\n // Main class configuration\n {\n "type": "scala",\n "request": "launch",\n // configuration name visible for the user\n "name": "Launch Main",\n // full name of the class to run\n "mainClass": "com.example.Main",\n // optional arguments for the main class\n "args": [],\n // optional jvm properties to use\n "jvmOptions": []\n },\n // Test class configuration\n {\n "type": "scala",\n "request": "launch",\n // configuration name visible for the user\n "name": "Launch Test",\n // full name of the class to run\n "testClass": "com.example.Test"\n },\n // Attach debugger when running via:\n // `-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=localhost:5005`\n {\n "type": "scala",\n "request": "attach",\n "name": "Attach debugger",\n // name of the module that is being debugging\n "buildTarget": "root",\n // Host of the jvm to connect to\n "hostName": "localhost",\n // Port to connect to\n "port": 5005\n }\n ]\n}\n')),(0,i.kt)("p",null,"You can also add an optional build target name, which is needed in case there\nare more than one class with the same name or when launching a class from\noutside the project. Inside ",(0,i.kt)("inlineCode",{parentName:"p"},'"configurations":')," add the key ",(0,i.kt)("inlineCode",{parentName:"p"},"buildTarget")," with\nyour target name, e.g. ",(0,i.kt)("inlineCode",{parentName:"p"},"root"),":"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-json"},' "buildTarget": "root"\n')),(0,i.kt)("p",null,"The build target name corresponds to your project name. For example in sbt for\n",(0,i.kt)("inlineCode",{parentName:"p"},"lazy val interfaces = project")," the name of the build target will be\n",(0,i.kt)("inlineCode",{parentName:"p"},"interfaces")," for sources and ",(0,i.kt)("inlineCode",{parentName:"p"},"interfaces-test")," for tests. To make sure you have\nthe correct target names please run the command ",(0,i.kt)("inlineCode",{parentName:"p"},"Metals: Run Doctor"),"."),(0,i.kt)("p",null,"Multiple configurations can be stored in that file and can be chosen either\nmanually in the ",(0,i.kt)("inlineCode",{parentName:"p"},"Run")," view or can be picked by invoking a shortcut defined under\n",(0,i.kt)("inlineCode",{parentName:"p"},"workbench.action.debug.selectandstart"),"."),(0,i.kt)("h3",{id:"via-metals-commands"},"via Metals' commands"),(0,i.kt)("p",null,"You can also use commands that can be easily bound to shortcuts:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"metals.run-current-file")," - Run main class in the current file."),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"metals.test-current-file")," - Run test class in the current file"),(0,i.kt)("li",{parentName:"ul"},(0,i.kt)("inlineCode",{parentName:"li"},"metals.test-current-target")," - Run all tests in the current project.")),(0,i.kt)("p",null,"To assign shortcuts just go to the Keyboard Shortcuts page (",(0,i.kt)("inlineCode",{parentName:"p"},"File")," ->\n",(0,i.kt)("inlineCode",{parentName:"p"},"Preferences")," -> ",(0,i.kt)("inlineCode",{parentName:"p"},"Keyboard Shortcuts"),") and search for a command, click on it and\nuse your preferred shortcut."),(0,i.kt)("h2",{id:"on-type-formatting-for-multiline-string-formatting"},"On type formatting for multiline string formatting"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://imgur.com/a0O2vCs.gif",alt:"on-type"})),(0,i.kt)("p",null,"To properly support adding ",(0,i.kt)("inlineCode",{parentName:"p"},"|")," in multiline strings we are using the\n",(0,i.kt)("inlineCode",{parentName:"p"},"onTypeFormatting")," method. The functionality is enabled by default, but you can\ndisable/enable ",(0,i.kt)("inlineCode",{parentName:"p"},"onTypeFormatting")," inside Visual Studio Code settings by checking\n",(0,i.kt)("inlineCode",{parentName:"p"},"Editor: Format On Type"),":"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/s6nT9rC.png",alt:"on-type-setting"})),(0,i.kt)("h2",{id:"formatting-on-paste-for-multiline-strings"},"Formatting on paste for multiline strings"),(0,i.kt)("p",null,"Whenever text is paste into a multiline string with ",(0,i.kt)("inlineCode",{parentName:"p"},"|")," it will be properly\nformatted by Metals:"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/fF0XWYC.gif",alt:"format-on-paste"})),(0,i.kt)("p",null,"This feature is enabled by default. If you need to disable/enable formatting on\npaste in Visual Studio Code you can check the ",(0,i.kt)("inlineCode",{parentName:"p"},"Editor: Format On Paste")," setting:"),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/rMrk27F.png",alt:"format-on-paste-setting"})),(0,i.kt)("h2",{id:"worksheets"},"Worksheets"),(0,i.kt)("p",null,"Worksheets are a great way to explore an api, try out an idea, or code\nup an example and quickly see the evaluated expression or result. Behind\nthe scenes worksheets are powered by the great work done in\n",(0,i.kt)("a",{parentName:"p",href:"https://scalameta.org/mdoc/"},"mdoc"),"."),(0,i.kt)("h3",{id:"getting-started-with-worksheets"},"Getting started with Worksheets"),(0,i.kt)("p",null,"To get started with a worksheet you can either use the ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.new-scala-file"),"\ncommand and select ",(0,i.kt)("em",{parentName:"p"},"Worksheet")," or create a file called ",(0,i.kt)("inlineCode",{parentName:"p"},"*.worksheet.sc"),".\nThis format is important since this is what tells Metals that it's meant to be\ntreated as a worksheet and not just a Scala script. Where you create the\nscript also matters. If you'd like to use classes and values from your\nproject, you need to make sure the worksheet is created inside of your ",(0,i.kt)("inlineCode",{parentName:"p"},"src"),"\ndirectory. You can still create a worksheet in other places, but you will\nonly have access to the standard library and your dependencies."),(0,i.kt)("h3",{id:"evaluations"},"Evaluations"),(0,i.kt)("p",null,"After saving you'll see the result of the expression as a decoration at the end of the line.\nYou may not see the full result for example if it's too long, so you are also\nable to hover on the decoration to expand the decoration."),(0,i.kt)("p",null,"Keep in mind that you don't need to wrap your code in an ",(0,i.kt)("inlineCode",{parentName:"p"},"object"),". In worksheets\neverything can be evaluated at the top level."),(0,i.kt)("h3",{id:"using-dependencies-in-worksheets"},"Using dependencies in worksheets"),(0,i.kt)("p",null,"You are able to include an external dependency in your worksheet by including\nit in one of the following two ways."),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-scala"},"// $dep.`organisation`::artifact:version` style\nimport $dep.`com.lihaoyi::scalatags:0.7.0`\n\n// $ivy.`organisation::artifact:version` style\nimport $ivy.`com.lihaoyi::scalatags:0.7.0`\n")),(0,i.kt)("p",null,(0,i.kt)("inlineCode",{parentName:"p"},"::")," is the same as ",(0,i.kt)("inlineCode",{parentName:"p"},"%%")," in sbt, which will append the current Scala binary version\nto the artifact name."),(0,i.kt)("p",null,"You can also import ",(0,i.kt)("inlineCode",{parentName:"p"},"scalac")," options in a special ",(0,i.kt)("inlineCode",{parentName:"p"},"$scalac")," import like below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-scala"},"import $scalac.`-Ywarn-unused`\n")),(0,i.kt)("h3",{id:"troubleshooting"},"Troubleshooting"),(0,i.kt)("p",null,"Since worksheets are not standard Scala files, you may run into issues with some constructs.\nFor example, you may see an error like this:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre"},"value classes may not be a member of another class - mdoc\n")),(0,i.kt)("p",null,"This means that one of the classes defined in the worksheet extends AnyVal, which is\nnot currently supported. You can work around this by moving the class to a separate file or removing\nthe AnyVal parent."),(0,i.kt)("h2",{id:"running-scalafix-rules"},"Running scalafix rules"),(0,i.kt)("p",null,"Scalafix allows users to specify some refactoring and linting rules that can be applied to your\ncodebase. Please checkout the ",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix"},"scalafix website")," for more information."),(0,i.kt)("p",null,"Since Metals v0.11.7 it's now possible to run scalafix rules using a special\ncommand ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.scalafix-run"),". In VS Code can be also run using the default shortcut of ",(0,i.kt)("inlineCode",{parentName:"p"},"shift + alt + ctrl + o"),".\nThis should run all the rules defined in your ",(0,i.kt)("inlineCode",{parentName:"p"},".scalafix.conf")," file. All built-in rules\nand the ",(0,i.kt)("a",{parentName:"p",href:"https://scalacenter.github.io/scalafix/docs/rules/community-rules.html#hygiene-rules"},"community hygiene ones")," can\nbe run without any additional settings. However, for all the other rules users need to\nadd an additional dependency in the ",(0,i.kt)("inlineCode",{parentName:"p"},"metals.scalafixRulesDependencies")," user setting.\nThose rules need to be in form of strings such as ",(0,i.kt)("inlineCode",{parentName:"p"},"com.github.liancheng::organize-imports:0.6.0"),", which\nfollows the same convention as ",(0,i.kt)("a",{parentName:"p",href:"https://get-coursier.io/"},"coursier dependencies"),"."),(0,i.kt)("p",null,"A sample scalafix configuration can be seen below:"),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-hocon"},'rules = [\n OrganizeImports,\n ExplicitResultTypes,\n RemoveUnused\n]\n\nRemoveUnused.imports = false\n\nOrganizeImports.groupedImports = Explode\nOrganizeImports.expandRelative = true\nOrganizeImports.removeUnused = true\nOrganizeImports.groups = [\n "re:javax?\\."\n "scala."\n "scala.meta."\n "*"\n]\n\n')),(0,i.kt)("h2",{id:"searching-a-symbol-in-the-workspace"},"Searching a symbol in the workspace"),(0,i.kt)("p",null,'Metals provides an alternative command to the native "Go to symbol in workspace..." command, in order to work around some VS Code limitations (see ',(0,i.kt)("a",{parentName:"p",href:"https://github.com/microsoft/vscode/issues/98125"},"this issue")," for more context) and provide richer search capabilities."),(0,i.kt)("p",null,'You can invoke this command from the command palette (look for "Metals: Search symbol in workspace").\nOptionally you can also bind this command to a shortcut. For example, if you want to replace the native command with the Metals one you can configure this shortcut:'),(0,i.kt)("pre",null,(0,i.kt)("code",{parentName:"pre",className:"language-js"},' {\n "key": "ctrl+t", // or "cmd+t" if you\'re on macOS\n "command": "metals.symbol-search",\n "when": "editorLangId == scala"\n }\n')),(0,i.kt)("h2",{id:"test-explorer"},"Test Explorer"),(0,i.kt)("p",null,"Metals 0.11.0 implements Visual Studio Code's ",(0,i.kt)("a",{parentName:"p",href:"https://code.visualstudio.com/api/extension-guides/testing"},"Testing API"),". "),(0,i.kt)("p",null,"Test Explorer UI is a new default way to run/debug test suites and replaces Code\nLenses. The new UI adds a testing view, which shows all test suites declared in\nproject's modules. From this panel it's possible to"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"view all discovered test suites grouped by build targets (modules) and filter them"),(0,i.kt)("li",{parentName:"ul"},"run/debug test"),(0,i.kt)("li",{parentName:"ul"},"navigate to test's definition.")),(0,i.kt)("p",null,(0,i.kt)("img",{parentName:"p",src:"https://i.imgur.com/Z3VtS0O.gif",alt:"test-explorer"})),(0,i.kt)("p",null,"NOTE: While Metals detects test suites for most of existing testing\nframeworks, support for recognizing individual tests is more limited.\nMetals supports the current set of test frameworks when it comes to\nindividual test discovery:"),(0,i.kt)("ul",null,(0,i.kt)("li",{parentName:"ul"},"Junit"),(0,i.kt)("li",{parentName:"ul"},"MUnit"),(0,i.kt)("li",{parentName:"ul"},"ScalatestIf you encounter an error, create an ",(0,i.kt)("a",{parentName:"li",href:"https://github.com/scalameta/metals/issues"},"issue"),".")),(0,i.kt)("h2",{id:"coming-from-intellij"},"Coming from IntelliJ"),(0,i.kt)("p",null,"Install the\n",(0,i.kt)("a",{parentName:"p",href:"https://marketplace.visualstudio.com/items?itemName=k--kato.intellij-idea-keybindings"},"IntelliJ IDEA Keybindings"),"\nextension to use default IntelliJ shortcuts with VS Code."),(0,i.kt)("table",null,(0,i.kt)("thead",{parentName:"table"},(0,i.kt)("tr",{parentName:"thead"},(0,i.kt)("th",{parentName:"tr",align:null},"IntelliJ"),(0,i.kt)("th",{parentName:"tr",align:null},"VS Code"))),(0,i.kt)("tbody",{parentName:"table"},(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Go to class"),(0,i.kt)("td",{parentName:"tr",align:null},"Go to symbol in workspace")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Parameter info"),(0,i.kt)("td",{parentName:"tr",align:null},"Trigger parameter hints")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Basic completion"),(0,i.kt)("td",{parentName:"tr",align:null},"Trigger suggest")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Type info"),(0,i.kt)("td",{parentName:"tr",align:null},"Show hover")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Expand"),(0,i.kt)("td",{parentName:"tr",align:null},"Fold")),(0,i.kt)("tr",{parentName:"tbody"},(0,i.kt)("td",{parentName:"tr",align:null},"Extend Selection"),(0,i.kt)("td",{parentName:"tr",align:null},"Expand selection")))),(0,i.kt)("h2",{id:"github-codespaces-and-githubdev-support"},"GitHub Codespaces and GitHub.dev support"),(0,i.kt)("p",null,"See ",(0,i.kt)("a",{parentName:"p",href:"https://scalameta.org/metals/docs/editors/online-ides#github-codespaces-and-githubdev"},"https://scalameta.org/metals/docs/editors/online-ides#github-codespaces-and-githubdev")))}h.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/9b4a23be.38b6aaa2.js b/assets/js/9b4a23be.c05a2494.js
similarity index 99%
rename from assets/js/9b4a23be.38b6aaa2.js
rename to assets/js/9b4a23be.c05a2494.js
index 0fcdbb8b16e..8bb867fd48e 100644
--- a/assets/js/9b4a23be.38b6aaa2.js
+++ b/assets/js/9b4a23be.c05a2494.js
@@ -1 +1 @@
-"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5688],{3905:(t,e,n)=>{n.d(e,{Zo:()=>c,kt:()=>m});var l=n(7294);function i(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function r(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);e&&(l=l.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,l)}return n}function a(t){for(var e=1;e=0||(i[n]=t[n]);return i}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(l=0;l=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(i[n]=t[n])}return i}var s=l.createContext({}),d=function(t){var e=l.useContext(s),n=e;return t&&(n="function"==typeof t?t(e):a(a({},e),t)),n},c=function(t){var e=d(t.components);return l.createElement(s.Provider,{value:e},t.children)},k="mdxType",u={inlineCode:"code",wrapper:function(t){var e=t.children;return l.createElement(l.Fragment,{},e)}},p=l.forwardRef((function(t,e){var n=t.components,i=t.mdxType,r=t.originalType,s=t.parentName,c=o(t,["components","mdxType","originalType","parentName"]),k=d(n),p=i,m=k["".concat(s,".").concat(p)]||k[p]||u[p]||r;return n?l.createElement(m,a(a({ref:e},c),{},{components:n})):l.createElement(m,a({ref:e},c))}));function m(t,e){var n=arguments,i=e&&e.mdxType;if("string"==typeof t||i){var r=n.length,a=new Array(r);a[0]=p;var o={};for(var s in e)hasOwnProperty.call(e,s)&&(o[s]=e[s]);o.originalType=t,o[k]="string"==typeof t?t:i,a[1]=o;for(var d=2;d{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>m,frontMatter:()=>o,metadata:()=>d,toc:()=>k});var l=n(7462),i=n(3366),r=(n(7294),n(3905)),a=["components"],o={id:"overview",title:"Text Editors",sidebar_label:"Overview",slug:"/"},s=void 0,d={unversionedId:"editors/overview",id:"editors/overview",title:"Text Editors",description:"Latest Metals server versions",source:"@site/target/docs/editors/overview.md",sourceDirName:"editors",slug:"/",permalink:"/metals/docs/",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/overview.md",tags:[],version:"current",frontMatter:{id:"overview",title:"Text Editors",sidebar_label:"Overview",slug:"/"},sidebar:"docs",next:{title:"VS Code",permalink:"/metals/docs/editors/vscode"}},c={},k=[{value:"Latest Metals server versions",id:"latest-metals-server-versions",level:2},{value:"Editor support",id:"editor-support",level:2},{value:"Installation",id:"installation",level:2},{value:"Build import",id:"build-import",level:2},{value:"Diagnostics",id:"diagnostics",level:2},{value:"Known limitations",id:"known-limitations",level:3},{value:"Goto definition",id:"goto-definition",level:2},{value:"Known limitations",id:"known-limitations-1",level:3},{value:"Completions",id:"completions",level:2},{value:"Known limitations",id:"known-limitations-2",level:3},{value:"Hover (aka. type at point)",id:"hover-aka-type-at-point",level:2},{value:"Signature help (aka. parameter hints)",id:"signature-help-aka-parameter-hints",level:2},{value:"Find references",id:"find-references",level:2},{value:"Known limitations",id:"known-limitations-3",level:3},{value:"Worksheets",id:"worksheets",level:2},{value:"Document symbols",id:"document-symbols",level:2},{value:"Workspace symbols",id:"workspace-symbols",level:2},{value:"Formatting",id:"formatting",level:2},{value:"Code folding",id:"code-folding",level:2},{value:"Document highlight",id:"document-highlight",level:2},{value:"Package explorer",id:"package-explorer",level:2},{value:"Test Explorer",id:"test-explorer",level:2},{value:"Running Tests",id:"running-tests",level:3},{value:"Metals Extensions",id:"metals-extensions",level:2},{value:"Implicit decorations",id:"implicit-decorations",level:2},{value:"Additional file types",id:"additional-file-types",level:2}],u={toc:k},p="wrapper";function m(t){var e=t.components,n=(0,i.Z)(t,a);return(0,r.kt)(p,(0,l.Z)({},u,n,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"latest-metals-server-versions"},"Latest Metals server versions"),(0,r.kt)("p",null,"To find out how to set the version in your editor please check out the editor\nspecific sections."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("th",null,"Version"),(0,r.kt)("th",null,"Published"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1"),(0,r.kt)("td",null,"28 Aug 2023 14:46")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1+60-26f1e686-SNAPSHOT"),(0,r.kt)("td",null,"29 Sep 2023 18:42")))),"Snapshot releases are not guaranteed to work.",(0,r.kt)("h2",{id:"editor-support"},"Editor support"),(0,r.kt)("p",null,"Metals works with the following text editors with varying degree of\nfunctionality."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("td",null),(0,r.kt)("td",{align:"center"},"Visual Studio Code"),(0,r.kt)("td",{align:"center"},"Vim"),(0,r.kt)("td",{align:"center"},"Sublime Text"),(0,r.kt)("td",{align:"center"},"Emacs"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"Installation"),(0,r.kt)("td",{align:"center"},"Single click"),(0,r.kt)("td",{align:"center"},"Single click"),(0,r.kt)("td",{align:"center"},"Single click"),(0,r.kt)("td",{align:"center"},"Single click")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Build import"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Diagnostics"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Goto definition"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Goto type definition"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Completions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705*"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Hover"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Hover for selection"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u274c")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Parameter hints"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find references"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Run/Debug"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find implementations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Rename symbol"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Code actions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Worksheets"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Document symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"Flat"),(0,r.kt)("td",{align:"center"},"Flat"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Workspace symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Formatting"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Folding"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}," "),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Highlight"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Metals Extensions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"Status bar, Input box, Decoration protocol, Did focus"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Organize imports"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Implicit decorations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"Shown in hover"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Source file analyzer"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find text in dependency JAR files"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u274c")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Run scalafix rules"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")))),(0,r.kt)("h2",{id:"installation"},"Installation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Single click"),": Metals is easy to install and requires minimal configuration\nout-of-the-box."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Few steps"),": installing Metals requires a few custom steps and minimal\nconfiguration to work."),(0,r.kt)("p",null,(0,r.kt)("em",{parentName:"p"},"You can find instructions on how to install Metals for your editor on its\nspecific page.")),(0,r.kt)("h2",{id:"build-import"},"Build import"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": it is possible to import a build such as an sbt project directly from\nthe editor."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Requires browser"),": importing a build requires additional steps in a web\nbrowser using a localhost server. It is not possible to import a build within\nthe editor."),(0,r.kt)("h2",{id:"diagnostics"},"Diagnostics"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Diagnostics are correctly published on compile."),(0,r.kt)("p",null,"Compile errors are reported as red squiggles in the editor. Compilation is\ntriggered on file save for the build target (project/module) containing the\nfocused text file."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/48774587-f4d5c780-ecca-11e8-8087-acca5a05ca78.png",alt:"Diagnostics"})),(0,r.kt)("h3",{id:"known-limitations"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Slow feedback for type errors. Syntax errors are published as you type but\ntype errors are handled by the build tool, meaning diagnostics may take a\nwhile to publish for large projects.")),(0,r.kt)("h2",{id:"goto-definition"},"Goto definition"),(0,r.kt)("p",null,"Navigate to symbol definitions for project sources and Scala/Java library\ndependencies."),(0,r.kt)("p",null,"Symbols are resolved according to the last successful compilation in the build\ntool and navigation continues to work despite syntax errors in the open unsaved\nbuffer."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/48776422-1f764f00-ecd0-11e8-96d1-170f2354d50e.gif",alt:"Goto Definition"})),(0,r.kt)("h3",{id:"known-limitations-1"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Navigation does not work for buffers that do not tokenize, for example due to\nunclosed string literals."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/scalameta/scalameta/issues/1802"},"scalameta/scalameta#1802"),"\nreflective invocations (methods calls on structural types) do not resolve to a\ndefinition.")),(0,r.kt)("h2",{id:"completions"},"Completions"),(0,r.kt)("p",null,"Use code completions to explore APIs, implement interfaces, generate exhaustive\npattern matches and more."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/56036958-725bac00-5d2e-11e9-9cf7-46249125494a.gif",alt:"2019-04-12 14 19 39"})),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Auto-import"),": imports are inserted at the bottom of the global import list.\nImports still need to be sorted and grouped manually, we are exploring ways to\nautomate this workflow in the future."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Override def"),": implement methods from the super class."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Exhaustive match"),": generate an exhaustive pattern match for sealed types."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"String interpolator"),": automatically convert string literals into string\ninterpolators."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Filename"),": complete classnames based on the enclosing file."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Documentation"),": read the docstring for method symbols by pressing\nctrl+space in VS Code.")),(0,r.kt)("h3",{id:"known-limitations-2"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"completion results don't include symbols that have just been typed in separate\nfiles without a successful compilation in the build tool.")),(0,r.kt)("h2",{id:"hover-aka-type-at-point"},"Hover (aka. type at point)"),(0,r.kt)("p",null,"See the expression type and symbol signature under the cursor."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/2MfQvsM.gif",alt:null})),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Expression type"),": shows the non-generic type of the highlighted expression."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Symbol signature"),": shows the generic signature of symbol under the cursor\nalong with its docstring, if available.")),(0,r.kt)("h2",{id:"signature-help-aka-parameter-hints"},"Signature help (aka. parameter hints)"),(0,r.kt)("p",null,"View a method signature and method overloads as you fill in the arguments."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/DAWIrHu.gif",alt:null})),(0,r.kt)("h2",{id:"find-references"},"Find references"),(0,r.kt)("p",null,"Find symbol references in project sources. References include implicits,\ninferred ",(0,r.kt)("inlineCode",{parentName:"p"},".apply"),", desugared ",(0,r.kt)("inlineCode",{parentName:"p"},".flatMap")," from for comprehensions and other\nsymbols that may not be explicitly written in source, making it possible to\ndiscover usages of difficult-to-grep symbols. The Metals navigation index is\nlow-overhead and should only require a few megabytes of memory even for large\nprojects."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/51089190-75fc8880-1769-11e9-819c-95262205e95c.png",alt:"Find references"})),(0,r.kt)("h3",{id:"known-limitations-3"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},'References to overridden methods are not included in the results. For example,\nif you run "find references" on the method ',(0,r.kt)("inlineCode",{parentName:"li"},"Dog.name()")," then it won't include\nreferences to the super method ",(0,r.kt)("inlineCode",{parentName:"li"},"Animal.name()"),".")),(0,r.kt)("h2",{id:"worksheets"},"Worksheets"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Worksheets work via the Decoration protocol and are added as a\nnon-editable side decoration."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Comments"),": Worksheets work via ",(0,r.kt)("inlineCode",{parentName:"p"},"workspace/applyEdit")," by adding comments to\nthe source code and support hover to show larger output. You can find more\ninformation about worksheets under the editor specific worksheet section. For\nexample, ",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/editors/vscode#worksheets"},"here for VS Code"),"."),(0,r.kt)("h2",{id:"document-symbols"},"Document symbols"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Document symbols are displayed in a hierarchical outline."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Flat"),": Document symbols are displayed in a flat outline."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/50635569-014c7180-0f53-11e9-8898-62803898781c.gif",alt:"Document Symbols"})),(0,r.kt)("h2",{id:"workspace-symbols"},"Workspace symbols"),(0,r.kt)("p",null,"Fuzzy search a symbol in the workspace of library dependencies by its name."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"All-lowercase queries are treated as case-insensitive searches."),(0,r.kt)("li",{parentName:"ul"},"Queries ending with a dot ",(0,r.kt)("inlineCode",{parentName:"li"},".")," list nested symbols."),(0,r.kt)("li",{parentName:"ul"},"Queries containing a semicolon ",(0,r.kt)("inlineCode",{parentName:"li"},";")," search library dependencies.")),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/w5yrK1w.gif",alt:"Fuzzy symbol search example"})),(0,r.kt)("h2",{id:"formatting"},"Formatting"),(0,r.kt)("p",null,"Metals uses Scalafmt to respond to formatting requests from the editor,\naccording to the configuration defined in ",(0,r.kt)("inlineCode",{parentName:"p"},".scalafmt.conf"),"."),(0,r.kt)("p",null,"Learn how to configure Scalafmt at\n",(0,r.kt)("a",{parentName:"p",href:"https://scalameta.org/scalafmt/docs/configuration.html"},"https://scalameta.org/scalafmt/docs/configuration.html"),"."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/50635748-b0894880-0f53-11e9-913b-acfd5f505351.gif",alt:"Formatting"})),(0,r.kt)("h2",{id:"code-folding"},"Code folding"),(0,r.kt)("p",null,"Fold ranges such as large multi-line expressions, import groups and comments."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://camo.githubusercontent.com/3fdd7ae28907ac61c0a1ac5fdc07d085245957aa/68747470733a2f2f692e696d6775722e636f6d2f667149554a54472e676966",alt:null})),(0,r.kt)("h2",{id:"document-highlight"},"Document highlight"),(0,r.kt)("p",null,"Highlight references to the same symbol in the open file."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/0uhc9P5.gif",alt:null})),(0,r.kt)("h2",{id:"package-explorer"},"Package explorer"),(0,r.kt)("p",null,"Browse packages, classes and methods in the workspace and library dependencies\nusing the Metals sidebar. This feature is only implemented in VS Code."),(0,r.kt)("h2",{id:"test-explorer"},"Test Explorer"),(0,r.kt)("p",null,"Test Explorer is a feature that allows editors to display tests as a separate\ntree representation of tests. Although it was implemented in order to use Visual\nStudio Code's\n",(0,r.kt)("a",{parentName:"p",href:"https://code.visualstudio.com/api/extension-guides/testing"},"Testing API"),". The Test\nExplorer API is editor agnostic and can be used by other editors than just VS\nCode. ",(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/Z3VtS0O.gif",alt:"test-explorer"})),(0,r.kt)("p",null,"Work on the Test Explorer is still in progress and the feature has some known\nlimitations:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Test Explorer is able to discover single test cases only for JUnit4 test\nclasses. Support for other test frameworks is being worked on."),(0,r.kt)("li",{parentName:"ul"},"detecting suites in cross scala-version projects is inconsistent, see\n",(0,r.kt)("a",{parentName:"li",href:"https://github.com/scalameta/metals/issues/3503"},"this issue"),"."),(0,r.kt)("li",{parentName:"ul"},"there is no support for JS and Native platforms. For any changes subscribe to\nthe related\n",(0,r.kt)("a",{parentName:"li",href:"https://github.com/scalameta/metals-feature-requests/issues/256"},"feature request"),".")),(0,r.kt)("p",null,"You can find more information about Test Explorer under the\n",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/editors/vscode#test-explorer"},"VS Code")," specific section."),(0,r.kt)("h3",{id:"running-tests"},"Running Tests"),(0,r.kt)("p",null,"Both run and debug under the hood use BSP's debug request. More information\nabout it can be found at\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalacenter/bloop/blob/master/docs/assets/dap-example-metals.png"},"Bloop DAP diagram"),"\nor\n",(0,r.kt)("a",{parentName:"p",href:"https://build-server-protocol.github.io/docs/specification.html#debug-request"},"BSP specification"),"\nwebsite."),(0,r.kt)("h2",{id:"metals-extensions"},"Metals Extensions"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Status bar"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/status")," notification."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Decoration protocol"),": Editor client implements the\n",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/integrations/decoration-protocol"},"Decoration Protocol"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Tree view"),": Editor client implements the\n",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/integrations/tree-view-protocol"},"Tree View Protocol"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Did focus"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/didFocusTextDocument"),"\nnotification."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Slow task"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/slowTask")," request."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Input box"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/inputBox")," request."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Quick pick"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/quickPick")," request."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Window state"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/windowStateDidChange"),"\nnotification."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Editor implements all Metals extension endpoints."),(0,r.kt)("p",null,"The Metals language server supports custom extensions that are not part of the\nLanguage Server Protocol (LSP). These extensions are not necessary for Metals to\nfunction but they improve the user experience. To learn more about Metals\nextensions, see ",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/integrations/new-editor"},"integrating a new editor"),"."),(0,r.kt)("h2",{id:"implicit-decorations"},"Implicit decorations"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Additional information inferred from the code can be show within the\ncode using virtual text."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Shown in hover"),": Additional information inferred from the code can be show\nwhen hovering over a specific line. That hover only shows the additional symbols\non the current line."),(0,r.kt)("h2",{id:"additional-file-types"},"Additional file types"),(0,r.kt)("p",null,"Not all features are supported in all possible scenarios, especially when it\ncomes to non-standard Scala files like Ammonite scripts, worksheets or sbt\nscripts."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("td",null),(0,r.kt)("td",{align:"center"},"sbt scripts"),(0,r.kt)("td",{align:"center"},"Worksheets"),(0,r.kt)("td",{align:"center"},"Ammonite scripts*"),(0,r.kt)("td",{align:"center"},"Standalone Scala files"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"Diagnostics"),(0,r.kt)("td",{align:"center"},"\u2705*"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705*")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Goto definition"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Completions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Hover"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Parameter hints"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find references"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Run/Debug"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"})),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find implementations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Rename symbol"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Code actions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Document symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Workspace symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"All symbols are local"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Formatting"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Folding"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Highlight"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Organize imports"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"})),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Implicit decorations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Decode file (cfr, semanticdb, tasty, javap)"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"})))),(0,r.kt)("p",null,"*"," Note that there are some specific Ammonite features that aren't supported\nlike ",(0,r.kt)("a",{parentName:"p",href:"https://ammonite.io/#Multi-stageScripts"},"multi-stage")," scripts. Currently\nAmmonite support is also limited to Scala 2."),(0,r.kt)("p",null,"*"," Diagnostics for sbt script and standalone Scala files will only show parsing\nerrors, but not diagnostics coming from the compiler."))}m.isMDXComponent=!0}}]);
\ No newline at end of file
+"use strict";(self.webpackChunk=self.webpackChunk||[]).push([[5688],{3905:(t,e,n)=>{n.d(e,{Zo:()=>c,kt:()=>m});var l=n(7294);function i(t,e,n){return e in t?Object.defineProperty(t,e,{value:n,enumerable:!0,configurable:!0,writable:!0}):t[e]=n,t}function r(t,e){var n=Object.keys(t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);e&&(l=l.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),n.push.apply(n,l)}return n}function a(t){for(var e=1;e=0||(i[n]=t[n]);return i}(t,e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(t);for(l=0;l=0||Object.prototype.propertyIsEnumerable.call(t,n)&&(i[n]=t[n])}return i}var s=l.createContext({}),d=function(t){var e=l.useContext(s),n=e;return t&&(n="function"==typeof t?t(e):a(a({},e),t)),n},c=function(t){var e=d(t.components);return l.createElement(s.Provider,{value:e},t.children)},k="mdxType",u={inlineCode:"code",wrapper:function(t){var e=t.children;return l.createElement(l.Fragment,{},e)}},p=l.forwardRef((function(t,e){var n=t.components,i=t.mdxType,r=t.originalType,s=t.parentName,c=o(t,["components","mdxType","originalType","parentName"]),k=d(n),p=i,m=k["".concat(s,".").concat(p)]||k[p]||u[p]||r;return n?l.createElement(m,a(a({ref:e},c),{},{components:n})):l.createElement(m,a({ref:e},c))}));function m(t,e){var n=arguments,i=e&&e.mdxType;if("string"==typeof t||i){var r=n.length,a=new Array(r);a[0]=p;var o={};for(var s in e)hasOwnProperty.call(e,s)&&(o[s]=e[s]);o.originalType=t,o[k]="string"==typeof t?t:i,a[1]=o;for(var d=2;d{n.r(e),n.d(e,{assets:()=>c,contentTitle:()=>s,default:()=>m,frontMatter:()=>o,metadata:()=>d,toc:()=>k});var l=n(7462),i=n(3366),r=(n(7294),n(3905)),a=["components"],o={id:"overview",title:"Text Editors",sidebar_label:"Overview",slug:"/"},s=void 0,d={unversionedId:"editors/overview",id:"editors/overview",title:"Text Editors",description:"Latest Metals server versions",source:"@site/target/docs/editors/overview.md",sourceDirName:"editors",slug:"/",permalink:"/metals/docs/",draft:!1,editUrl:"https://github.com/scalameta/metals/edit/main/docs/editors/overview.md",tags:[],version:"current",frontMatter:{id:"overview",title:"Text Editors",sidebar_label:"Overview",slug:"/"},sidebar:"docs",next:{title:"VS Code",permalink:"/metals/docs/editors/vscode"}},c={},k=[{value:"Latest Metals server versions",id:"latest-metals-server-versions",level:2},{value:"Editor support",id:"editor-support",level:2},{value:"Installation",id:"installation",level:2},{value:"Build import",id:"build-import",level:2},{value:"Diagnostics",id:"diagnostics",level:2},{value:"Known limitations",id:"known-limitations",level:3},{value:"Goto definition",id:"goto-definition",level:2},{value:"Known limitations",id:"known-limitations-1",level:3},{value:"Completions",id:"completions",level:2},{value:"Known limitations",id:"known-limitations-2",level:3},{value:"Hover (aka. type at point)",id:"hover-aka-type-at-point",level:2},{value:"Signature help (aka. parameter hints)",id:"signature-help-aka-parameter-hints",level:2},{value:"Find references",id:"find-references",level:2},{value:"Known limitations",id:"known-limitations-3",level:3},{value:"Worksheets",id:"worksheets",level:2},{value:"Document symbols",id:"document-symbols",level:2},{value:"Workspace symbols",id:"workspace-symbols",level:2},{value:"Formatting",id:"formatting",level:2},{value:"Code folding",id:"code-folding",level:2},{value:"Document highlight",id:"document-highlight",level:2},{value:"Package explorer",id:"package-explorer",level:2},{value:"Test Explorer",id:"test-explorer",level:2},{value:"Running Tests",id:"running-tests",level:3},{value:"Metals Extensions",id:"metals-extensions",level:2},{value:"Implicit decorations",id:"implicit-decorations",level:2},{value:"Additional file types",id:"additional-file-types",level:2}],u={toc:k},p="wrapper";function m(t){var e=t.components,n=(0,i.Z)(t,a);return(0,r.kt)(p,(0,l.Z)({},u,n,{components:e,mdxType:"MDXLayout"}),(0,r.kt)("h2",{id:"latest-metals-server-versions"},"Latest Metals server versions"),(0,r.kt)("p",null,"To find out how to set the version in your editor please check out the editor\nspecific sections."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("th",null,"Version"),(0,r.kt)("th",null,"Published"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1"),(0,r.kt)("td",null,"28 Aug 2023 14:46")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"1.0.1+61-abcc0e5c-SNAPSHOT"),(0,r.kt)("td",null,"01 Oct 2023 17:00")))),"Snapshot releases are not guaranteed to work.",(0,r.kt)("h2",{id:"editor-support"},"Editor support"),(0,r.kt)("p",null,"Metals works with the following text editors with varying degree of\nfunctionality."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("td",null),(0,r.kt)("td",{align:"center"},"Visual Studio Code"),(0,r.kt)("td",{align:"center"},"Vim"),(0,r.kt)("td",{align:"center"},"Sublime Text"),(0,r.kt)("td",{align:"center"},"Emacs"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"Installation"),(0,r.kt)("td",{align:"center"},"Single click"),(0,r.kt)("td",{align:"center"},"Single click"),(0,r.kt)("td",{align:"center"},"Single click"),(0,r.kt)("td",{align:"center"},"Single click")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Build import"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Diagnostics"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Goto definition"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Goto type definition"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Completions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705*"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Hover"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Hover for selection"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u274c")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Parameter hints"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find references"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Run/Debug"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find implementations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Rename symbol"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Code actions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Worksheets"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Document symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"Flat"),(0,r.kt)("td",{align:"center"},"Flat"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Workspace symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Formatting"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Folding"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}," "),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Highlight"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Metals Extensions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"Status bar, Input box, Decoration protocol, Did focus"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Organize imports"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Implicit decorations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"Shown in hover"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Source file analyzer"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find text in dependency JAR files"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u274c")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Run scalafix rules"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")))),(0,r.kt)("h2",{id:"installation"},"Installation"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Single click"),": Metals is easy to install and requires minimal configuration\nout-of-the-box."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Few steps"),": installing Metals requires a few custom steps and minimal\nconfiguration to work."),(0,r.kt)("p",null,(0,r.kt)("em",{parentName:"p"},"You can find instructions on how to install Metals for your editor on its\nspecific page.")),(0,r.kt)("h2",{id:"build-import"},"Build import"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": it is possible to import a build such as an sbt project directly from\nthe editor."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Requires browser"),": importing a build requires additional steps in a web\nbrowser using a localhost server. It is not possible to import a build within\nthe editor."),(0,r.kt)("h2",{id:"diagnostics"},"Diagnostics"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Diagnostics are correctly published on compile."),(0,r.kt)("p",null,"Compile errors are reported as red squiggles in the editor. Compilation is\ntriggered on file save for the build target (project/module) containing the\nfocused text file."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/48774587-f4d5c780-ecca-11e8-8087-acca5a05ca78.png",alt:"Diagnostics"})),(0,r.kt)("h3",{id:"known-limitations"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Slow feedback for type errors. Syntax errors are published as you type but\ntype errors are handled by the build tool, meaning diagnostics may take a\nwhile to publish for large projects.")),(0,r.kt)("h2",{id:"goto-definition"},"Goto definition"),(0,r.kt)("p",null,"Navigate to symbol definitions for project sources and Scala/Java library\ndependencies."),(0,r.kt)("p",null,"Symbols are resolved according to the last successful compilation in the build\ntool and navigation continues to work despite syntax errors in the open unsaved\nbuffer."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/48776422-1f764f00-ecd0-11e8-96d1-170f2354d50e.gif",alt:"Goto Definition"})),(0,r.kt)("h3",{id:"known-limitations-1"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Navigation does not work for buffers that do not tokenize, for example due to\nunclosed string literals."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("a",{parentName:"li",href:"https://github.com/scalameta/scalameta/issues/1802"},"scalameta/scalameta#1802"),"\nreflective invocations (methods calls on structural types) do not resolve to a\ndefinition.")),(0,r.kt)("h2",{id:"completions"},"Completions"),(0,r.kt)("p",null,"Use code completions to explore APIs, implement interfaces, generate exhaustive\npattern matches and more."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/56036958-725bac00-5d2e-11e9-9cf7-46249125494a.gif",alt:"2019-04-12 14 19 39"})),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Auto-import"),": imports are inserted at the bottom of the global import list.\nImports still need to be sorted and grouped manually, we are exploring ways to\nautomate this workflow in the future."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Override def"),": implement methods from the super class."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Exhaustive match"),": generate an exhaustive pattern match for sealed types."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"String interpolator"),": automatically convert string literals into string\ninterpolators."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Filename"),": complete classnames based on the enclosing file."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Documentation"),": read the docstring for method symbols by pressing\nctrl+space in VS Code.")),(0,r.kt)("h3",{id:"known-limitations-2"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"completion results don't include symbols that have just been typed in separate\nfiles without a successful compilation in the build tool.")),(0,r.kt)("h2",{id:"hover-aka-type-at-point"},"Hover (aka. type at point)"),(0,r.kt)("p",null,"See the expression type and symbol signature under the cursor."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/2MfQvsM.gif",alt:null})),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Expression type"),": shows the non-generic type of the highlighted expression."),(0,r.kt)("li",{parentName:"ul"},(0,r.kt)("strong",{parentName:"li"},"Symbol signature"),": shows the generic signature of symbol under the cursor\nalong with its docstring, if available.")),(0,r.kt)("h2",{id:"signature-help-aka-parameter-hints"},"Signature help (aka. parameter hints)"),(0,r.kt)("p",null,"View a method signature and method overloads as you fill in the arguments."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/DAWIrHu.gif",alt:null})),(0,r.kt)("h2",{id:"find-references"},"Find references"),(0,r.kt)("p",null,"Find symbol references in project sources. References include implicits,\ninferred ",(0,r.kt)("inlineCode",{parentName:"p"},".apply"),", desugared ",(0,r.kt)("inlineCode",{parentName:"p"},".flatMap")," from for comprehensions and other\nsymbols that may not be explicitly written in source, making it possible to\ndiscover usages of difficult-to-grep symbols. The Metals navigation index is\nlow-overhead and should only require a few megabytes of memory even for large\nprojects."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/51089190-75fc8880-1769-11e9-819c-95262205e95c.png",alt:"Find references"})),(0,r.kt)("h3",{id:"known-limitations-3"},"Known limitations"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},'References to overridden methods are not included in the results. For example,\nif you run "find references" on the method ',(0,r.kt)("inlineCode",{parentName:"li"},"Dog.name()")," then it won't include\nreferences to the super method ",(0,r.kt)("inlineCode",{parentName:"li"},"Animal.name()"),".")),(0,r.kt)("h2",{id:"worksheets"},"Worksheets"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Worksheets work via the Decoration protocol and are added as a\nnon-editable side decoration."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Comments"),": Worksheets work via ",(0,r.kt)("inlineCode",{parentName:"p"},"workspace/applyEdit")," by adding comments to\nthe source code and support hover to show larger output. You can find more\ninformation about worksheets under the editor specific worksheet section. For\nexample, ",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/editors/vscode#worksheets"},"here for VS Code"),"."),(0,r.kt)("h2",{id:"document-symbols"},"Document symbols"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Document symbols are displayed in a hierarchical outline."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Flat"),": Document symbols are displayed in a flat outline."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/50635569-014c7180-0f53-11e9-8898-62803898781c.gif",alt:"Document Symbols"})),(0,r.kt)("h2",{id:"workspace-symbols"},"Workspace symbols"),(0,r.kt)("p",null,"Fuzzy search a symbol in the workspace of library dependencies by its name."),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"All-lowercase queries are treated as case-insensitive searches."),(0,r.kt)("li",{parentName:"ul"},"Queries ending with a dot ",(0,r.kt)("inlineCode",{parentName:"li"},".")," list nested symbols."),(0,r.kt)("li",{parentName:"ul"},"Queries containing a semicolon ",(0,r.kt)("inlineCode",{parentName:"li"},";")," search library dependencies.")),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/w5yrK1w.gif",alt:"Fuzzy symbol search example"})),(0,r.kt)("h2",{id:"formatting"},"Formatting"),(0,r.kt)("p",null,"Metals uses Scalafmt to respond to formatting requests from the editor,\naccording to the configuration defined in ",(0,r.kt)("inlineCode",{parentName:"p"},".scalafmt.conf"),"."),(0,r.kt)("p",null,"Learn how to configure Scalafmt at\n",(0,r.kt)("a",{parentName:"p",href:"https://scalameta.org/scalafmt/docs/configuration.html"},"https://scalameta.org/scalafmt/docs/configuration.html"),"."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://user-images.githubusercontent.com/1408093/50635748-b0894880-0f53-11e9-913b-acfd5f505351.gif",alt:"Formatting"})),(0,r.kt)("h2",{id:"code-folding"},"Code folding"),(0,r.kt)("p",null,"Fold ranges such as large multi-line expressions, import groups and comments."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://camo.githubusercontent.com/3fdd7ae28907ac61c0a1ac5fdc07d085245957aa/68747470733a2f2f692e696d6775722e636f6d2f667149554a54472e676966",alt:null})),(0,r.kt)("h2",{id:"document-highlight"},"Document highlight"),(0,r.kt)("p",null,"Highlight references to the same symbol in the open file."),(0,r.kt)("p",null,(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/0uhc9P5.gif",alt:null})),(0,r.kt)("h2",{id:"package-explorer"},"Package explorer"),(0,r.kt)("p",null,"Browse packages, classes and methods in the workspace and library dependencies\nusing the Metals sidebar. This feature is only implemented in VS Code."),(0,r.kt)("h2",{id:"test-explorer"},"Test Explorer"),(0,r.kt)("p",null,"Test Explorer is a feature that allows editors to display tests as a separate\ntree representation of tests. Although it was implemented in order to use Visual\nStudio Code's\n",(0,r.kt)("a",{parentName:"p",href:"https://code.visualstudio.com/api/extension-guides/testing"},"Testing API"),". The Test\nExplorer API is editor agnostic and can be used by other editors than just VS\nCode. ",(0,r.kt)("img",{parentName:"p",src:"https://i.imgur.com/Z3VtS0O.gif",alt:"test-explorer"})),(0,r.kt)("p",null,"Work on the Test Explorer is still in progress and the feature has some known\nlimitations:"),(0,r.kt)("ul",null,(0,r.kt)("li",{parentName:"ul"},"Test Explorer is able to discover single test cases only for JUnit4 test\nclasses. Support for other test frameworks is being worked on."),(0,r.kt)("li",{parentName:"ul"},"detecting suites in cross scala-version projects is inconsistent, see\n",(0,r.kt)("a",{parentName:"li",href:"https://github.com/scalameta/metals/issues/3503"},"this issue"),"."),(0,r.kt)("li",{parentName:"ul"},"there is no support for JS and Native platforms. For any changes subscribe to\nthe related\n",(0,r.kt)("a",{parentName:"li",href:"https://github.com/scalameta/metals-feature-requests/issues/256"},"feature request"),".")),(0,r.kt)("p",null,"You can find more information about Test Explorer under the\n",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/editors/vscode#test-explorer"},"VS Code")," specific section."),(0,r.kt)("h3",{id:"running-tests"},"Running Tests"),(0,r.kt)("p",null,"Both run and debug under the hood use BSP's debug request. More information\nabout it can be found at\n",(0,r.kt)("a",{parentName:"p",href:"https://github.com/scalacenter/bloop/blob/master/docs/assets/dap-example-metals.png"},"Bloop DAP diagram"),"\nor\n",(0,r.kt)("a",{parentName:"p",href:"https://build-server-protocol.github.io/docs/specification.html#debug-request"},"BSP specification"),"\nwebsite."),(0,r.kt)("h2",{id:"metals-extensions"},"Metals Extensions"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Status bar"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/status")," notification."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Decoration protocol"),": Editor client implements the\n",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/integrations/decoration-protocol"},"Decoration Protocol"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Tree view"),": Editor client implements the\n",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/integrations/tree-view-protocol"},"Tree View Protocol"),"."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Did focus"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/didFocusTextDocument"),"\nnotification."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Slow task"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/slowTask")," request."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Input box"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/inputBox")," request."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Quick pick"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/quickPick")," request."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Window state"),": Editor client implements the ",(0,r.kt)("inlineCode",{parentName:"p"},"metals/windowStateDidChange"),"\nnotification."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Editor implements all Metals extension endpoints."),(0,r.kt)("p",null,"The Metals language server supports custom extensions that are not part of the\nLanguage Server Protocol (LSP). These extensions are not necessary for Metals to\nfunction but they improve the user experience. To learn more about Metals\nextensions, see ",(0,r.kt)("a",{parentName:"p",href:"/metals/docs/integrations/new-editor"},"integrating a new editor"),"."),(0,r.kt)("h2",{id:"implicit-decorations"},"Implicit decorations"),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"\u2705"),": Additional information inferred from the code can be show within the\ncode using virtual text."),(0,r.kt)("p",null,(0,r.kt)("strong",{parentName:"p"},"Shown in hover"),": Additional information inferred from the code can be show\nwhen hovering over a specific line. That hover only shows the additional symbols\non the current line."),(0,r.kt)("h2",{id:"additional-file-types"},"Additional file types"),(0,r.kt)("p",null,"Not all features are supported in all possible scenarios, especially when it\ncomes to non-standard Scala files like Ammonite scripts, worksheets or sbt\nscripts."),(0,r.kt)("table",null,(0,r.kt)("thead",null,(0,r.kt)("tr",null,(0,r.kt)("td",null),(0,r.kt)("td",{align:"center"},"sbt scripts"),(0,r.kt)("td",{align:"center"},"Worksheets"),(0,r.kt)("td",{align:"center"},"Ammonite scripts*"),(0,r.kt)("td",{align:"center"},"Standalone Scala files"))),(0,r.kt)("tbody",null,(0,r.kt)("tr",null,(0,r.kt)("td",null,"Diagnostics"),(0,r.kt)("td",{align:"center"},"\u2705*"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705*")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Goto definition"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Completions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Hover"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Parameter hints"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find references"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Run/Debug"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"})),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Find implementations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Rename symbol"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Code actions"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Document symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Workspace symbols"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"All symbols are local"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Formatting"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Folding"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Highlight"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Organize imports"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"})),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Implicit decorations"),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"},"\u2705"),(0,r.kt)("td",{align:"center"},"\u2705")),(0,r.kt)("tr",null,(0,r.kt)("td",null,"Decode file (cfr, semanticdb, tasty, javap)"),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"}),(0,r.kt)("td",{align:"center"})))),(0,r.kt)("p",null,"*"," Note that there are some specific Ammonite features that aren't supported\nlike ",(0,r.kt)("a",{parentName:"p",href:"https://ammonite.io/#Multi-stageScripts"},"multi-stage")," scripts. Currently\nAmmonite support is also limited to Scala 2."),(0,r.kt)("p",null,"*"," Diagnostics for sbt script and standalone Scala files will only show parsing\nerrors, but not diagnostics coming from the compiler."))}m.isMDXComponent=!0}}]);
\ No newline at end of file
diff --git a/assets/js/main.bec7de45.js b/assets/js/main.bec7de45.js
deleted file mode 100644
index a53d780ee96..00000000000
--- a/assets/js/main.bec7de45.js
+++ /dev/null
@@ -1,2 +0,0 @@
-/*! For license information please see main.bec7de45.js.LICENSE.txt */
-(self.webpackChunk=self.webpackChunk||[]).push([[179],{4334:(e,t,n)=>{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";function r(e){var t,n,a="";if("string"==typeof e||"number"==typeof e)a+=e;else if("object"==typeof e)if(Array.isArray(e))for(t=0;ta});const a=function(){for(var e,t,n=0,a="";n{"use strict";n.d(t,{Z:()=>p});var r=n(7294),a=n(7462),o=n(8356),i=n.n(o),l=n(6887);const s={"00813942":[function(){return n.e(517).then(n.bind(n,6811))},"@site/blog/2022-07-04-aluminium.md?truncated=true",6811],"01456d3b":[function(){return n.e(7099).then(n.t.bind(n,6777,19))},"~blog/default/metals-blog-page-14-de1.json",6777],"01706c44":[function(){return n.e(3315).then(n.bind(n,2665))},"@site/blog/2022-06-03-aluminium.md",2665],"022bb252":[function(){return n.e(5975).then(n.t.bind(n,685,19))},"~blog/default/metals-blog-page-51-bb4.json",685],"03b2a692":[function(){return n.e(5949).then(n.bind(n,4754))},"@site/blog/2021-02-24-tungsten.md",4754],"0529b5a5":[function(){return n.e(6002).then(n.bind(n,5235))},"@site/blog/2021-05-31-tungsten.md",5235],"07ab39c8":[function(){return n.e(8031).then(n.t.bind(n,2218,19))},"~blog/default/metals-blog-page-38-ec7.json",2218],"07c8b2d8":[function(){return n.e(8131).then(n.t.bind(n,2625,19))},"~blog/default/metals-blog-page-33-38b.json",2625],"08b44b83":[function(){return n.e(8821).then(n.bind(n,7e3))},"@site/target/docs/features/scripts.md",7e3],"0beb67bc":[function(){return n.e(7705).then(n.bind(n,7853))},"@site/blog/2020-09-21-lithium.md?truncated=true",7853],"0c130405":[function(){return n.e(198).then(n.t.bind(n,2880,19))},"~blog/default/metals-blog-page-12-a5a.json",2880],"0c485ec1":[function(){return n.e(190).then(n.bind(n,4346))},"@site/blog/2019-09-12-thorium.md?truncated=true",4346],"0d126b35":[function(){return n.e(6622).then(n.t.bind(n,4560,19))},"~blog/default/metals-blog-page-17-c89.json",4560],"0d7cd0de":[function(){return n.e(3164).then(n.bind(n,2410))},"@site/blog/2020-01-10-cobalt.md",2410],"0d8e09e6":[function(){return n.e(2063).then(n.t.bind(n,9246,19))},"~blog/default/metals-blog-page-25-e19.json",9246],"0e2b725e":[function(){return n.e(4256).then(n.t.bind(n,4893,19))},"~blog/default/metals-blog-page-40-1c4.json",4893],"143cbec3":[function(){return n.e(119).then(n.t.bind(n,8681,19))},"~blog/default/metals-blog-page-3-7ee.json",8681],"1512f001":[function(){return n.e(569).then(n.t.bind(n,7893,19))},"~blog/default/metals-blog-page-57-0bb.json",7893],"15b090c7":[function(){return n.e(3214).then(n.t.bind(n,5359,19))},"~blog/default/metals-blog-page-5-02c.json",5359],"17823fa5":[function(){return n.e(3553).then(n.bind(n,2964))},"@site/target/docs/build-tools/mill.md",2964],17896441:[function(){return Promise.all([n.e(532),n.e(394),n.e(7918)]).then(n.bind(n,8945))},"@theme/DocItem",8945],"17a26cd8":[function(){return n.e(2822).then(n.bind(n,8552))},"@site/blog/2020-12-19-lithium.md",8552],"1a1ad967":[function(){return n.e(1977).then(n.bind(n,1217))},"@site/blog/2021-02-24-tungsten.md?truncated=true",1217],"1a4e3797":[function(){return Promise.all([n.e(532),n.e(7920)]).then(n.bind(n,1473))},"@theme/SearchPage",1473],"1a79d8f3":[function(){return n.e(4167).then(n.t.bind(n,9536,19))},"~blog/default/metals-blog-page-41-7a1.json",9536],"1b9d5eae":[function(){return n.e(9624).then(n.bind(n,3483))},"@site/blog/2019-09-23-thorium.md",3483],"1be78505":[function(){return Promise.all([n.e(532),n.e(9514)]).then(n.bind(n,9963))},"@theme/DocPage",9963],"1ed82af1":[function(){return n.e(9135).then(n.bind(n,9735))},"@site/target/docs/features/code-actions.md",9735],"205a1816":[function(){return n.e(8778).then(n.bind(n,345))},"@site/blog/2022-08-10-aluminium.md?truncated=true",345],"2131c61b":[function(){return n.e(8797).then(n.bind(n,6243))},"@site/blog/2020-07-23-configuring-a-client.md?truncated=true",6243],"21dcb4fb":[function(){return n.e(5642).then(n.t.bind(n,6858,19))},"~blog/default/metals-blog-page-50-6cb.json",6858],"2216edbc":[function(){return n.e(9253).then(n.bind(n,5786))},"@site/blog/2018-12-06-iron.md?truncated=true",5786],"22c2c9b0":[function(){return n.e(3980).then(n.t.bind(n,1940,19))},"~blog/default/metals-blog-page-4-20a.json",1940],"2328fd63":[function(){return n.e(9043).then(n.bind(n,4727))},"@site/blog/2020-02-26-cobalt.md?truncated=true",4727],"2387c651":[function(){return n.e(2036).then(n.t.bind(n,2217,19))},"~blog/default/metals-blog-page-30-56d.json",2217],"243d370e":[function(){return n.e(5016).then(n.bind(n,9410))},"@site/blog/2022-04-26-aluminium.md?truncated=true",9410],"25446b1f":[function(){return n.e(3681).then(n.bind(n,1664))},"@site/target/docs/build-tools/maven.md",1664],"26934d81":[function(){return n.e(5264).then(n.bind(n,1791))},"@site/target/docs/build-tools/sbt.md",1791],"27feb48a":[function(){return n.e(3351).then(n.bind(n,9423))},"@site/target/docs/diagrams/instruction.md",9423],28906591:[function(){return n.e(1648).then(n.bind(n,5691))},"@site/target/docs/integrations/new-editor.md",5691],"291a747b":[function(){return n.e(7205).then(n.t.bind(n,6116,19))},"~blog/default/metals-blog-page-18-eff.json",6116],"2c5862c4":[function(){return n.e(4019).then(n.t.bind(n,9499,19))},"~blog/default/metals-blog-page-37-3bb.json",9499],"2d522398":[function(){return n.e(6251).then(n.bind(n,4781))},"@site/blog/2019-02-01-tin.md?truncated=true",4781],"2e1ac853":[function(){return n.e(2041).then(n.t.bind(n,5023,19))},"~blog/default/metals-blog-page-20-935.json",5023],"2ff5ad1b":[function(){return n.e(8840).then(n.bind(n,5212))},"@site/target/docs/integrations/debug-adapter-protocol.md",5212],30083153:[function(){return n.e(7372).then(n.bind(n,7858))},"@site/blog/2023-01-02-aluminium.md?truncated=true",7858],"309b8d38":[function(){return n.e(1753).then(n.bind(n,6263))},"@site/blog/2019-06-11-radium.md?truncated=true",6263],"35bd5843":[function(){return n.e(9632).then(n.bind(n,7297))},"@site/blog/2020-11-06-sbt-BSP-support.md?truncated=true",7297],"36958d65":[function(){return n.e(7429).then(n.t.bind(n,3121,19))},"~blog/default/metals-blog-page-16-975.json",3121],"3839ad99":[function(){return n.e(2882).then(n.bind(n,6355))},"@site/blog/2021-11-03-tungsten.md",6355],"38b82327":[function(){return n.e(6573).then(n.bind(n,730))},"@site/blog/2022-02-23-towards-better-releases.md",730],"39178d36":[function(){return n.e(3710).then(n.bind(n,3007))},"@site/target/docs/editors/online-ides.md",3007],"3cf1e930":[function(){return n.e(4408).then(n.bind(n,9048))},"@site/blog/2020-11-20-lithium.md?truncated=true",9048],"3d6e158a":[function(){return n.e(448).then(n.bind(n,9847))},"@site/blog/2018-12-14-iron.md",9847],"3f977ffc":[function(){return n.e(6469).then(n.bind(n,3830))},"@site/blog/2020-03-19-cobalt.md?truncated=true",3830],"400a1ae3":[function(){return n.e(5014).then(n.bind(n,2141))},"@site/blog/2021-02-02-metals-retro-part1.md",2141],"404bab64":[function(){return n.e(2240).then(n.t.bind(n,1681,19))},"~blog/default/metals-blog-page-54-0ed.json",1681],"432804b2":[function(){return n.e(9191).then(n.bind(n,189))},"@site/target/docs/editors/user-configuration.md",189],"4844a7cd":[function(){return n.e(2975).then(n.bind(n,417))},"@site/blog/2019-01-22-bloom-filters.md",417],"48a1d228":[function(){return n.e(4694).then(n.bind(n,7195))},"@site/blog/2021-02-02-metals-retro-part1.md?truncated=true",7195],49773175:[function(){return n.e(4100).then(n.bind(n,357))},"@site/target/docs/editors/vim.md",357],"4ad5693c":[function(){return n.e(2859).then(n.t.bind(n,1277,19))},"~blog/default/metals-blog-page-6-d90.json",1277],"4af6d88b":[function(){return n.e(8476).then(n.t.bind(n,4247,19))},"~blog/default/metals-blog-page-56-a80.json",4247],"4e26f5de":[function(){return n.e(4015).then(n.bind(n,2748))},"@site/blog/2021-01-19-lithium.md",2748],"508e58e7":[function(){return n.e(9952).then(n.bind(n,7732))},"@site/target/docs/troubleshooting/faq.md",7732],"515fa385":[function(){return n.e(3333).then(n.t.bind(n,9035,19))},"~blog/default/metals-blog-page-15-ac6.json",9035],"5346cb4e":[function(){return n.e(8563).then(n.bind(n,7735))},"@site/blog/2023-07-19-silver.md?truncated=true",7735],"53c82ccc":[function(){return n.e(98).then(n.bind(n,4675))},"@site/blog/2019-04-12-mercury.md?truncated=true",4675],"55a95aa3":[function(){return n.e(48).then(n.bind(n,8175))},"@site/blog/2021-11-03-tungsten.md?truncated=true",8175],"560d1d3c":[function(){return n.e(5890).then(n.bind(n,7830))},"@site/blog/2020-12-19-lithium.md?truncated=true",7830],"56bbb0f8":[function(){return n.e(504).then(n.bind(n,3329))},"@site/blog/2020-02-26-cobalt.md",3329],"56cef870":[function(){return n.e(1566).then(n.bind(n,3947))},"@site/blog/2022-02-23-towards-better-releases.md?truncated=true",3947],"57d9d0fa":[function(){return n.e(5865).then(n.t.bind(n,9775,19))},"~blog/default/metals-blog-page-24-d22.json",9775],"5980cb66":[function(){return n.e(9707).then(n.t.bind(n,9479,19))},"~blog/default/metals-blog-page-13-35f.json",9479],"5d80abc8":[function(){return n.e(9282).then(n.bind(n,9041))},"@site/target/docs/integrations/test-explorer.md",9041],"5d99d17c":[function(){return n.e(9820).then(n.bind(n,2365))},"@site/target/docs/contributors/getting-started.md",2365],"5e9f5e1a":[function(){return Promise.resolve().then(n.bind(n,6809))},"@generated/docusaurus.config",6809],"5ec07b8b":[function(){return n.e(9537).then(n.bind(n,9100))},"@site/blog/2020-09-21-lithium.md",9100],"6079a6bf":[function(){return n.e(490).then(n.bind(n,4191))},"@site/blog/2019-02-01-tin.md",4191],"615063b9":[function(){return n.e(9783).then(n.bind(n,9526))},"@site/blog/2018-12-14-iron.md?truncated=true",9526],"627fd629":[function(){return n.e(6013).then(n.bind(n,4660))},"@site/blog/2021-04-06-tungsten.md?truncated=true",4660],"643c52ed":[function(){return n.e(984).then(n.bind(n,597))},"@site/blog/2020-08-19-lithium.md?truncated=true",597],"64912a2b":[function(){return n.e(3104).then(n.t.bind(n,3813,19))},"~blog/default/metals-blog-page-28-689.json",3813],"64d6e9a7":[function(){return n.e(8377).then(n.bind(n,8593))},"@site/blog/2020-11-26-lithium.md?truncated=true",8593],"6722346e":[function(){return n.e(833).then(n.t.bind(n,7489,19))},"~blog/default/metals-blog-page-26-c9a.json",7489],"674a37b6":[function(){return n.e(7472).then(n.t.bind(n,3330,19))},"~blog/default/metals-blog-page-32-721.json",3330],"6999e097":[function(){return n.e(3282).then(n.bind(n,2203))},"@site/blog/2020-07-15-lithium.md?truncated=true",2203],"6a125964":[function(){return n.e(6466).then(n.bind(n,8040))},"@site/blog/2020-07-01-lithium.md",8040],"6a60bac4":[function(){return n.e(6162).then(n.t.bind(n,815,19))},"~blog/default/metals-blog-page-9-d5d.json",815],"6ea6fc78":[function(){return n.e(6999).then(n.bind(n,9747))},"@site/target/docs/contributors/updating-website.md",9747],"6ed4e313":[function(){return n.e(8607).then(n.t.bind(n,6711,19))},"~blog/default/metals-blog-page-7-2e5.json",6711],"70f9df55":[function(){return n.e(4797).then(n.bind(n,707))},"@site/blog/2019-09-02-thorium.md?truncated=true",707],"71846d42":[function(){return n.e(9777).then(n.bind(n,1400))},"@site/blog/2022-01-12-aluminium.md?truncated=true",1400],"71926bbd":[function(){return n.e(328).then(n.bind(n,4944))},"@site/blog/2020-04-12-mercury.md?truncated=true",4944],"73043cbc":[function(){return n.e(224).then(n.t.bind(n,3381,19))},"~blog/default/metals-blog-page-53-d27.json",3381],"7475f9e7":[function(){return n.e(463).then(n.bind(n,4520))},"@site/blog/2023-04-21-aluminium.md?truncated=true",4520],"74f6f7a6":[function(){return n.e(1295).then(n.bind(n,6742))},"@site/blog/2019-04-12-mercury.md",6742],"752eae27":[function(){return n.e(8984).then(n.bind(n,111))},"@site/blog/2021-10-26-tungsten.md?truncated=true",111],"75d4c63e":[function(){return n.e(3726).then(n.bind(n,4538))},"@site/blog/2019-09-12-thorium.md",4538],"7745fd32":[function(){return n.e(5372).then(n.bind(n,6463))},"@site/blog/2022-04-28-aluminium.md",6463],"77892e30":[function(){return n.e(202).then(n.bind(n,2366))},"@site/blog/2020-11-10-lithium.md?truncated=true",2366],"786192e2":[function(){return n.e(1557).then(n.t.bind(n,4100,19))},"~blog/default/metals-blog-page-58-0c4.json",4100],"794071d8":[function(){return n.e(989).then(n.bind(n,2459))},"@site/blog/2018-12-12-fast-goto-definition.md",2459],79920604:[function(){return n.e(7785).then(n.t.bind(n,8064,19))},"~blog/default/metals-blog-page-35-352.json",8064],"7af95c3c":[function(){return n.e(3470).then(n.t.bind(n,6708,19))},"~blog/default/metals-blog-page-19-203.json",6708],"7c0269a6":[function(){return n.e(5430).then(n.t.bind(n,1494,19))},"~blog/default/metals-blog-page-34-212.json",1494],"7d4f68c1":[function(){return n.e(1733).then(n.bind(n,2589))},"@site/blog/2018-12-06-iron.md",2589],"7d61c055":[function(){return n.e(6583).then(n.bind(n,3597))},"@site/target/docs/build-tools/overview.md",3597],"7ea62e57":[function(){return n.e(9774).then(n.t.bind(n,9375,19))},"~blog/default/metals-blog-page-10-3da.json",9375],"801caf39":[function(){return n.e(5561).then(n.bind(n,6049))},"@site/blog/2021-05-17-tungsten.md?truncated=true",6049],"80d94b51":[function(){return n.e(2884).then(n.bind(n,7018))},"@site/blog/2019-09-02-thorium.md",7018],"814f3328":[function(){return n.e(2535).then(n.t.bind(n,5641,19))},"~blog/default/blog-post-list-prop-default.json",5641],"81c1ce9e":[function(){return n.e(5061).then(n.bind(n,7526))},"@site/blog/2022-07-04-aluminium.md",7526],"82e8fb15":[function(){return n.e(2010).then(n.bind(n,463))},"@site/blog/2020-08-19-lithium.md",463],"88d8e9a5":[function(){return n.e(6776).then(n.bind(n,2368))},"@site/blog/2021-10-26-tungsten.md",2368],"8947246e":[function(){return n.e(5130).then(n.bind(n,8152))},"@site/blog/2020-07-15-lithium.md",8152],"8a0b8ece":[function(){return n.e(4782).then(n.bind(n,1344))},"@site/target/docs/editors/sublime.md",1344],"8b7e7f73":[function(){return n.e(8933).then(n.bind(n,4572))},"@site/blog/2018-12-12-fast-goto-definition.md?truncated=true",4572],"8ead6264":[function(){return n.e(4391).then(n.bind(n,3567))},"@site/blog/2021-05-31-tungsten.md?truncated=true",3567],"8f9f6130":[function(){return n.e(1667).then(n.bind(n,3305))},"@site/blog/2022-06-03-aluminium.md?truncated=true",3305],"905a60c6":[function(){return n.e(5518).then(n.bind(n,2894))},"@site/target/docs/troubleshooting/proxy.md",2894],"9349bfb9":[function(){return n.e(2287).then(n.bind(n,3775))},"@site/blog/2020-11-26-lithium.md",3775],"935f2afb":[function(){return n.e(53).then(n.t.bind(n,1109,19))},"~docs/default/version-current-metadata-prop-751.json",1109],"94015cb6":[function(){return n.e(6520).then(n.bind(n,6761))},"@site/target/docs/editors/emacs.md",6761],"94cc8923":[function(){return n.e(8059).then(n.bind(n,3410))},"@site/blog/2022-04-27-aluminium.md?truncated=true",3410],"96a3e035":[function(){return n.e(6499).then(n.bind(n,7407))},"@site/blog/2022-04-26-aluminium.md",7407],"970a5f4e":[function(){return n.e(6561).then(n.bind(n,4755))},"@site/target/docs/editors/vscode.md",4755],"97ce67ef":[function(){return n.e(4839).then(n.t.bind(n,8076,19))},"~blog/default/metals-blog-page-44-066.json",8076],"995bfa6d":[function(){return n.e(9242).then(n.t.bind(n,7851,19))},"~blog/default/metals-blog-page-31-e79.json",7851],"99d3dc3a":[function(){return n.e(713).then(n.bind(n,2265))},"@site/blog/2019-09-23-thorium.md?truncated=true",2265],"99d7db30":[function(){return n.e(382).then(n.bind(n,2977))},"@site/blog/2019-04-26-mercury.md?truncated=true",2977],"9a20f037":[function(){return n.e(8978).then(n.bind(n,6639))},"@site/blog/2022-04-28-aluminium.md?truncated=true",6639],"9a7faebf":[function(){return n.e(2174).then(n.t.bind(n,3704,19))},"~blog/default/metals-blog-page-2-4e4.json",3704],"9ae6eeaa":[function(){return n.e(3737).then(n.bind(n,9982))},"@site/blog/2019-01-22-bloom-filters.md?truncated=true",9982],"9b49e051":[function(){return n.e(3621).then(n.bind(n,4817))},"@site/target/docs/integrations/new-build-tool.md",4817],"9b4a23be":[function(){return n.e(5688).then(n.bind(n,8731))},"@site/target/docs/editors/overview.md",8731],"9e4087bc":[function(){return n.e(3608).then(n.bind(n,3169))},"@theme/BlogArchivePage",3169],"9ea6b57a":[function(){return n.e(3740).then(n.bind(n,996))},"@site/target/docs/integrations/decoration-protocol.md",996],a1f1bc88:[function(){return n.e(9567).then(n.bind(n,3393))},"@site/target/docs/integrations/tree-view-protocol.md",3393],a4b63d05:[function(){return n.e(3733).then(n.t.bind(n,4236,19))},"~blog/default/metals-blog-page-43-574.json",4236],a4c9fa90:[function(){return n.e(7602).then(n.bind(n,1295))},"@site/blog/2020-11-06-sbt-BSP-support.md",1295],a64b4ddf:[function(){return n.e(4583).then(n.bind(n,782))},"@site/blog/2020-11-20-lithium.md",782],a6aa9e1f:[function(){return Promise.all([n.e(532),n.e(394),n.e(6048),n.e(3089)]).then(n.bind(n,3269))},"@theme/BlogListPage",3269],a81ab01c:[function(){return n.e(9981).then(n.t.bind(n,793,19))},"~blog/default/metals-blog-page-8-b21.json",793],a91b50a6:[function(){return n.e(9641).then(n.t.bind(n,5646,19))},"~blog/default/metals-blog-page-55-048.json",5646],a935f661:[function(){return n.e(1239).then(n.t.bind(n,1612,19))},"~blog/default/metals-blog-page-46-b19.json",1612],ab2e7d85:[function(){return n.e(5359).then(n.bind(n,5507))},"@site/blog/2019-06-28-thorium.md",5507],abf165a1:[function(){return n.e(1976).then(n.bind(n,8932))},"@site/blog/2020-07-01-lithium.md?truncated=true",8932],ac2e449c:[function(){return n.e(4307).then(n.bind(n,205))},"@site/blog/2019-01-24-tin.md?truncated=true",205],ad29d74f:[function(){return n.e(7031).then(n.bind(n,4419))},"@site/blog/2021-09-06-tungsten.md?truncated=true",4419],ad57a4da:[function(){return n.e(2847).then(n.bind(n,9340))},"@site/blog/2020-04-12-mercury.md",9340],adb52a11:[function(){return n.e(9959).then(n.bind(n,8149))},"@site/target/docs/contributors/releasing.md",8149],adce20d1:[function(){return n.e(9505).then(n.t.bind(n,1050,19))},"~blog/default/metals-blog-page-39-273.json",1050],af8d2261:[function(){return n.e(2604).then(n.bind(n,6633))},"@site/blog/2021-09-06-tungsten.md",6633],b04d5738:[function(){return n.e(1457).then(n.bind(n,1613))},"@site/blog/2019-06-28-thorium.md?truncated=true",1613],b0577adc:[function(){return n.e(9026).then(n.bind(n,3958))},"@site/blog/2020-03-19-cobalt.md",3958],b28f3685:[function(){return n.e(3707).then(n.bind(n,4705))},"@site/blog/2019-06-11-radium.md",4705],b3904d08:[function(){return n.e(7528).then(n.bind(n,6450))},"@site/blog/2022-01-17-aluminium.md",6450],b54e7820:[function(){return n.e(9766).then(n.t.bind(n,6717,19))},"~blog/default/metals-blog-page-23-a00.json",6717],b79c2638:[function(){return n.e(7769).then(n.bind(n,2557))},"@site/target/docs/build-tools/gradle.md",2557],bb177581:[function(){return n.e(4663).then(n.bind(n,5931))},"@site/blog/2023-01-02-aluminium.md",5931],bc8294f9:[function(){return n.e(2665).then(n.bind(n,9146))},"@site/blog/2022-10-06-aluminium.md",9146],bcb36622:[function(){return n.e(9748).then(n.bind(n,7088))},"@site/blog/2022-03-08-aluminium.md?truncated=true",7088],bd301d6b:[function(){return n.e(6596).then(n.bind(n,7263))},"@site/blog/2021-07-14-tungsten.md?truncated=true",7263],bd78ee39:[function(){return n.e(9732).then(n.t.bind(n,1529,19))},"~blog/default/metals-blog-eef.json",1529],bdbe54cc:[function(){return n.e(9423).then(n.t.bind(n,3877,19))},"~blog/default/metals-blog-page-27-3d6.json",3877],bdc47ac0:[function(){return n.e(1157).then(n.bind(n,2630))},"@site/blog/2020-11-10-lithium.md",2630],bdea20ec:[function(){return n.e(1181).then(n.bind(n,3283))},"@site/blog/2021-09-16-tungsten.md",3283],bfd27103:[function(){return n.e(867).then(n.bind(n,2602))},"@site/blog/2022-03-08-aluminium.md",2602],c278e024:[function(){return n.e(1046).then(n.bind(n,1356))},"@site/blog/2020-05-04-lithium.md?truncated=true",1356],c4083f57:[function(){return n.e(4766).then(n.t.bind(n,1285,19))},"~blog/default/metals-blog-page-29-2a4.json",1285],c424153c:[function(){return n.e(2994).then(n.bind(n,7239))},"@site/blog/2020-04-10-cobalt.md",7239],c4f5d8e4:[function(){return n.e(4195).then(n.bind(n,2841))},"@site/src/pages/index.js",2841],c64e8655:[function(){return n.e(8784).then(n.bind(n,5579))},"@site/target/docs/contributors/project-goals.md",5579],c6da16b1:[function(){return n.e(7696).then(n.t.bind(n,6964,19))},"~blog/default/metals-blog-page-36-aa5.json",6964],c7875d0d:[function(){return n.e(758).then(n.bind(n,4409))},"@site/blog/2023-08-28-silver.md",4409],cabfa371:[function(){return n.e(4073).then(n.bind(n,4895))},"@site/blog/2022-01-12-aluminium.md",4895],cb899f97:[function(){return n.e(2057).then(n.t.bind(n,2310,19))},"~blog/default/metals-blog-page-42-d3a.json",2310],cc1c03c7:[function(){return n.e(8313).then(n.bind(n,1089))},"@site/blog/2023-03-02-aluminium.md?truncated=true",1089],cc709768:[function(){return n.e(8858).then(n.bind(n,7296))},"@site/blog/2021-01-19-lithium.md?truncated=true",7296],ccc49370:[function(){return Promise.all([n.e(532),n.e(394),n.e(6048),n.e(6103)]).then(n.bind(n,5203))},"@theme/BlogPostPage",5203],cfe9f849:[function(){return n.e(4117).then(n.bind(n,8262))},"@site/blog/2020-05-04-lithium.md",8262],d11fc459:[function(){return n.e(5780).then(n.bind(n,727))},"@site/blog/2021-04-20-tungsten.md?truncated=true",727],d24c97fd:[function(){return n.e(8255).then(n.bind(n,3051))},"@site/blog/2022-04-27-aluminium.md",3051],d3dc0327:[function(){return n.e(6105).then(n.bind(n,5563))},"@site/blog/2020-01-10-cobalt.md?truncated=true",5563],d4d282d4:[function(){return n.e(6373).then(n.bind(n,4414))},"@site/blog/2022-10-06-aluminium.md?truncated=true",4414],d7024f94:[function(){return n.e(8180).then(n.t.bind(n,2379,19))},"~blog/default/metals-blog-page-11-d73.json",2379],d8176b79:[function(){return n.e(1650).then(n.t.bind(n,5745,19))},"/home/runner/work/metals/metals/website/.docusaurus/docusaurus-plugin-content-pages/default/plugin-route-context-module-100.json",5745],d8beb153:[function(){return n.e(9604).then(n.bind(n,9796))},"@site/blog/2023-07-17-workspace-folders.md",9796],d8cf581d:[function(){return n.e(3290).then(n.t.bind(n,2776,19))},"/home/runner/work/metals/metals/website/.docusaurus/@easyops-cn/docusaurus-search-local/default/plugin-route-context-module-100.json",2776],d94b0c5c:[function(){return n.e(7792).then(n.bind(n,2262))},"@site/blog/2021-05-17-tungsten.md",2262],da363e62:[function(){return n.e(5555).then(n.t.bind(n,7688,19))},"~blog/default/metals-blog-archive-d94.json",7688],db18f655:[function(){return n.e(4372).then(n.bind(n,607))},"@site/blog/2023-03-02-aluminium.md",607],dc0c48b3:[function(){return n.e(8534).then(n.bind(n,761))},"@site/blog/2020-07-23-configuring-a-client.md",761],dd4c9461:[function(){return n.e(8225).then(n.bind(n,7911))},"@site/blog/2023-04-21-aluminium.md",7911],df53e5ec:[function(){return n.e(450).then(n.bind(n,6093))},"@site/blog/2023-07-17-workspace-folders.md?truncated=true",6093],e2e5f5d1:[function(){return n.e(363).then(n.bind(n,6625))},"@site/blog/2022-01-17-aluminium.md?truncated=true",6625],e38d6f3f:[function(){return n.e(4355).then(n.t.bind(n,1863,19))},"~blog/default/metals-blog-page-22-3e0.json",1863],e68a2502:[function(){return n.e(6290).then(n.bind(n,6810))},"@site/blog/2019-04-26-mercury.md",6810],e82430ca:[function(){return n.e(5411).then(n.t.bind(n,2121,19))},"~blog/default/metals-blog-page-47-8cb.json",2121],e879be1f:[function(){return n.e(7591).then(n.t.bind(n,6213,19))},"~blog/default/metals-blog-page-45-113.json",6213],e882c012:[function(){return n.e(6275).then(n.bind(n,4102))},"@site/blog/2019-01-24-tin.md",4102],e8c5917f:[function(){return n.e(6633).then(n.bind(n,203))},"@site/blog/2022-08-10-aluminium.md",203],e9356b00:[function(){return n.e(608).then(n.bind(n,5800))},"@site/blog/2021-04-20-tungsten.md",5800],eac4f91f:[function(){return n.e(3808).then(n.t.bind(n,3808,19))},"~blog/default/metals-blog-page-52-e3a.json",3808],eae80572:[function(){return n.e(7457).then(n.bind(n,2470))},"@site/blog/2021-04-06-tungsten.md",2470],ed7c6679:[function(){return n.e(9025).then(n.bind(n,3463))},"@site/blog/2020-04-10-cobalt.md?truncated=true",3463],ef440da7:[function(){return n.e(2172).then(n.t.bind(n,4469,19))},"/home/runner/work/metals/metals/website/.docusaurus/docusaurus-plugin-content-blog/default/plugin-route-context-module-100.json",4469],ef96a7a2:[function(){return n.e(600).then(n.t.bind(n,3769,19))},"/home/runner/work/metals/metals/website/.docusaurus/docusaurus-plugin-content-docs/default/plugin-route-context-module-100.json",3769],f0507210:[function(){return n.e(9289).then(n.bind(n,2761))},"@site/target/docs/integrations/remote-language-server.md",2761],f1a7d268:[function(){return n.e(1228).then(n.bind(n,5761))},"@site/blog/2021-09-16-tungsten.md?truncated=true",5761],f3503827:[function(){return n.e(3827).then(n.bind(n,4506))},"@site/target/docs/build-tools/bloop.md",4506],f78a808a:[function(){return n.e(7962).then(n.bind(n,2886))},"@site/blog/2023-08-28-silver.md?truncated=true",2886],f87b843d:[function(){return n.e(2726).then(n.t.bind(n,6272,19))},"~blog/default/metals-blog-page-49-a73.json",6272],f9150bb6:[function(){return n.e(50).then(n.t.bind(n,1455,19))},"~blog/default/metals-blog-page-48-2f5.json",1455],f922820e:[function(){return n.e(4807).then(n.bind(n,4239))},"@site/blog/2023-07-19-silver.md",4239],fb11efee:[function(){return n.e(3758).then(n.t.bind(n,8027,19))},"~blog/default/metals-blog-page-21-4bb.json",8027],fda909f7:[function(){return n.e(7631).then(n.bind(n,7318))},"@site/blog/2021-07-14-tungsten.md",7318]};function u(e){var t=e.error,n=e.retry,a=e.pastDelay;return t?r.createElement("div",{style:{textAlign:"center",color:"#fff",backgroundColor:"#fa383e",borderColor:"#fa383e",borderStyle:"solid",borderRadius:"0.25rem",borderWidth:"1px",boxSizing:"border-box",display:"block",padding:"1rem",flex:"0 0 50%",marginLeft:"25%",marginRight:"25%",marginTop:"5rem",maxWidth:"50%",width:"100%"}},r.createElement("p",null,String(t)),r.createElement("div",null,r.createElement("button",{type:"button",onClick:n},"Retry"))):a?r.createElement("div",{style:{display:"flex",justifyContent:"center",alignItems:"center",height:"100vh"}},r.createElement("svg",{id:"loader",style:{width:128,height:110,position:"absolute",top:"calc(100vh - 64%)"},viewBox:"0 0 45 45",xmlns:"http://www.w3.org/2000/svg",stroke:"#61dafb"},r.createElement("g",{fill:"none",fillRule:"evenodd",transform:"translate(1 1)",strokeWidth:"2"},r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"1.5s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"1.5s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"1.5s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"6",strokeOpacity:"0"},r.createElement("animate",{attributeName:"r",begin:"3s",dur:"3s",values:"6;22",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-opacity",begin:"3s",dur:"3s",values:"1;0",calcMode:"linear",repeatCount:"indefinite"}),r.createElement("animate",{attributeName:"stroke-width",begin:"3s",dur:"3s",values:"2;0",calcMode:"linear",repeatCount:"indefinite"})),r.createElement("circle",{cx:"22",cy:"22",r:"8"},r.createElement("animate",{attributeName:"r",begin:"0s",dur:"1.5s",values:"6;1;2;3;4;5;6",calcMode:"linear",repeatCount:"indefinite"}))))):null}var c=n(9670),d=n(226);function f(e,t){if("*"===e)return i()({loading:u,loader:function(){return n.e(4972).then(n.bind(n,4972))},modules:["@theme/NotFound"],webpack:function(){return[4972]},render:function(e,t){var n=e.default;return r.createElement(d.z,{value:{plugin:{name:"native",id:"default"}}},r.createElement(n,t))}});var o=l[e+"-"+t],f={},p=[],m=[],g=(0,c.Z)(o);return Object.entries(g).forEach((function(e){var t=e[0],n=e[1],r=s[n];r&&(f[t]=r[0],p.push(r[1]),m.push(r[2]))})),i().Map({loading:u,loader:f,modules:p,webpack:function(){return m},render:function(t,n){var i=JSON.parse(JSON.stringify(o));Object.entries(t).forEach((function(t){var n=t[0],r=t[1],a=r.default;if(!a)throw new Error("The page component at "+e+" doesn't have a default export. This makes it impossible to render anything. Consider default-exporting a React component.");"object"!=typeof a&&"function"!=typeof a||Object.keys(r).filter((function(e){return"default"!==e})).forEach((function(e){a[e]=r[e]}));var o=i,l=n.split(".");l.slice(0,-1).forEach((function(e){o=o[e]})),o[l[l.length-1]]=a}));var l=i.__comp;delete i.__comp;var s=i.__context;return delete i.__context,r.createElement(d.z,{value:s},r.createElement(l,(0,a.Z)({},i,n)))}})}const p=[{path:"/metals/blog",component:f("/metals/blog","d6a"),exact:!0},{path:"/metals/blog/2018/12/06/iron",component:f("/metals/blog/2018/12/06/iron","935"),exact:!0},{path:"/metals/blog/2018/12/12/fast-goto-definition",component:f("/metals/blog/2018/12/12/fast-goto-definition","7cc"),exact:!0},{path:"/metals/blog/2018/12/14/iron",component:f("/metals/blog/2018/12/14/iron","36f"),exact:!0},{path:"/metals/blog/2019/01/22/bloom-filters",component:f("/metals/blog/2019/01/22/bloom-filters","208"),exact:!0},{path:"/metals/blog/2019/01/24/tin",component:f("/metals/blog/2019/01/24/tin","c8d"),exact:!0},{path:"/metals/blog/2019/02/01/tin",component:f("/metals/blog/2019/02/01/tin","872"),exact:!0},{path:"/metals/blog/2019/04/12/mercury",component:f("/metals/blog/2019/04/12/mercury","9d1"),exact:!0},{path:"/metals/blog/2019/04/26/mercury",component:f("/metals/blog/2019/04/26/mercury","f9e"),exact:!0},{path:"/metals/blog/2019/06/11/radium",component:f("/metals/blog/2019/06/11/radium","294"),exact:!0},{path:"/metals/blog/2019/06/28/thorium",component:f("/metals/blog/2019/06/28/thorium","c3d"),exact:!0},{path:"/metals/blog/2019/09/02/thorium",component:f("/metals/blog/2019/09/02/thorium","db9"),exact:!0},{path:"/metals/blog/2019/09/12/thorium",component:f("/metals/blog/2019/09/12/thorium","139"),exact:!0},{path:"/metals/blog/2019/09/23/thorium",component:f("/metals/blog/2019/09/23/thorium","456"),exact:!0},{path:"/metals/blog/2020/01/10/cobalt",component:f("/metals/blog/2020/01/10/cobalt","821"),exact:!0},{path:"/metals/blog/2020/02/26/cobalt",component:f("/metals/blog/2020/02/26/cobalt","765"),exact:!0},{path:"/metals/blog/2020/03/19/cobalt",component:f("/metals/blog/2020/03/19/cobalt","b1c"),exact:!0},{path:"/metals/blog/2020/04/10/cobalt",component:f("/metals/blog/2020/04/10/cobalt","e65"),exact:!0},{path:"/metals/blog/2020/04/12/mercury",component:f("/metals/blog/2020/04/12/mercury","aee"),exact:!0},{path:"/metals/blog/2020/05/04/lithium",component:f("/metals/blog/2020/05/04/lithium","b0e"),exact:!0},{path:"/metals/blog/2020/07/01/lithium",component:f("/metals/blog/2020/07/01/lithium","388"),exact:!0},{path:"/metals/blog/2020/07/15/lithium",component:f("/metals/blog/2020/07/15/lithium","993"),exact:!0},{path:"/metals/blog/2020/07/23/configuring-a-client",component:f("/metals/blog/2020/07/23/configuring-a-client","21c"),exact:!0},{path:"/metals/blog/2020/08/19/lithium",component:f("/metals/blog/2020/08/19/lithium","5ac"),exact:!0},{path:"/metals/blog/2020/09/21/lithium",component:f("/metals/blog/2020/09/21/lithium","8f1"),exact:!0},{path:"/metals/blog/2020/11/06/sbt-BSP-support",component:f("/metals/blog/2020/11/06/sbt-BSP-support","080"),exact:!0},{path:"/metals/blog/2020/11/10/lithium",component:f("/metals/blog/2020/11/10/lithium","fb8"),exact:!0},{path:"/metals/blog/2020/11/20/lithium",component:f("/metals/blog/2020/11/20/lithium","4c6"),exact:!0},{path:"/metals/blog/2020/11/26/lithium",component:f("/metals/blog/2020/11/26/lithium","0bc"),exact:!0},{path:"/metals/blog/2020/12/19/lithium",component:f("/metals/blog/2020/12/19/lithium","749"),exact:!0},{path:"/metals/blog/2021/01/19/lithium",component:f("/metals/blog/2021/01/19/lithium","596"),exact:!0},{path:"/metals/blog/2021/02/02/metals-retro-part1",component:f("/metals/blog/2021/02/02/metals-retro-part1","0a1"),exact:!0},{path:"/metals/blog/2021/02/24/tungsten",component:f("/metals/blog/2021/02/24/tungsten","c0d"),exact:!0},{path:"/metals/blog/2021/04/06/tungsten",component:f("/metals/blog/2021/04/06/tungsten","4b8"),exact:!0},{path:"/metals/blog/2021/04/20/tungsten",component:f("/metals/blog/2021/04/20/tungsten","949"),exact:!0},{path:"/metals/blog/2021/05/17/tungsten",component:f("/metals/blog/2021/05/17/tungsten","57d"),exact:!0},{path:"/metals/blog/2021/05/31/tungsten",component:f("/metals/blog/2021/05/31/tungsten","daf"),exact:!0},{path:"/metals/blog/2021/07/14/tungsten",component:f("/metals/blog/2021/07/14/tungsten","824"),exact:!0},{path:"/metals/blog/2021/09/06/tungsten",component:f("/metals/blog/2021/09/06/tungsten","fc2"),exact:!0},{path:"/metals/blog/2021/09/16/tungsten",component:f("/metals/blog/2021/09/16/tungsten","4f3"),exact:!0},{path:"/metals/blog/2021/10/26/tungsten",component:f("/metals/blog/2021/10/26/tungsten","f60"),exact:!0},{path:"/metals/blog/2021/11/03/tungsten",component:f("/metals/blog/2021/11/03/tungsten","7de"),exact:!0},{path:"/metals/blog/2022/01/12/aluminium",component:f("/metals/blog/2022/01/12/aluminium","0c3"),exact:!0},{path:"/metals/blog/2022/01/17/aluminium",component:f("/metals/blog/2022/01/17/aluminium","b4d"),exact:!0},{path:"/metals/blog/2022/02/23/towards-better-releases",component:f("/metals/blog/2022/02/23/towards-better-releases","510"),exact:!0},{path:"/metals/blog/2022/03/08/aluminium",component:f("/metals/blog/2022/03/08/aluminium","3df"),exact:!0},{path:"/metals/blog/2022/04/26/aluminium",component:f("/metals/blog/2022/04/26/aluminium","9db"),exact:!0},{path:"/metals/blog/2022/04/27/aluminium",component:f("/metals/blog/2022/04/27/aluminium","1e7"),exact:!0},{path:"/metals/blog/2022/04/28/aluminium",component:f("/metals/blog/2022/04/28/aluminium","91e"),exact:!0},{path:"/metals/blog/2022/06/03/aluminium",component:f("/metals/blog/2022/06/03/aluminium","0e3"),exact:!0},{path:"/metals/blog/2022/07/04/aluminium",component:f("/metals/blog/2022/07/04/aluminium","76f"),exact:!0},{path:"/metals/blog/2022/08/10/aluminium",component:f("/metals/blog/2022/08/10/aluminium","f97"),exact:!0},{path:"/metals/blog/2022/10/06/aluminium",component:f("/metals/blog/2022/10/06/aluminium","b38"),exact:!0},{path:"/metals/blog/2023/01/02/aluminium",component:f("/metals/blog/2023/01/02/aluminium","289"),exact:!0},{path:"/metals/blog/2023/03/02/aluminium",component:f("/metals/blog/2023/03/02/aluminium","aef"),exact:!0},{path:"/metals/blog/2023/04/21/aluminium",component:f("/metals/blog/2023/04/21/aluminium","eb5"),exact:!0},{path:"/metals/blog/2023/07/17/workspace-folders",component:f("/metals/blog/2023/07/17/workspace-folders","2c8"),exact:!0},{path:"/metals/blog/2023/07/19/silver",component:f("/metals/blog/2023/07/19/silver","eb6"),exact:!0},{path:"/metals/blog/2023/08/28/silver",component:f("/metals/blog/2023/08/28/silver","7a2"),exact:!0},{path:"/metals/blog/archive",component:f("/metals/blog/archive","857"),exact:!0},{path:"/metals/blog/page/10",component:f("/metals/blog/page/10","b68"),exact:!0},{path:"/metals/blog/page/11",component:f("/metals/blog/page/11","a92"),exact:!0},{path:"/metals/blog/page/12",component:f("/metals/blog/page/12","3e4"),exact:!0},{path:"/metals/blog/page/13",component:f("/metals/blog/page/13","766"),exact:!0},{path:"/metals/blog/page/14",component:f("/metals/blog/page/14","323"),exact:!0},{path:"/metals/blog/page/15",component:f("/metals/blog/page/15","0e4"),exact:!0},{path:"/metals/blog/page/16",component:f("/metals/blog/page/16","709"),exact:!0},{path:"/metals/blog/page/17",component:f("/metals/blog/page/17","c6f"),exact:!0},{path:"/metals/blog/page/18",component:f("/metals/blog/page/18","ff3"),exact:!0},{path:"/metals/blog/page/19",component:f("/metals/blog/page/19","e6e"),exact:!0},{path:"/metals/blog/page/2",component:f("/metals/blog/page/2","27f"),exact:!0},{path:"/metals/blog/page/20",component:f("/metals/blog/page/20","8bf"),exact:!0},{path:"/metals/blog/page/21",component:f("/metals/blog/page/21","0a8"),exact:!0},{path:"/metals/blog/page/22",component:f("/metals/blog/page/22","ee9"),exact:!0},{path:"/metals/blog/page/23",component:f("/metals/blog/page/23","4a3"),exact:!0},{path:"/metals/blog/page/24",component:f("/metals/blog/page/24","d59"),exact:!0},{path:"/metals/blog/page/25",component:f("/metals/blog/page/25","318"),exact:!0},{path:"/metals/blog/page/26",component:f("/metals/blog/page/26","8c6"),exact:!0},{path:"/metals/blog/page/27",component:f("/metals/blog/page/27","0f1"),exact:!0},{path:"/metals/blog/page/28",component:f("/metals/blog/page/28","0f7"),exact:!0},{path:"/metals/blog/page/29",component:f("/metals/blog/page/29","1d8"),exact:!0},{path:"/metals/blog/page/3",component:f("/metals/blog/page/3","657"),exact:!0},{path:"/metals/blog/page/30",component:f("/metals/blog/page/30","373"),exact:!0},{path:"/metals/blog/page/31",component:f("/metals/blog/page/31","479"),exact:!0},{path:"/metals/blog/page/32",component:f("/metals/blog/page/32","400"),exact:!0},{path:"/metals/blog/page/33",component:f("/metals/blog/page/33","33e"),exact:!0},{path:"/metals/blog/page/34",component:f("/metals/blog/page/34","11c"),exact:!0},{path:"/metals/blog/page/35",component:f("/metals/blog/page/35","555"),exact:!0},{path:"/metals/blog/page/36",component:f("/metals/blog/page/36","b80"),exact:!0},{path:"/metals/blog/page/37",component:f("/metals/blog/page/37","b60"),exact:!0},{path:"/metals/blog/page/38",component:f("/metals/blog/page/38","815"),exact:!0},{path:"/metals/blog/page/39",component:f("/metals/blog/page/39","72a"),exact:!0},{path:"/metals/blog/page/4",component:f("/metals/blog/page/4","261"),exact:!0},{path:"/metals/blog/page/40",component:f("/metals/blog/page/40","a32"),exact:!0},{path:"/metals/blog/page/41",component:f("/metals/blog/page/41","ad0"),exact:!0},{path:"/metals/blog/page/42",component:f("/metals/blog/page/42","c48"),exact:!0},{path:"/metals/blog/page/43",component:f("/metals/blog/page/43","d42"),exact:!0},{path:"/metals/blog/page/44",component:f("/metals/blog/page/44","bc2"),exact:!0},{path:"/metals/blog/page/45",component:f("/metals/blog/page/45","b2d"),exact:!0},{path:"/metals/blog/page/46",component:f("/metals/blog/page/46","a55"),exact:!0},{path:"/metals/blog/page/47",component:f("/metals/blog/page/47","22d"),exact:!0},{path:"/metals/blog/page/48",component:f("/metals/blog/page/48","e6d"),exact:!0},{path:"/metals/blog/page/49",component:f("/metals/blog/page/49","470"),exact:!0},{path:"/metals/blog/page/5",component:f("/metals/blog/page/5","4db"),exact:!0},{path:"/metals/blog/page/50",component:f("/metals/blog/page/50","bc9"),exact:!0},{path:"/metals/blog/page/51",component:f("/metals/blog/page/51","6e7"),exact:!0},{path:"/metals/blog/page/52",component:f("/metals/blog/page/52","319"),exact:!0},{path:"/metals/blog/page/53",component:f("/metals/blog/page/53","f9e"),exact:!0},{path:"/metals/blog/page/54",component:f("/metals/blog/page/54","3d9"),exact:!0},{path:"/metals/blog/page/55",component:f("/metals/blog/page/55","1e8"),exact:!0},{path:"/metals/blog/page/56",component:f("/metals/blog/page/56","68f"),exact:!0},{path:"/metals/blog/page/57",component:f("/metals/blog/page/57","7e9"),exact:!0},{path:"/metals/blog/page/58",component:f("/metals/blog/page/58","957"),exact:!0},{path:"/metals/blog/page/6",component:f("/metals/blog/page/6","277"),exact:!0},{path:"/metals/blog/page/7",component:f("/metals/blog/page/7","700"),exact:!0},{path:"/metals/blog/page/8",component:f("/metals/blog/page/8","2fc"),exact:!0},{path:"/metals/blog/page/9",component:f("/metals/blog/page/9","1fd"),exact:!0},{path:"/metals/search",component:f("/metals/search","b6a"),exact:!0},{path:"/metals/docs",component:f("/metals/docs","c9d"),routes:[{path:"/metals/docs/",component:f("/metals/docs/","436"),exact:!0,sidebar:"docs"},{path:"/metals/docs/build-tools/bloop",component:f("/metals/docs/build-tools/bloop","89f"),exact:!0,sidebar:"docs"},{path:"/metals/docs/build-tools/gradle",component:f("/metals/docs/build-tools/gradle","7ea"),exact:!0,sidebar:"docs"},{path:"/metals/docs/build-tools/maven",component:f("/metals/docs/build-tools/maven","d5a"),exact:!0,sidebar:"docs"},{path:"/metals/docs/build-tools/mill",component:f("/metals/docs/build-tools/mill","ec6"),exact:!0,sidebar:"docs"},{path:"/metals/docs/build-tools/overview",component:f("/metals/docs/build-tools/overview","1fd"),exact:!0,sidebar:"docs"},{path:"/metals/docs/build-tools/sbt",component:f("/metals/docs/build-tools/sbt","fee"),exact:!0,sidebar:"docs"},{path:"/metals/docs/contributors/getting-started",component:f("/metals/docs/contributors/getting-started","31b"),exact:!0,sidebar:"docs"},{path:"/metals/docs/contributors/project-goals",component:f("/metals/docs/contributors/project-goals","46c"),exact:!0,sidebar:"docs"},{path:"/metals/docs/contributors/releasing",component:f("/metals/docs/contributors/releasing","550"),exact:!0,sidebar:"docs"},{path:"/metals/docs/contributors/updating-website",component:f("/metals/docs/contributors/updating-website","918"),exact:!0,sidebar:"docs"},{path:"/metals/docs/diagrams/instruction",component:f("/metals/docs/diagrams/instruction","f59"),exact:!0},{path:"/metals/docs/editors/emacs",component:f("/metals/docs/editors/emacs","a6f"),exact:!0,sidebar:"docs"},{path:"/metals/docs/editors/online-ides",component:f("/metals/docs/editors/online-ides","00b"),exact:!0,sidebar:"docs"},{path:"/metals/docs/editors/sublime",component:f("/metals/docs/editors/sublime","921"),exact:!0,sidebar:"docs"},{path:"/metals/docs/editors/user-configuration",component:f("/metals/docs/editors/user-configuration","154"),exact:!0,sidebar:"docs"},{path:"/metals/docs/editors/vim",component:f("/metals/docs/editors/vim","06e"),exact:!0,sidebar:"docs"},{path:"/metals/docs/editors/vscode",component:f("/metals/docs/editors/vscode","fa2"),exact:!0,sidebar:"docs"},{path:"/metals/docs/features/codeactions",component:f("/metals/docs/features/codeactions","306"),exact:!0,sidebar:"docs"},{path:"/metals/docs/features/scripts",component:f("/metals/docs/features/scripts","6c5"),exact:!0,sidebar:"docs"},{path:"/metals/docs/integrations/debug-adapter-protocol",component:f("/metals/docs/integrations/debug-adapter-protocol","899"),exact:!0,sidebar:"docs"},{path:"/metals/docs/integrations/decoration-protocol",component:f("/metals/docs/integrations/decoration-protocol","9ed"),exact:!0,sidebar:"docs"},{path:"/metals/docs/integrations/new-build-tool",component:f("/metals/docs/integrations/new-build-tool","332"),exact:!0,sidebar:"docs"},{path:"/metals/docs/integrations/new-editor",component:f("/metals/docs/integrations/new-editor","3f0"),exact:!0,sidebar:"docs"},{path:"/metals/docs/integrations/remote-language-server",component:f("/metals/docs/integrations/remote-language-server","c40"),exact:!0,sidebar:"docs"},{path:"/metals/docs/integrations/test-explorer",component:f("/metals/docs/integrations/test-explorer","afb"),exact:!0,sidebar:"docs"},{path:"/metals/docs/integrations/tree-view-protocol",component:f("/metals/docs/integrations/tree-view-protocol","33c"),exact:!0,sidebar:"docs"},{path:"/metals/docs/troubleshooting/faq",component:f("/metals/docs/troubleshooting/faq","261"),exact:!0,sidebar:"docs"},{path:"/metals/docs/troubleshooting/proxy",component:f("/metals/docs/troubleshooting/proxy","4bf"),exact:!0,sidebar:"docs"}]},{path:"/metals/",component:f("/metals/","925"),exact:!0},{path:"*",component:f("*")}]},8934:(e,t,n)=>{"use strict";n.d(t,{_:()=>a,t:()=>o});var r=n(7294),a=r.createContext(!1);function o(e){var t=e.children,n=(0,r.useState)(!1),o=n[0],i=n[1];return(0,r.useEffect)((function(){i(!0)}),[]),r.createElement(a.Provider,{value:o},t)}},9383:(e,t,n)=>{"use strict";var r=n(7294),a=n(3935),o=n(3727),i=n(405),l=n(412);const s=[n(6657),n(2497),n(3310),n(8320),n(7253)];var u=n(723),c=n(6550),d=n(8790);function f(e){var t=e.children;return r.createElement(r.Fragment,null,t)}var p=n(7462),m=n(5742),g=n(2263),h=n(4996),b=n(6668),v=n(1944),y=n(4711),w=n(9727),k=n(3320),E=n(197);function x(){var e=(0,g.Z)().i18n,t=e.defaultLocale,n=e.localeConfigs,a=(0,y.l)();return r.createElement(m.Z,null,Object.entries(n).map((function(e){var t=e[0],n=e[1].htmlLang;return r.createElement("link",{key:t,rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:n})})),r.createElement("link",{rel:"alternate",href:a.createUrl({locale:t,fullyQualified:!0}),hrefLang:"x-default"}))}function _(e){var t=e.permalink,n=(0,g.Z)().siteConfig.url,a=function(){var e=(0,g.Z)().siteConfig.url,t=(0,c.TH)().pathname;return e+(0,h.Z)(t)}(),o=t?""+n+t:a;return r.createElement(m.Z,null,r.createElement("meta",{property:"og:url",content:o}),r.createElement("link",{rel:"canonical",href:o}))}function S(){var e=(0,g.Z)().i18n.currentLocale,t=(0,b.L)(),n=t.metadata,a=t.image;return r.createElement(r.Fragment,null,r.createElement(m.Z,null,r.createElement("meta",{name:"twitter:card",content:"summary_large_image"}),r.createElement("body",{className:w.h})),a&&r.createElement(v.d,{image:a}),r.createElement(_,null),r.createElement(x,null),r.createElement(E.Z,{tag:k.HX,locale:e}),r.createElement(m.Z,null,n.map((function(e,t){return r.createElement("meta",(0,p.Z)({key:t},e))}))))}var C=new Map;function T(e){if(C.has(e.pathname))return Object.assign({},e,{pathname:C.get(e.pathname)});if((0,d.f)(u.Z,e.pathname).some((function(e){return!0===e.route.exact})))return C.set(e.pathname,e.pathname),e;var t=e.pathname.trim().replace(/(?:\/index)?\.html$/,"")||"/";return C.set(e.pathname,t),Object.assign({},e,{pathname:t})}var L=n(8934),A=n(8940),D=n(4578);function P(e){for(var t=arguments.length,n=new Array(t>1?t-1:0),r=1;r\n
\n '},{html:'\n 
\n '},{html:'\n