saymrwulf/onnxruntime
1
0
Fork 0
mirror of https://github.com/saymrwulf/onnxruntime.git synced 2026-05-14 20:48:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

[js] update docs for new code formatter (#21743)

Browse source 
### Description

Update README.md for code formatter change (#21728)
This commit is contained in:
Yulong Wang 2024-08-15 20:17:08 -07:00 committed by GitHub
parent f8efc086ce
commit d4d0bea1fb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
js/README.md
View file

@ -17,7 +17,8 @@ are used for code-formatting and linting features for developers:
- package.json
- packages-lock.json
- .eslintrc.js
- .clang-format
- .prettierignore
- .prettierrc
Please follow the steps described below to setup development environment.
@ -32,8 +33,8 @@ Please follow the steps described below to setup development environment.
- Visual Studio Code: https://code.visualstudio.com/
- **required** extension: [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
- **required** extension: [Clang-Format](https://marketplace.visualstudio.com/items?itemName=xaver.clang-format)
- **required** extension: [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)
- **required** extension: [Prettier](https://marketplace.visualstudio.com/items?itemName=SimonSiefke.prettier-vscode)
- **required** extension: [JavaScript Debugger](https://marketplace.visualstudio.com/items?itemName=ms-vscode.js-debug-nightly)
- Chrome or Edge Browser
@ -45,7 +46,7 @@ In `<ORT_ROOT>/js`, run:
npm ci
```
This will install Clang-format and ESLint for code-formatting and linting features. This is a one-time setup unless a `git clean` is performed or folder `<ORT_ROOT>/js/node_modules` is removed manually.
This will install Prettier and ESLint for code-formatting and linting features. This is a one-time setup unless a `git clean` is performed or folder `<ORT_ROOT>/js/node_modules` is removed manually.
### Using VSCode:
@ -57,7 +58,7 @@ To populate typescript type declarations, in each project folder, run `npm ci`.
### Run code formatter and linter manually
In `<ORT_ROOT>/js`, use `npm run lint` to run ESLint , and use `npm run format` to run clang-format.
In `<ORT_ROOT>/js`, use `npm run lint` to run ESLint , and use `npm run format` to run code formatter.
## onnxruntime-common