Misspellings in words used in schema files

Created on 10 February 2024, 8 months ago
Updated 15 September 2024, 14 days ago

Problem/Motivation

This is for for words that are used in schema files.

  1. anyall
  2. autoplay
  3. daterange
  4. fieldblock - this is in only in test files in layout_builder
  5. fulldate
  6. groupby - ~19 files
  7. groupwise
  8. itok
  9. prerender
  10. sitename
  11. subquery
  12. unpromote
  13. unsticky

Steps to reproduce

Proposed resolution

  1. anyall
  2. autoplay
  3. fieldblock - this is in only in test files in layout_builder
  4. fulldate
  5. groupby - There were instances of the method groupBy being called with groupby, which have been changed. Usages in comments are changed from 'groupby' to 'group by' when not referring to the method.
  6. itok

Move to Drupal dict

  1. daterange (this is a field type name, so a Drupalism)
  2. groupwise
  3. prerender (a Drupalism)
  4. sitename_title. Cspell fails on 'sitename' but the schema and all usages are 'sitename_title'
  5. subquery (used in SQL)
  6. unpromote (a Drupalism)
  7. unsticky (a Drupalism)

Do these in another issue

  1. datelist - ~23 file include many twig files
  2. filemime - About 35 usages in multiple subsystems and modules.
  3. unpublish (a Drupalism)
  4. linkset Used in .json files

groupby - used as two words in MySQL documentation. There is a groupBy() method in core.
groupwise - In MySQL docs, group-wise, is used. In MariaDB it is groupwise.

Merge request link

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

πŸ“Œ Task
Status

RTBC

Version

11.0 πŸ”₯

Component
OtherΒ  β†’

Last updated about 4 hours ago

Created by

