Skip to content

Commit

Permalink
docs: use authors.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
nocontribute authored and tgodzik committed Nov 24, 2024
1 parent 2fb35b5 commit 3eb4009
Show file tree
Hide file tree
Showing 69 changed files with 1,258 additions and 963 deletions.
4 changes: 1 addition & 3 deletions website/blog/2018-12-06-iron.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Metals v0.3 - Iron
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

We are excited to announce the release of Metals v0.3, codename "Iron" 🎉 Metals
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2018-12-12-fast-goto-definition.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Fast goto definition with low memory footprint
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

Metals throws away its navigation index when it shuts down. Next time it starts,
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2018-12-14-iron.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Metals v0.3.2 - Iron
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

We are pleased to announce the release of Metals v0.3.2. Metals is a language
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-01-22-bloom-filters.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Low-memory symbol indexing with bloom filters
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

The latest Metals release introduces three new in-memory indexes to implement
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-01-24-tin.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Metals v0.4.0 - Tin
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

We are excited to announce the release of Metals v0.4, codename "Tin" 🎉 Metals
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-02-01-tin.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Metals v0.4.4 - Tin
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

Metals is a language server for Scala that works with VS Code, Atom, Vim,
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-04-12-mercury.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Metals v0.5.0 - Mercury
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

We are excited to announce the release of Metals v0.5, codename "Mercury" 🎉
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-04-26-mercury.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Metals v0.5.1 - Mercury
authorURL: https://twitter.com/olafurpg
authorImageURL: https://avatars2.githubusercontent.com/u/1408093?s=460&v=4
---

This release introduces minor improvements and bug fixes with highlights
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-06-11-radium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.6.1 - Radium
authorURL: https://twitter.com/tomekgodzik
authorImageURL: https://avatars1.githubusercontent.com/u/3807253?s=460&v=4
---

We are excited to announce the release of Metals v0.6.1, codename "Radium" 🎉
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-06-28-thorium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Ólafur Páll Geirsson
authors: olafurpg
title: Metals v0.7.0 - Thorium
authorURL: https://twitter.com/olafurpg
authorImageURL: https://github.com/olafurpg.png
---

We are excited to announce the release of Metals v0.7.0 - codename "Thorium" 🎉
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-09-02-thorium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.7.2 - Thorium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are excited to announce the release of Metals v0.7.2 - codename "Thorium" 🎉
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-09-12-thorium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.7.5 - Thorium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are excited to announce the release of Metals v0.7.5 - codename "Thorium" 🎉
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2019-09-23-thorium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.7.6 - Thorium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are excited to announce the release of Metals v0.7.6, which will most likely
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2020-01-10-cobalt.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.8.0 - Cobalt
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are excited to announce the release of Metals v0.8.0, codename Cobalt. This
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2020-02-26-cobalt.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.8.1 - Cobalt
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are excited to announce the release of Metals v0.8.1. This release includes a
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2020-03-19-cobalt.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.8.3 - Cobalt
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are happy to announce the release of Metals v0.8.3, which main purpose is
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2020-04-10-cobalt.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.8.4 - Cobalt
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are happy to announce the release of Metals v0.8.4, which will most likely be
Expand Down
5 changes: 1 addition & 4 deletions website/blog/2020-05-04-lithium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.9.0 - Lithium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We are happy to announce the release of Metals v0.9.0, codename "Lithium", which
Expand Down Expand Up @@ -160,7 +158,6 @@ Aleksei Alefirov
Naoki Takezoe
Nathaniel Fischer
Tomasz Pasternak
```

## Merged PRs
Expand Down
5 changes: 1 addition & 4 deletions website/blog/2020-07-01-lithium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.9.1 - Lithium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We're happy to announce the release of Metals v0.9.1, which focused on fixing
Expand Down Expand Up @@ -269,7 +267,6 @@ Martin Duhem
ag91
faizk
Łukasz Wawrzyk
```

## Merged PRs
Expand Down
5 changes: 1 addition & 4 deletions website/blog/2020-07-15-lithium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.9.2 - Lithium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We're happy to announce the release of Metals v0.9.2, which mostly adds support
Expand Down Expand Up @@ -85,7 +83,6 @@ Tomasz Godzik
Jorge Vicente Cantero
Claudio Bley
Robin Raju
```

## Merged PRs
Expand Down
55 changes: 27 additions & 28 deletions website/blog/2020-07-23-configuring-a-client.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Chris Kipp
authors: ckipp
title: A Dive into Configuring Metals
authorURL: https://twitter.com/ckipp01
authorImageURL: https://avatars1.githubusercontent.com/u/13974112?s=400&u=7b6a2ddab8eec6f99e4e40ae9b81f71cb5ba92e5&v=4
---

As of this last Metals release, it's now 100% possible to fully configure Metals
Expand All @@ -20,12 +18,12 @@ all the various editors.

Looking back to the Fall of 2018, you see a giant glimpse of Metals becoming
what it is today when looking at a giant commit by
[@olafurpg](https://twitter.com/olafurpg) with the title [Implement pretty
basic language server and build
[@olafurpg](https://twitter.com/olafurpg) with the title
[Implement pretty basic language server and build
client.](https://github.com/scalameta/metals/commit/df6b41acaad1978ffd1fa25c41909c38425932ab).
It's a pretty fascinating commit to look at if you're interested in the
beginnings of Metals, but I want to focus in on a specific file that still exists
today, which is the
beginnings of Metals, but I want to focus in on a specific file that still
exists today, which is the
[MetalsServerConfig.scala](https://github.com/scalameta/metals/commit/df6b41acaad1978ffd1fa25c41909c38425932ab#diff-dc72b5c684177c884881164ab17182eb).
In this file you see the first configuration options that existed for Metals.
You see things like `isLogShowMessage` to ensure users were correctly getting
Expand Down Expand Up @@ -54,6 +52,7 @@ System.getProperty("metals.client", "unknown") match {
)
...
```

