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

Make TSLint issues be warnings, not errors, when running src-docs #1538

Merged
merged 1 commit into from
Feb 7, 2019

Conversation

pugnascotia
Copy link
Contributor

Summary

Now that we've merged #1529, all TypeScript files will trigger lint warnings if their formatting needs updating with Prettier (which can be done by fixing with the linter). So far, so good.

However, the Webpack config for src-docs pulls in the project's TypesScript and TSLint settings, meaning that Webpack won't compile any TS files that have lint problems. We don't need checking at this stage to be so strict, because the pre-commit hook and general lint task already check everything.

So, in order to stop docs development from being annoying, I've customised the TSLint settings when running src-docs so that lint problems are now warnings, instead of errors. They'll still have to get fixed before committing.

Checklist

  • This was checked in mobile
  • This was checked in IE11
  • This was checked in dark mode
  • Any props added have proper autodocs
  • Documentation examples were added
  • A changelog entry exists and is marked appropriately
  • This was checked for breaking changes and labeled appropriately
  • Jest tests were updated or added to match the most common scenarios
  • This was checked against keyboard-only and screenreader scenarios
  • This required updates to Framer X components

Copy link
Contributor

@chandlerprall chandlerprall left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@cchaos cchaos left a comment

Choose a reason for hiding this comment

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

TY! I tested it out. It didn't break the build but it got caught during the commit.

@pugnascotia pugnascotia force-pushed the relax-linting-for-docs-dev branch from 3349fa3 to 2c8b6ad Compare February 7, 2019 09:38
@pugnascotia pugnascotia merged commit 60af5b9 into elastic:master Feb 7, 2019
@pugnascotia pugnascotia deleted the relax-linting-for-docs-dev branch February 7, 2019 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants