fa625d7ad8
* Run cargo +nightly fmt * Latest prost-build includes clippy workaround * Tweak Rust protobuf imports - Avoid use of stringify!(), as JetBrains editors get confused by it - Stop merging all protobuf symbols into a single namespace * Remove some unnecessary qualifications Found via IntelliJ lint * Migrate some asserts to assert_eq/ne * Remove mention of node_modules exclusion This no longer seems to be necessary after migrating away from Bazel, and excluding it means TS/Svelte files can't be edited properly.
56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
# Editing/IDEs
|
|
|
|
Visual Studio Code is recommended, since it provides decent support for all the languages
|
|
Anki uses. To set up the recommended workspace settings for VS Code, please see below.
|
|
|
|
For editing Python, PyCharm/IntelliJ's type checking/completion is a bit nicer than
|
|
VS Code, but VS Code has improved considerably in a short span of time.
|
|
|
|
There are a few steps you'll want to take before you start using an IDE.
|
|
|
|
## Initial Setup
|
|
|
|
### Python Environment
|
|
|
|
For code completion of external Python modules, you can use the venv that is
|
|
generated as part of the build process. After building Anki, the venv will be in
|
|
`out/pyenv`. In VS Code, use ctrl/cmd+shift+p, then 'python: select
|
|
interpreter'.
|
|
|
|
### Rust
|
|
|
|
You'll need Rust to be installed, which is required as part of the build process.
|
|
|
|
### Build First
|
|
|
|
Code completion partly depends on files that are generated as part of the
|
|
regular build process, so for things to work correctly, use './run' or
|
|
'tools/build' prior to using code completion.
|
|
|
|
## Visual Studio Code
|
|
|
|
### Setting up Recommended Workspace Settings
|
|
|
|
To start off with some default workspace settings that are optimized for Anki
|
|
development, please head to the project root and then run:
|
|
|
|
```
|
|
mkdir .vscode && cd .vscode
|
|
ln -sf ../.vscode.dist/* .
|
|
```
|
|
|
|
### Installing Recommended Extensions
|
|
|
|
Once the workspace settings are set up, open the root of the repo in VS Code to
|
|
see and install a number of recommended extensions.
|
|
|
|
## PyCharm/IntelliJ
|
|
|
|
If you decide to use PyCharm instead of VS Code, there are somethings to be
|
|
aware of.
|
|
|
|
### Pylib References
|
|
|
|
You'll need to use File>Project Structure to tell IntelliJ that pylib/ is a
|
|
sources root, so it knows references to 'anki' in aqt are valid.
|