πŸ‡³πŸ‡ΏNew Zealand quietone

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @quietone
  • Merge request !6534Resolve #3420570 "Misspellings in schema" β†’ (Open) created by quietone
  • Status changed to Needs review 8 months ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    I started with 'itok' which is only used in 4 files so that seemed reasonable to remove from the dictionary. And that is true for others with a small number of file changes. But then I found that 'linkset' is in json files so we can't add a comment there to ignore it. And 'datelist' is used in a lot of twig files and we haven't yet added cspell ignore lines there.

    The MR shows the changes I made to that point. But now I think it would be better to move these to drupal.txt:

    1. anyall
    2. datelist - ~23 file include many twig files
    3. daterange
    4. filemime - About 35 usages in multiple subsystems and modules.
    5. fulldate
    6. groupby - ~19 files
    7. groupwise
    8. itok - 4 files
    9. linkset Used in .json files
    10. prerender
    11. sitename
    12. subquery - ~30 files
    13. unpromote
    14. unpublish
    15. unsticky

    and only change this one

    1. fieldblock - this is in only in test files in layout_builder

    We could make followup to change say 'datelist' to 'date_list' or 'anyall' to 'any_all' but does that add value?

  • Status changed to Needs work 8 months ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    If we stick to just those 2 (datelist and anyall) I think they could be handled here.

    As far as the list to move to the drupal dictionary I think they all made sense, know personally some of those I've used often in conversation.

  • Status changed to Needs review 8 months ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    If we stick to just those 2 (datelist and anyall) I think they could be handled here.

    Can you elaborate? There are no changes here for datelist.

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Your last comment

    We could make followup to change say 'datelist' to 'date_list' or 'anyall' to 'any_all' but does that add value?

    Think they can be handled here.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    But that doesn't answer the question if doing so adds value? Not to mention there will be BC to deal with.

  • Status changed to RTBC 8 months ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    To not hold this one up opened πŸ“Œ Determine value in update datelist and anyall Active

  • Status changed to Needs work 7 months ago
  • πŸ‡¬πŸ‡§United Kingdom longwave UK

    As stated in another one of these issues I don't think we should be adding these to config, as they are (pretty much) machine generated and don't care about retaining comments if they are recreated.

    #3 makes a good point that most of these words look like they should be added to the Drupal dictionary.

    I think these are all valid candidates:

    • anyall (mostly because this will be hard to change)
    • datelist (mostly because of the number of usages)
    • daterange (this is a field type name, so a Drupalism)
    • filemime (widely used)
    • groupwise
    • linkset (see https://www.rfc-editor.org/info/rfc9264)
    • prerender
    • subquery
    • unpromote
    • unpublish
    • unsticky

    Not so sure about itok (this is an abbreviation of "image token", but not a word) or fulldate, groupby or sitename (made up compound words).

  • Pipeline finished with Success
    7 months ago
    Total: 556s
    #111620
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    #9. I moved the drupalisms to the drupal dictionary. Still need to work on the other words.

  • Status changed to Needs review about 1 month ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    I am choosing to change the scope here and move these words to another issue. I'd like to explore these a bit more before deciding on a course of action and do not want to hold up progress here on that.

    • datelist - ~23 file include many twig files
    • filemime - About 35 usages in multiple subsystems and modules.
    • linkset Used in .json files

    It is important to notices that cspell fails on 'sitename' but the actual usage in core is 'sitename_title'. So, instead of adding sitename this adds 'sitename_title' to the drupal dictionary.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    Formatting

  • πŸ‡³πŸ‡ΏNew Zealand quietone
  • Status changed to Needs work about 1 month ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Wonder if the title can actually be updated, maybe the issue summary some.

    Appears there are changes to non schema files so not super clear.

  • Status changed to Needs review about 1 month ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    It was just unpublish that is not in a schema file so I removed that from the MR.

    anyall - core/modules/taxonomy/config/schema/taxonomy.views.schema.yml
    autoplay - core/modules/file/config/schema/file.schema.yml
    fieldblock - core/modules/layout_builder/tests/modules/layout_builder_fieldblock_test/config/schema/layout_builder_fieldblock_test.schema.yml
    fulldate - core/modules/views/config/schema/views.argument.schema.yml
    groupby - core/modules/views/config/schema/views.argument.schema.yml, core/modules/views/config/schema/views.filter.schema.yml
    itok - core/modules/image/config/schema/image.schema.yml:
    daterange - core/modules/datetime_range/config/schema/datetime_range.schema.yml
    groupwise - core/modules/views/config/schema/views.relationship.schema.yml
    prerender - core/modules/user/config/schema/user.views.schema.yml, core/modules/views/config/schema/views.field.schema.yml
    sitename_title - core/modules/views/config/schema/views.display.schema.yml:
    subquery - core/modules/views/config/schema/views.relationship.schema.yml:
    unpromote - core/modules/node/config/schema/node.schema.yml
    unsticky - core/modules/node/config/schema/node.schema.yml

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Right but there are changes in non schema files too

  • Pipeline finished with Success
    about 1 month ago
    Total: 544s
    #256328
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    Yes, that is true. These words are used in schema files and elsewhere. The common factor is that they are all in schema files. The title says 'used in schema files' not 'only used in schema files'.

  • Status changed to RTBC about 1 month ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Anyway title appears clearer and spelling changes seem fine.

  • Status changed to Needs work 30 days ago
  • πŸ‡¬πŸ‡§United Kingdom catch

    Needs a rebase.

  • Status changed to Needs review 30 days ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    There were conflicts in both dictionaries. And in
    core/modules/layout_builder/tests/modules/layout_builder_field_block_test/src/ContextProvider/FakeViewModeContext.php
    core/modules/layout_builder/tests/modules/layout_builder_field_block_test/src/Plugin/Block/FieldBlock.php
    due to adding declare strict types.

    I then rebuilt both dictionaries to be sure.

  • Pipeline finished with Success
    30 days ago
    Total: 552s
    #269108
  • Status changed to RTBC 29 days ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Rebase seems good.

  • πŸ‡³πŸ‡ΏNew Zealand quietone

    Rebased and rebuilt the dictionaries.

Production build 0.71.5 2024