iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: add information about running clang-format with Vim (#32254) 

A clang-format plugin for Vim must point to the npm-installed
clang-format command. Add docs for this.

PR Close #32254
This commit is contained in:
ayazhafiz 2019-08-21 21:43:24 -05:00 committed by atscott
parent d443a28743
commit 3dd614db61
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/DEVELOPER.md
View File

@ -107,6 +107,17 @@ It will automatically pick up the settings from Angular's [settings.json](../.vs
1. Add `<PATH_TO_YOUR_WORKSPACE>/angular/node_modules/clang-format/bin/<OS>/` 1. Add `<PATH_TO_YOUR_WORKSPACE>/angular/node_modules/clang-format/bin/<OS>/`
where the OS options are: `darwin_x64`, `linux_x64`, and `win32`. where the OS options are: `darwin_x64`, `linux_x64`, and `win32`.
### Vim
1. Install [Vim Clang-Format](https://github.com/rhysd/vim-clang-format).
2. Create a [project-specific `.vimrc`](https://andrew.stwrt.ca/posts/project-specific-vimrc/) in
your Angular directory containing
```vim
let g:clang_format#command = '$ANGULAR_PATH/node_modules/.bin/clang-format'
```
where `$ANGULAR_PATH` is an environment variable of the absolute path of your Angular directory.
## Linting/verifying your source code ## Linting/verifying your source code
You can check that your code is properly formatted and adheres to coding style by running: You can check that your code is properly formatted and adheres to coding style by running: