Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

refactor(docs-infra): enable tslint rules for docs examples #7

Open
gkalpak opened this issue Sep 28, 2020 · 2 comments
Open

refactor(docs-infra): enable tslint rules for docs examples #7

gkalpak opened this issue Sep 28, 2020 · 2 comments
Labels
docs-infra Issues related to documentation infrastructure.

Comments

@gkalpak
Copy link
Collaborator

gkalpak commented Sep 28, 2020 •
edited
Loading

Make docs examples source code compatible with pending tslint rules and enable those rules (in content/examples/tslint.json, boilerplate/cli/tslint.json and boilerplate/systemjs/tslint.json):

NOTE: This issue can be split up per example.

PREREQUISITE: This requires angular/angular#38993 to have been merged. Done.
@bampakoa bampakoa added the documentation Improvements or additions to documentation label Sep 29, 2020
@bampakoa

This comment has been minimized.

# to view
@gkalpak gkalpak added docs-infra Issues related to documentation infrastructure. and removed documentation Improvements or additions to documentation labels Oct 8, 2020
@gkalpak
Copy link
Collaborator Author

gkalpak commented Oct 9, 2020 •
edited
Loading

Instructions

  1. Open aio/content/examples/tslint.json.
  2. Update the config for one rule.
  3. Run yarn --cwd=aio example-lint (to run linting checks on all examples).
  4. Choose one of the failing examples.
  5. Run yarn --cwd=aio tslint --config content/examples/tslint.json content/examples/<chosen-example>/**/*.ts (to run linting checks on the chosen example).
  6. Fix one or more failures.
    (If there are no failures, it means that the example has already been fixed 🎉 Choose a different one.)
  7. Go back to step (5) until you're fed up or there are no more failures (whichever comes first 😛).
  8. Unless all examples are fixed (i.e. yarn --cwd=aio example-lint reports no failures), remember to revert the changes in aio/content/examples/tslint.json before committing (otherwise, the CI checks will fail).
  9. Commit and submit PR.

Failing examples per rule

@angularathens angularathens locked and limited conversation to collaborators Nov 29, 2020
# for free to subscribe to this conversation on GitHub. Already have an account? #.
Assignees
No one assigned
Labels
docs-infra Issues related to documentation infrastructure.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bampakoa @gkalpak