The property would then be set when the user would bootstrap Metals. This
started out as a manual process for almost all the editors utilizing
[Coursier](https://github.com/coursier/coursier). This still actually remains a
Expand Down Expand Up @@ -93,7 +92,7 @@ easily change a setting, even while in the editor. For example, we have a
current setting `metals.superMethodLensesEnabled` which when enabled will
display a code lens that when invoked will either go to the parent class
containing the definition of the method or symbol or display the full method
hierarchy allowing you to choose where to go.
hierarchy allowing you to choose where to go.

Here is an example of what this looks like in Vim:
![Super Method Hierarchy](https://i.imgur.com/rEvhzG1.png)
Expand All @@ -106,8 +105,8 @@ configuration value and notify the server via
[`workspace/didChangeConfiguration`](https://microsoft.github.io/language-server-protocol/specification#workspace_didChangeConfiguration).
This can fully happen for most of the user configuration values without any need
to restart the server. You can see the first configuration options added this
way in [this
commit](https://github.com/scalameta/metals/commit/f4706ec75afb9bf797e3144f4a0e91bb0b186e07)
way in
[this commit](https://github.com/scalameta/metals/commit/f4706ec75afb9bf797e3144f4a0e91bb0b186e07)
where the ability to define your `JAVA_HOME` was added. With now allowing for
user configurations in Metals, this allowed for an even more customized
experience.
Expand All @@ -121,15 +120,15 @@ way was needed for the client to express that it supported these extensions.
This is when Metals started to use the
[`ClientCapabilities.experimental`](https://microsoft.github.io/language-server-protocol/specifications/specification-current/#initialize)
field which the client needed to declare support the extension. You can see the
first inklings of this when the [Tree View
Protocol](https://scalameta.org/metals/docs/editors/tree-view-protocol.html) was
introduced [here in this
commit](https://github.com/scalameta/metals/commit/a55a2413ef10237c8510eb707c0de0cd03b83d85#diff-f8c05eebbf12c9c21a7d568f09b500ea).
first inklings of this when the
[Tree View Protocol](https://scalameta.org/metals/docs/editors/tree-view-protocol.html)
was introduced
[here in this commit](https://github.com/scalameta/metals/commit/a55a2413ef10237c8510eb707c0de0cd03b83d85#diff-f8c05eebbf12c9c21a7d568f09b500ea).
This then continued to be further expanded as we introduced more extensions.

As it became easier for various clients to set this, we slowly [started to
migrate](https://github.com/scalameta/metals/pull/1414) other options that could
only be previously set via server properties to
As it became easier for various clients to set this, we slowly
[started to migrate](https://github.com/scalameta/metals/pull/1414) other
options that could only be previously set via server properties to
`ClientCapabilities.experimental`. So settings like which format you'd like the
Doctor to return could now be set directly by the client without need to
bootstrap the server with a specific property. This allowed for much easier
Expand All @@ -149,8 +148,8 @@ configured Metals via `InitializationOptions` without the need to set any server
properties. In theory this also meant that you could not use the same Metals
executable for VS Code, Vim, or Emacs since the server is fully being configured
by the client itself. The current settings that can be passed in and their
defaults are explained in detail [here on the
website](https://scalameta.org/metals/docs/integrations/new-editor#initializationoptions),
defaults are explained in detail
[here on the website](https://scalameta.org/metals/docs/integrations/new-editor#initializationoptions),
but the interface is as follows:

```typescript
Expand All @@ -175,6 +174,7 @@ interface MetalsInitializationOptions {
openNewWindowProvider?: boolean;
}
```

```typescript
interface CompilerInitializationOptions {
completionCommand?: string;
Expand Down Expand Up @@ -203,21 +203,20 @@ While all of the old server properties still exist for Metals, it's no longer
recommended to use them to configure Metals. However, there are still a few
server properties that remain only server properties since they are not meant to
be widely used, and aren't exactly recommended to use for the average user. You
can see an up to date list of these [here on the
website](https://scalameta.org/metals/docs/integrations/new-editor#metals-server-properties)
can see an up to date list of these
[here on the website](https://scalameta.org/metals/docs/integrations/new-editor#metals-server-properties)
and what functionality they provide.

## Conclusion

As of Metals 0.9.2 it's fully possibly for all clients to use a default
bootstrapped Metals that can fully be configured via `InitializationOptions`.
There is a freshly updated [Integrating a new
editor](https://scalameta.org/metals/docs/editors/new-editor.html) section on
the website to help explain how to exactly configure a client for usage with
Metals. As always, don't hesitate to reach out on any of the various channels
located in the footer or submit an issue to either improve documentation or to
log a bug. Also as a reminder, there is a separate repo for
There is a freshly updated
[Integrating a new editor](https://scalameta.org/metals/docs/editors/new-editor.html)
section on the website to help explain how to exactly configure a client for
usage with Metals. As always, don't hesitate to reach out on any of the various
channels located in the footer or submit an issue to either improve
documentation or to log a bug. Also as a reminder, there is a separate repo for
[metals-feature-requests](https://github.com/scalameta/metals-feature-requests).


Happy coding with Metals!
5 changes: 1 addition & 4 deletions website/blog/2020-08-19-lithium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.9.3 - Lithium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We're happy to announce the release of Metals v0.9.3, which adds a couple of
Expand Down Expand Up @@ -137,7 +135,6 @@ Adrien Piquerez
Ayoub Benali
Krzysztof Bochenek
Olafur Pall Geirsson
```

## Merged PRs
Expand Down
4 changes: 1 addition & 3 deletions website/blog/2020-09-21-lithium.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
author: Tomasz Godzik
authors: tgodzik
title: Metals v0.9.4 - Lithium
authorURL: https://twitter.com/TomekGodzik
authorImageURL: https://github.com/tgodzik.png
---

We're happy to announce the release of Metals v0.9.4, which focuses on
Expand Down
Loading

0 comments on commit 3eb4009

Please sign in to comment.