Update Tools page #643
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -4,118 +4,95 @@ sidebar_position: 1 | |||||
|
|
||||||
| # Tools | ||||||
|
|
||||||
| ## Operating system | ||||||
|
|
||||||
| All Bitwarden developers are issued with a MacBook or Windows laptop. The tooling recommendations | ||||||
| and instructions in this documentation assume that you’re using one of these operating systems, | ||||||
| noting where a tool may apply to only one of them. | ||||||
|
|
||||||
| This may require some adaptation if you’re using a different operating system. | ||||||
|
|
||||||
| ## Recommended tools | ||||||
|
|
||||||
| The following tools are strongly recommended as part of the "standard" developer setup. We recommend | ||||||
|
There was a problem hiding this comment. 🎉 So glad we catch these awful magic quotes that rich editors sneak in. |
||||||
| that any new Bitwarden developer install all of them as part of setting up their local development | ||||||
| environment. | ||||||
|
|
||||||
| ### IDEs | ||||||
|
|
||||||
| | Tool | How we use it | | ||||||
| | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | ||||||
| | [JetBrains Rider](https://www.jetbrains.com/rider/download/) | Fully featured IDE for C#, .NET & more. Bitwarden developers should contact IT for a license. | | ||||||
| | [Visual Studio](https://visualstudio.microsoft.com/) | Used for C# development on Windows. | | ||||||
| | [Visual Studio Code](https://code.visualstudio.com/) | Used for all Typescript projects. Suboptimal for C#. Be sure to install [extensions](#visual-studio-code-extensions). | | ||||||
|
There was a problem hiding this comment.
Suggested change
Not sure how much commentary to leave since this is a move, but I would avoid the opinionated language. "Typescript" should be fixed everywhere. |
||||||
| | [Xcode](https://developer.apple.com/xcode/) | Required for iOS Mobile development and Safari web extension. | | ||||||
|
There was a problem hiding this comment.
Suggested change
There was a problem hiding this comment. 💭 Maybe just move to the mobile-specific tooling section? |
||||||
|
|
||||||
| ### Local environment | ||||||
|
|
||||||
| | Tool | How we use it | | ||||||
| | --------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||||||
| | [.NET SDK](https://dotnet.microsoft.com/download) | Required for server and other back-end development environments. | | ||||||
| | [Docker](https://docs.docker.com/get-docker/) | Required for server development only. Bitwarden developers should contact IT for a license for Docker Desktop. | | ||||||
| | [Git](https://git-scm.com) | [Commit signing](../../contributing/commit-signing.mdx) is strongly recommended. | | ||||||
| | [Homebrew](https://brew.sh/) | Package manager for macOS. | | ||||||
| | [Iterm2](https://iterm2.com/) | A better terminal emulator (available via Homebrew). | | ||||||
|
There was a problem hiding this comment. ℹ️ Is this tool widespread? |
||||||
| | [NodeJS](https://nodejs.org/) | Check the `engines` in [package.json](https://github.com/bitwarden/clients/blob/main/package.json) for the current version. We recommend using a [node version manager][nvm]). | | ||||||
|
||||||
| | [NodeJS](https://nodejs.org/) | Check the `engines` in [package.json](https://github.com/bitwarden/clients/blob/main/package.json) for the current version. We recommend using a [node version manager][nvm]). | | |
| | [NodeJS](https://nodejs.org/) | Check the `engines` in [package.json](https://github.com/bitwarden/clients/blob/main/package.json) for the current version. We recommend using a [node version manager][nvm]. | |
Hanging )
There was a problem hiding this comment.
Thank you for catching that. I updated it with bd76a24.
There was a problem hiding this comment.
Suggested change
| | [Rust](https://www.rust-lang.org/tools/install) | We stay on the latest stable version - preferably installed via [rustup](https://rustup.rs/). | | |
| | [Rust](https://www.rust-lang.org/tools/install) | We stay on the latest stable version, preferably installed via [rustup](https://rustup.rs/). | |
There was a problem hiding this comment.
Suggested change
| | [MySQLWorkbench](https://www.mysql.com/products/workbench/) | Useful for fiddling with MySQL db. | | |
| | [MySQL Workbench](https://www.mysql.com/products/workbench/) | Useful for fiddling with MySQL db. | |
There was a problem hiding this comment.
Suggested change
| | [PgAdmin4](https://www.pgadmin.org/) | Useful for fiddling with PostgreSQL db. | | |
| | [PgAdmin4](https://www.pgadmin.org/) | Management of PostgreSQL databases. | |
Apply the same language for each below. Prior phrasing with "fiddling" is awkward to me.
There was a problem hiding this comment.
Suggested change
| | C# | [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) | Omnisharp integrations. | | |
| | C# | [C#](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csharp) | OmniSharp integrations. | |
There was a problem hiding this comment.
Suggested change
| | Git | [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph) | Fantastic git visualization tool. | | |
| | Git | [Git Graph](https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph) | Fantastic Git visualization tool. | |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ What's the context of Bitwarden vs. non here? Is this whole page worthy of hiding behind the check?