[SERVER-60831] Document configuration for Server linting tools Created: 20/Oct/21  Updated: 29/Oct/23  Resolved: 31/Mar/22

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: 6.0.0-rc0

Type: Task Priority: Major - P3
Reporter: Robert Guo (Inactive) Assignee: Tausif Rahman (Inactive)
Resolution: Fixed Votes: 0
Labels: dp-qp-stakeholder-request-2021-10
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Gantt Dependency
has to be done before SERVER-65060 Add readability-function-size clang-t... Closed
Backwards Compatibility: Fully Compatible
Sprint: Dev Platform 2022-04-04
Participants:
Story Points: 2

 Description   

Document the following :

  • clang-format
  • clang-tidy
  • eslint
  • yamllint
  • evergreen yaml linter
  • the python linters: pylinter, mypy, pydocstyle

AC:

  • each linter should include reference to:
    • the configuration file location
    • official documentation link
    • the command-line invocation to help users get to the help documentation
    • the language(s) that the linter applies to
  • Separately, move the clang tidy config string here to a .clang-tidy file. See this SO answer for details on the file format. Then add this rule to the .clang-tidy file per stakeholder request.
    • If there's significant work involved with adding the new rule, please file a separate ticket to do that at a later time.
  • Instead of creating a wiki page, add this documentation to mongodn-mongo repo 


 Comments   
Comment by Githook User [ 31/Mar/22 ]

Author:

{'name': 'trahman1318', 'email': 'tausif.rahman@mongodb.com', 'username': 'trahman1318'}

Message: SERVER-60831 Document configuration for Server linting tools
Branch: master
https://github.com/mongodb/mongo/commit/8711aedfc3e06626309eaed6a854c72a056ff2d8

Comment by Iryna Zhuravlova [ 17/Mar/22 ]

acm do you think there would be a good epic for this ticket to live in?

Comment by Andrew Morrow (Inactive) [ 26/Oct/21 ]

brooke.miller- Please see:

So far, mostly an outline. SDP will be happy to work with STM to figure out where in the documentation it should go during review.

Comment by Brooke Miller [ 26/Oct/21 ]

acm where is the in-tree build system documentation, could you send us a link?

Comment by Andrew Morrow (Inactive) [ 20/Oct/21 ]

I'd also suggest doing the new clang- tidy rule under a separate ticket: you may find that there is significant work involved in getting the new check enabled.

Comment by Andrew Morrow (Inactive) [ 20/Oct/21 ]

I'd like to suggest that we commit this as part of the in-tree build system documentation, rather than as a wiki.

Generated at Thu Feb 08 05:50:51 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.