Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A new page about Scala IDEs + reordering of Getting Started #3042

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion _data/doc-nav-header.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
- title: Getting Started
url: "/getting-started/index.html"
url: "#"
submenu:
- title: Install Scala
url: "/getting-started/install-scala.html"
- title: Scala IDEs
url: "/getting-started/scala-ides.html"
- title: Scala 3
url: "#"
submenu:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,7 @@ and in the official sbt [documentation](https://www.scala-sbt.org/1.x/docs/index

### With an IDE

You can skip the rest of this page and go directly to [Building a Scala Project with IntelliJ and sbt](/getting-started/intellij-track/building-a-scala-project-with-intellij-and-sbt.html)

You can read a short summary of Scala IDEs on [a dedicated page](/getting-started/scala-ides.html)

## Open hello-world project

Expand Down
43 changes: 43 additions & 0 deletions _overviews/getting-started/scala-ides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
layout: singlepage-overview
title: Scala IDEs

partof: scala-ides

permalink: /tutorials/:title.html
Copy link
Member

@bishabosha bishabosha Oct 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this permalink is the source of the HTMLproofer errors - the url is /tutorials/scala-ides.html - but the navbar expects /getting-started/scala-ides.html, so you should change to

Suggested change
permalink: /tutorials/:title.html
permalink: /getting-started/:title.html


keywords:
- Scala
- IDE
- JetBrains
- IntelliJ
- VSCode
- Metals
---

## Introduction

Theoretically, you can write Scala code even in a notepad and compile and run the code from the terminal. When you do it, the compiler will tell you if it encounters any problems and suggest changes. You can apply that feedback in the notepad and try again.

However, this way of software development will quickly prove to be unusable when you start coding anything more complicated than simple exercises. For larger projects, we highly recommend that you use one of the following IDEs (Integrated Development Environments):

# IntelliJ IDEA + Scala Plugin

[https://jetbrains.com/scala](https://jetbrains.com/scala)

![](../../resources/images/getting-started/IntelliJScala.png)

IntelliJ IDEA is a cross-platform IDE developed by JetBrains that provides a consistent experience for a wide range of programming languages and technologies. It also supports Scala through the IntelliJ Scala Plugin, which is being developed at JetBrains. First, install IntelliJ IDEA Community Edition (unless you don't already use the Ultimate edition) and then add the IntelliJ Scala Plugin.

IntelliJ IDEA and Scala Plugin will assist you in virtually every part of a Scala software developer's work. Use it if you like a solid integrated experience, sane default settings, and tested solutions.

For more information, check out our tutorial [Getting Started with Scala in IntelliJ](/getting-started/intellij-track/building-a-scala-project-with-intellij-and-sbt.html)

# Visual Studio Code + Metals

[https://scalameta.org/metals](https://scalameta.org/metals)

![](../../resources/images/getting-started/VSCodeMetals.png)

Visual Studio Code, commonly called VS Code, is a source code editor developed by Microsoft. Similar to how IntelliJ IDEA requires IntelliJ Scala Plugin to support Scala, you can get support for Scala in VS Code by installing an extension: Metals by Scalameta. In contrast to IntelliJ IDEA + Scala Plugin, VS Code + Metals is is aimed at people who like to get feedback and code intelligence straight from the compiler, which enables them to also try out experimental Scala features. Besides, Metals - as an [language server](https://microsoft.github.io/language-server-protocol/) - is also available to use with a variety of other source-code editors, such as Vim, Sublime Text, Zed, Helix and Emacs, which means that you will get a similar experience in any of them.

2 changes: 1 addition & 1 deletion _overviews/scala3-book/taste-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ can be installed by following our [getting started guide][get-started].


[reference]: {{ site.scala3ref }}/overview.html
[get-started]: {% link _overviews/getting-started/index.md %}
[get-started]: {% link _overviews/getting-started/install-scala.md %}
2 changes: 1 addition & 1 deletion _ru/scala3/book/taste-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ next-page: taste-hello-world


[reference]: {{ site.scala3ref }}/overview.html
[get-started]: {% link _overviews/getting-started/index.md %}
[get-started]: {% link _overviews/getting-started/install-scala.md %}
2 changes: 1 addition & 1 deletion _zh-cn/overviews/scala3-book/taste-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ permalink: "/zh-cn/scala3/book/:title.html"
> 或者,您可以使用 [Scastie](https://scastie.scala-lang.org) 在 Web 浏览器中运行这些示例,这是一个完全在线的编辑器和 Scala 的代码运行器。

[reference]: {{ site.scala3ref }}/overview.html
[get-started]: {% link _overviews/getting-started/index.md %}
[get-started]: {% link _overviews/getting-started/install-scala.md %}
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ sections:
- title: "Getting Started"
description: "Install Scala on your computer and start writing some Scala code!"
icon: "fa fa-rocket"
link: /getting-started.html
link: /getting-started/install-scala.html
- title: "Tour of Scala"
description: "Bite-sized introductions to core language features."
icon: "fa fa-flag"
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading