Skip to content

Poll: Name a compiler option for including undefined when a property resolves to an index signature #40435

Closed
Closed
Poll: Name a compiler option for including undefined when a property resolves to an index signature#40435
Labels
Help WantedYou can do thisMeta-IssueAn issue about the team, or the direction of TypeScript

Description

@RyanCavanaugh
Ryan Cavanaugh (RyanCavanaugh)
opened on Sep 8, 2020

We need a name for the option described in #13778

The exact behavior that this flag would enable is, briefly:

  • Read expressions of the form expr[i] will now be T | undefined where T is the index signature type
  • Read expressions of the form expr.prop will now be T | undefined where T is the index signature type if an index signature on expr exists but not a declared property named prop
  • string and number index signatures are both subjected to this treatment
  • Write expressions expr[i] = v and expr.prop = v are unaffected
  • Type expressions TypeName[number] and TypeName["prop"] are unaffected

Good candidate flag names should follow these rules and goals:

  • Do not start with strict since this flag would not get turned on by the global --strict setting
  • Follow an existing convention (see the list at (https://aka.ms/tsconfig.json)
  • Convey the intent of the flag along with its behavior, somehow
  • Avoid problematic terms (e.g. do not reference mental illnesses)

This is an open-ended approval voting issue. Rules:

  • Use 👍 reaction on as many as you like
    • Top-upvoted options will be given the most consideration
    • This is an advisory vote; final say is still up to the TypeScript team
  • You may propose new options; comments must be of exactly the form `--proposedOptionName`
    • Follow the above guidance - no --strictFoo!
  • No discussion here; discuss in Suggestion: option to include undefined in index signatures #13778. Non-option comments will be deleted
  • Sharing this link on social media is encouraged!

I will seed this with some of the names suggested at our last meeting. We may also cull options that aren't receiving a lot of votes to help keep the comment count manageable.

Activity

  1. Ryan Cavanaugh (RyanCavanaugh)
    added
    Help WantedYou can do this
    Meta-IssueAn issue about the team, or the direction of TypeScript
    Add a Flag
    on Sep 8, 2020

  2. RyanCavanaugh commented on Sep 8, 2020

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Sep 8, 2020
    MemberAuthor

    --pedanticIndexSignatures

  3. RyanCavanaugh commented on Sep 8, 2020

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Sep 8, 2020
    MemberAuthor

    --noUncheckedIndexedAccess

  4. RyanCavanaugh commented on Sep 8, 2020

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Sep 8, 2020
    MemberAuthor

    --undefinedIndexSignatures

  5. RyanCavanaugh commented on Sep 8, 2020

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Sep 8, 2020
    MemberAuthor

    --skepticalIndexAccesses

  6. RyanCavanaugh commented on Sep 8, 2020

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Sep 8, 2020
    MemberAuthor

    --noImplicitBounds

  7. microsoft
    deleted a comment from Dan Vanderkam (danvk) on Sep 8, 2020
  8. microsoft
    deleted a comment from John Reilly (johnnyreilly) on Sep 8, 2020

  9. orta commented on Sep 8, 2020

    @orta
    Orta Therox (orta)
    on Sep 8, 2020
    Contributor

    --rigorousIndexAccess

  10. danvk commented on Sep 8, 2020

    @danvk
    Dan Vanderkam (danvk)
    on Sep 8, 2020
    Contributor

    --carefulIndexAccess

  11. jack-williams commented on Sep 8, 2020

    @jack-williams
    Jack Williams (jack-williams)
    on Sep 8, 2020
    Collaborator

    --partialIndexedAccess

  12. awinograd commented on Sep 8, 2020

    @awinograd
    Alec Winograd (awinograd)
    on Sep 8, 2020

    --maybeIndexAccess

  13. OliverJAsh commented on Sep 8, 2020

    @OliverJAsh
    Oliver Joseph Ash (OliverJAsh)
    on Sep 8, 2020
    Contributor

    --indexNullChecks (like --strictNullChecks but for index access)

  14. microsoft
    deleted a comment from seajay (seajaysec) on Sep 8, 2020
  15. microsoft
    deleted a comment from John Reilly (johnnyreilly) on Sep 8, 2020

  16. kirillgroshkov commented on Sep 8, 2020

    @kirillgroshkov
    Kirill Groshkov (kirillgroshkov)
    on Sep 8, 2020

    --safeIndexAccess

  17. danvk commented on Sep 8, 2020

    @danvk
    Dan Vanderkam (danvk)
    on Sep 8, 2020
    Contributor

    --soundIndexedAccess

  18. patrickkunka commented on Sep 8, 2020

    @patrickkunka
    Patrick Kunka (patrickkunka)
    on Sep 8, 2020

    --uncertainIndexAccess

    Personally I feel the name should highlight the aspect of uncertainty introduced here, rather than the aspect of strictness.

  19. thw0rted commented on Sep 9, 2020

    @thw0rted
    James Bromwell (thw0rted)
    on Sep 9, 2020

    --includeUndefinedInIndexSignatures

  20. thw0rted commented on Sep 9, 2020

    @thw0rted
    James Bromwell (thw0rted)
    on Sep 9, 2020

    --includeUndefinedInIndexAccess

  21. alex-okrushko commented on Sep 10, 2020

    @alex-okrushko
    Alex Okrushko (alex-okrushko)
    on Sep 10, 2020

    --noUncheckedIndexedAccess

    I think this one nails it, however I'd adjust it to --noUncheckedIndexAccess (uncheck-ed and index-ed it a feels a bit too much of -ed).

  22. zeusdeux commented on Sep 10, 2020

    @zeusdeux
    Mudit (zeusdeux)
    on Sep 10, 2020

    --checkIndexedAccess

  23. microsoft
    deleted a comment from Osyris (osyrisrblx) on Sep 10, 2020
  24. microsoft
    deleted a comment from Orta Therox (orta) on Sep 10, 2020

  25. RyanCavanaugh commented on Sep 12, 2020

    @RyanCavanaugh
    Ryan Cavanaugh (RyanCavanaugh)
    on Sep 12, 2020
    MemberAuthor

    We have a winner 🥇

  26. Ryan Cavanaugh (RyanCavanaugh)
    closed this as completedon Sep 12, 2020

  27. johnnyreilly commented on Sep 12, 2020

    @johnnyreilly
    John Reilly (johnnyreilly)
    on Sep 12, 2020

    Are you rolling with --noUncheckedIndexedAccess or Alex Okrushko (@alex-okrushko)'s suggested tweak of --noUncheckedIndexAccess?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Help WantedYou can do thisMeta-IssueAn issue about the team, or the direction of TypeScript

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions