Skip to content

Commit

Permalink
ui: explain eslint plugin prequisite
Browse files Browse the repository at this point in the history
A recent commit [1] introduced a custom eslint plugin that's hosted in
this repo, but didn't add documentation around building that plugin to
resolve errors reported in IDEs. Explain that eslint-plugin-crdb should
be built to silence errors from eslint that get reported in editors.

[1] ba68179 (ui: use esbuild-loader in webpack configs, 2022-05-26)

Release note: None
  • Loading branch information
sjbarag committed Jun 27, 2022
1 parent 6ca1864 commit ec32cbb
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions pkg/ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@ you'll be able to access the UI at <http://localhost:8080>. If you've started
a node using `demo`, the default port is 8081 and you'll be able to access the UI
at <http://localhost:8081>.

Immdiately upon cloning this repo, your editor may report errors from
[eslint](https://eslint.org/) claiming that `@cockroachlabs/eslint-plugin-crbd`
failed to load. Solve this issue by running the linter once to build the
CRDB-specific plugin, which lives in this repo:
```shell
$ make ui-lint
```

or by building the plugin manually:
```shell
$ pushd pkg/ui/workspaces/eslint-plugin-crbd; yarn && yarn build; popd
```

Behind the scenes, our UI is compiled using a collection of tools that depends on
[Node.js](https://nodejs.org/) and are managed with
[Yarn](https://yarnpkg.com), a package manager that offers more deterministic
Expand Down

0 comments on commit ec32cbb

Please sign in to comment.