GitHub/Anki
1
0
Fork 0
mirror of https://github.com/ankitects/anki.git synced 2025-09-19 06:22:22 -04:00
Code Issues Projects Releases Packages 1 Wiki Activity Actions

Move VS Code settings to .vscode.dist and update docs (#2029)

Browse source
This commit is contained in:
Aristotelis 2022-08-24 08:08:58 +02:00 committed by GitHub
parent 825c88b6e8
commit 46746e3e34
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.gitignore vendored
View file

@ -6,5 +6,6 @@ target
.dmypy.json .dmypy.json
node_modules node_modules
/.idea/ /.idea/
/.vscode/
/.bazel /.bazel
/windows.bazelrc /windows.bazelrc

0
.vscode/extensions.json → .vscode.dist/extensions.json
View file

0
.vscode/settings.json → .vscode.dist/settings.json
View file

17
docs/editing.md
View file

@ -1,8 +1,7 @@
# Editing/IDEs # Editing/IDEs
Visual Studio Code is recommended, since it provides decent support for all the languages Visual Studio Code is recommended, since it provides decent support for all the languages
Anki uses. If you open the root of this repo in VS Code, it will suggest some extensions Anki uses. To set up the recommended workspace settings for VS Code, please see below.
for you to install.
For editing Python, PyCharm/IntelliJ's type checking/completion is a bit nicer than 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. VS Code, but VS Code has improved considerably in a short span of time.
@ -36,6 +35,20 @@ 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 regular build process, so for things to work correctly, use './run' or
'tools/build' prior to using code completion. '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:
```
cp -r .vscode.dist .vscode
```
### 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 ## PyCharm/IntelliJ
If you decide to use PyCharm instead of VS Code, there are somethings to be aware of. If you decide to use PyCharm instead of VS Code, there are somethings to be aware of.