Skip to content

Update the Code Guide documentation and lint everything #2110

@zcorpan

Description

@zcorpan

The Code Guide wiki page has various recommendations for HTML, CSS, and JavaScript source code style.

We also have various linters, runnable with npm run lint.

We should make sure that the Code Guide reflects the code style that we want, and remove everything that is not important or not easily lintable, and then make sure that the linters check for everything that the code guide requires (where possible). We can implement new lint rules in upstream projects (like in #2069).

If we require things that are not lintable, clarify which rules require manual review.

In the last TF meeting we briefly discussed changing the CSS prefixed properties formatting rule: either remove the rule, or change to disallow prefixed properties.

Other possible changes:

  • HTML
  • CSS
  • JS
    • Is the reference to AirBnB JavaScript Style Guide what we should use? Are the linters following it?

Metadata

Metadata

Assignees

No one assigned

    Labels

    Code QualityNon-functional code changes to satisfy APG code style guidelines and lintersInfrastructureRelated to maintaining task force and repo operations, processes, systems, documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions