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

Adding wdio-eslinter-service to auto-detect missing require imports i… #6862

Merged
merged 5 commits into from May 18, 2021

Conversation

jamesmortensen
Copy link
Contributor

…n JavaScript tests prior to running tests

Proposed changes

Adding a link to wdio-eslinter-service, which runs eslint on test scripts prior to running the tests. This is just a documentation change to link to this service.

Types of changes

The service being linked to runs eslint on the codebase and prevents execution if errors are found. The default configuration is lightweight and simply looks for broken require statements but can be expanded by the user to add more eslint rules.

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • I have added proper type definitions for new commands (if appropriate)

Further comments

I created the service because we would find incorrect paths in the require statements in the middle of a test run. This prevents that from happening.

Reviewers: @webdriverio/project-committers

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

Would you mind also adding it here: https://github.com/webdriverio/webdriverio/blob/main/packages/wdio-cli/src/constants.ts#L92-L126, so that the CLI wizard detects it?

@jamesmortensen
Copy link
Contributor Author

Hi @christian-bromann I added it in, but I wasn't sure how to test it due to missing documentation #6876 on how to link directly to the wdio-cli package.

I copied the same format that I saw in other places. Please let me know what else I need to do to test/validate this. Thank you.

Copy link
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

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

👍 thanks

scripts/docs-generation/3rd-party/services.json Outdated Show resolved Hide resolved
@christian-bromann christian-bromann added the PR: Docs 📝 PRs that contain changes to the documentation label May 18, 2021
@christian-bromann christian-bromann merged commit 6656b23 into webdriverio:main May 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: Docs 📝 PRs that contain changes to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants