Skip to content
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: 2 additions & 5 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,17 @@
"recommendations": [
// Editing *.drawio.svg files directly in VS Code
"hediet.vscode-drawio",

// Some convenient extensions for editing reStructuredText files
"lextudio.restructuredtext",

// Linting and live preview for score docs
"swyddfa.esbonio",

// ErrorLens highlights errors and warnings in your code / docs
"usernamehw.errorlens",

// Linting and formatting for Python (LSP via ruff server)
"charliermarsh.ruff",

// BasedPyright for python various type checking improvements and pylance features
"detachhead.basedpyright",
// Bazel BUILD integration
"bazelbuild.vscode-bazel",
Copy link
Member

Choose a reason for hiding this comment

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

This is incompatible with docs-as-code preview, that's why we did not include it. No idea if people use that preview feature or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you mean with "docs-as-code preview"? I just tried to start bazel run :live_preview in a terminal and that still works as intended, as far as I can tell, even though that extension is installed.
At least for module development I guess I rather have a bazel integration than a live preview for my docs as code. Different story on document-heavy repos like eclipse-score/score of course.

]
}
35 changes: 19 additions & 16 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
"files.trimTrailingWhitespace": true,
"editor.insertSpaces": true,
"editor.tabCompletion": "on",

// Default for any filetype
"editor.rulers": [
99
],

// Exclude build, temp and cache folders
Copy link
Member

Choose a reason for hiding this comment

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

feels like this file (actually both) will be much harder to read without the newlines

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is auto-format of the file in vscode. I mean we can also have some explicit non-default formatting but then we should create a formatting setting for JSON. I personally don't want to manually format files.

"files.watcherExclude": {
".*/**": true,
Expand All @@ -19,7 +17,6 @@
".venv*/**": true,
"_build/**": true,
},

// Python Settings
// Exclude build, temp and cache folders
"python.analysis.exclude": [
Expand All @@ -42,26 +39,25 @@
},
"editor.defaultFormatter": "charliermarsh.ruff",
},

// Markdown Settings
"[markdown]": {
// We mostly write markdown in some combination with python,
// so we use the same rulers as python.
"editor.rulers": [
79, 99
79,
99
]
},

"bazel.lsp.command": "bazel",
"bazel.lsp.args": [
"run",
"//:starpls_server"
],

// RST Settings
"[restructuredtext]": {
"editor.tabSize": 3,
},
// Patch files
"[diff]": {
"files.insertFinalNewline": false,
"files.trimFinalNewlines": false,
"files.trimTrailingWhitespace": false,
Comment on lines +57 to +59
Copy link
Member

Choose a reason for hiding this comment

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

why false?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Those are patch files, so they shouldn't be modified automatically in any way. And whitespace matters in there.

},
//
//
// Esbonio 0.x (Current)
Expand All @@ -80,9 +76,11 @@
//
//
// Esbonio 1.x (Preview)
"esbonio.sphinx.pythonCommand": [
".venv_docs/bin/python"
],
"esbonio.sphinx.pythonCommand": {
"command": [
".venv_docs/bin/python"
]
},
"esbonio.sphinx.buildCommand": [
"docs",
"_build",
Expand All @@ -99,8 +97,13 @@
"--ignore-glob=bazel-*/*",
"--ignore-glob=.venv_docs/*",
"--ignore-glob=_build/*",

],
"python.testing.unittestEnabled": false,
"python.testing.pytestEnabled": true,
"clangd.arguments": [
"--compile-commands-dir=${workspaceFolder}/",
"--pretty",
"--background-index",
"--query-driver=/var/cache/bazel/*/execroot/_main/external/toolchains_llvm++llvm+llvm_toolchain/bin/cc_wrapper.sh"
],
}
7 changes: 1 addition & 6 deletions BUILD
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,9 @@
# *******************************************************************************

load("@score_docs_as_code//:docs.bzl", "docs")
load("@score_tooling//:defs.bzl", "copyright_checker", "dash_license_checker", "setup_starpls", "use_format_targets")
load("@score_tooling//:defs.bzl", "copyright_checker", "dash_license_checker", "use_format_targets")
load("//:project_config.bzl", "PROJECT_CONFIG")

setup_starpls(
name = "starpls_server",
visibility = ["//visibility:public"],
)

copyright_checker(
name = "copyright",
srcs = [
Expand Down
Loading