Skip to content

List tools and integrations for working with Please in docs #3535

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.

Sign up for GitHub

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

Open
marcuscaisey wants to merge 1 commit into
base: master
Choose a base branch
from
Open

List tools and integrations for working with Please in docs #3535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/dependencies.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -471,6 +471,6 @@ <h3 class="title-3">
<a class="copy-link" href="/basics.html">Please basics</a>
</div>
<div class="pagination__next">
<a class="copy-link" href="/quickstart_dropoff.html">What's next?</a>
<a class="copy-link" href="/tooling.html">Tooling</a>
</div>
</div>
30 changes: 0 additions & 30 deletions docs/quickstart.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,36 +95,6 @@ <h2 id="shell-completion" class="title-2">Shell completion</h2>
</p>
</section>

<section class="mt4">
<h2 id="lang-server" class="title-2">
BUILD file Language Protocol Server
</h2>

<p>
Please ships with a language server for build files. It follows the
<a
class="copy-link"
href="https://langserver.org/"
target="_blank"
rel="noopener"
>language server protocol</a
>
from VS Code.
</p>

<p>
To use LPS, simply download the language server protocol plugin for your
favourite editor, and run the binary with the command
<code class="code">plz tool lps</code>.
</p>

<p>
Currently LPS supports auto-completion (this works with build labels too!),
hover, goto definition, diagnostics, signature help, auto-formatting and
references.
</p>
</section>

<section class="mt4">
<h2 id="getting-started" class="title-2">Getting started</h2>

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart_dropoff.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,6 @@ <h2 id="say-hello" class="title-2">Come say hello</h2>

<div class="pagination">
<div class="pagination__previous">
<a class="copy-link" href="/dependencies.html">Third-party dependencies</a>
<a class="copy-link" href="/tooling.html">Tooling</a>
</div>
</div>
9 changes: 8 additions & 1 deletion docs/template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
</div>

<ul class="sticky top-1 ttu essential-pragmata-pro" role="menu">
{{$isItemActive := matches .Filename "quickstart.html" "codelabs.html" "basics.html" "dependencies.html" "quickstart_dropoff.html"}}
{{$isItemActive := matches .Filename "quickstart.html" "codelabs.html" "basics.html" "dependencies.html" "tooling.html" "quickstart_dropoff.html"}}
<li
class="mv2 {{boolOption $isItemActive "white before-dw-arrow" "violet before-rw-arrow hover-before-white"}}"
role="menuitem">
Expand Down Expand Up @@ -121,6 +121,13 @@
>Third-party dependencies</a
>
</li>
<li class="pl4" role="menuitem">
<a
class="{{isFilenameOption "tooling.html" "white" "silver"}} no-underline"
href="/tooling.html"
>Tooling</a
>
</li>
<li class="pl4" role="menuitem">
<a
class="{{isFilenameOption "quickstart_dropoff.html" "white" "silver"}} no-underline"
Expand Down
121 changes: 121 additions & 0 deletions docs/tooling.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<h1 id="tooling" class="title-1">Tooling</h1>

<p>This page lists tools and integrations for working with Please.</p>

<section class="mt4">
<h2 id="editor-integrations" class="title-2">Editor integrations</h2>

<ul class="bulleted-list">
<li>
<span>
<a
class="copy-link"
href="https://github.com/marcuscaisey/please.nvim"
target="_blank"
rel="noopener"
>Please plugin for Neovim</a
>.
</span>
</li>
<li>
<span>
<a
class="copy-link"
href="https://marketplace.visualstudio.com/items?itemName=please-build.plz-vscode"
target="_blank"
rel="noopener"
>Please extension for Visual Studio Code</a
>.
</span>
</li>
<li>
<span>
<a
class="copy-link"
href="https://plugins.jetbrains.com/plugin/16816-please"
target="_blank"
rel="noopener"
>Please plugin for IntelliJ</a
>.
</span>
</li>
</ul>
</section>

<section class="mt4">
<h2 id="build-file-maintenance" class="title-2">BUILD file maintenance</h2>

<ul class="bulleted-list">
<li>
<span>
<a class="copy-link" href="/commands.html#fmt">plz fmt</a>
formats BUILD files.
</span>
</li>
<li>
<span>
<a
class="copy-link"
href="https://github.com/please-build/puku"
target="_blank"
rel="noopener"
>puku</a
>
maintains Go targets in BUILD files.
</span>
</li>
</ul>
</section>

<section class="mt4">
<h2 id="lang-server" class="title-2">BUILD file Language Protocol Server</h2>

<p>
Please ships with a language server for BUILD files. It follows the
<a
class="copy-link"
href="https://langserver.org/"
target="_blank"
rel="noopener"
>language server protocol</a
>
from Visual Studio Code.
</p>

<p>
To use LPS, simply download the language server protocol plugin for your
favourite editor, and run the binary with the command
<code class="code">plz tool lps</code>. The
<a
class="copy-link"
href="https://github.com/marcuscaisey/please.nvim"
target="_blank"
rel="noopener"
>Neovim plugin</a
>
and
<a
class="copy-link"
href="https://marketplace.visualstudio.com/items?itemName=please-build.plz-vscode"
target="_blank"
rel="noopener"
>Visual Studio Code extension</a
>
set this up for you.
</p>

<p>
Currently LPS supports auto-completion (this works with build labels too!),
hover, goto definition, diagnostics, signature help, auto-formatting and
references.
</p>
</section>

<div class="pagination">
<div class="pagination__previous">
<a class="copy-link" href="/dependencies.html">Third-party dependencies</a>
</div>
<div class="pagination__next">
<a class="copy-link" href="/quickstart_dropoff.html">What's next?</a>
</div>
</div>
1 change: 1 addition & 0 deletions docs/tools/templater/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ var pageTitles = map[string]string{
"remote_builds.html": "Remote build execution",
"require_provide.html": "Require & Provide",
"quickstart.html": "Please quickstart",
"tooling.html": "Tooling",
"tests.html": "Testing with Please",
}

Expand Down
Loading