Skip to content
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.

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

Add reference to visual studio code project repository #10064

Merged
merged 9 commits into from
Oct 2, 2019

Conversation

LeonarddeR
Copy link
Collaborator

@LeonarddeR LeonarddeR commented Aug 9, 2019

Link to issue number:

Depends on nvaccess/vscode-nvda#1
Closes #9971

Summary of the issue:

Visual Studio Code is currently well known for its accessibility and ease of use. Especially since the NVDA repository has a linting configuration built in, using Visual Studio Code's linter support is pretty handy for non visually working programmers.

Description of how this pull request fixes the issue:

Added a reference in the readme to a preconfigured VSCode workspace. This has to be checked out in the main source directory of NVDA. .gitignore deals with this.

Several settings a configured in this project, see also nvaccess/vscode-nvda#1:

  • Accessibility support is enabled
  • Linting is enabled based on the Flake8 configuration bundled with the NVDA repository
  • Auto complete extra paths are added for the several external submodules
  • When saving a file, a final new line is added to it, and extra new lines are trimmed from the end of the file when applicable. This ensures a uniform style across the project
  • De default indentation is set to use tabs instead of spaces
  • Testing within Code is enabled using the unittest framework

The current NVDA build environment is set up in such a way that it doesn't require a virtual Python environment.
This VSCode project does not define the python interrpetter setting by default.

Testing performed:

Tested that tests run from VS Code and that extra include directories are recognized.

Known issues with pull request:

None

Change log entry:

  • Changes for developers
    • The ReadMe of the NVDA development repository now contains instructions on how to use a pre populated workspace configuration for Visual Studio Code for NVDA development. This workspace is configured to use the linting configuration provided with the repository. (Provide VS Code support within NVDA"s git repository #9971)

@LeonarddeR
Copy link
Collaborator Author

@bramd: could you also have a look?

@LeonarddeR LeonarddeR changed the title Add Visual Studio Code project submodule Add reference to visual studio code project repository Sep 9, 2019
@LeonarddeR LeonarddeR marked this pull request as ready for review September 9, 2019 11:19
@michaelDCurran
Copy link
Member

@LeonarddeR err... it looks like the submodule was not actually added? the only two files changed in this pr are readme.md and .gitignore.

@LeonarddeR
Copy link
Collaborator Author

@michaelDCurran: I'm sorry, I noticed that the description of the pr referenced the old situation where we used a submodule. @feerrenrut pointed out that it might be better to use a system where one has to check out the repository manually. See nvaccess/vscode-nvda#1

Copy link
Contributor

@feerrenrut feerrenrut left a comment

Choose a reason for hiding this comment

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

Thanks @LeonarddeR

@feerrenrut feerrenrut merged commit 2e2d39a into nvaccess:master Oct 2, 2019
@nvaccessAuto nvaccessAuto added this to the 2019.3 milestone Oct 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Provide VS Code support within NVDA"s git repository
4 participants