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

ui: explain eslint plugin prequisite #83460

Merged
merged 1 commit into from
Jun 27, 2022

Conversation

sjbarag
Copy link
Contributor

@sjbarag sjbarag commented Jun 27, 2022

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

@sjbarag sjbarag requested review from maryliag and laurenbarker June 27, 2022 20:42
@cockroach-teamcity
Copy link
Member

This change is Reviewable

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
@sjbarag sjbarag force-pushed the explain-eslint-plugin-prereq branch from 8e2d477 to ec32cbb Compare June 27, 2022 20:43
Copy link
Contributor

@laurenbarker laurenbarker left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: :shipit: complete! 1 of 0 LGTMs obtained (waiting on @maryliag and @sjbarag)


pkg/ui/README.md line 28 at r1 (raw file):

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

Huh, TIL about pushd & popd

@sjbarag
Copy link
Contributor Author

sjbarag commented Jun 27, 2022

bors r=laurenbarker

Copy link
Contributor

@maryliag maryliag left a comment

Choose a reason for hiding this comment

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

thanks for this! :lgtm:

Reviewable status: :shipit: complete! 2 of 0 LGTMs obtained (waiting on @sjbarag)

@craig
Copy link
Contributor

craig bot commented Jun 27, 2022

Build succeeded:

@craig craig bot merged commit 9dfdf1b into cockroachdb:master Jun 27, 2022
@sjbarag sjbarag deleted the explain-eslint-plugin-prereq branch June 28, 2022 16:19
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.

4 participants