Contrib.social

Fix spelling mistakes

Open on Drupal.org →
Created on 2 March 2024, about 1 year ago
Updated 13 August 2024, 8 months ago

Problem/Motivation

When we enabled Drupal.org's GitLab CI support → in commit 36847a0, it started running CSpell on the code.

CSpell identified some words that it considered misspellings, but since they were in active code (not comments), @mparker17 was afraid of creating regressions, and thus wanted regression tests running first. Regression tests are now running, so it should be (mostly) safe to start fixing them. Note that CSpell is case-sensitive and understands camelCasing, so "buildlist" is considered a misspelling, but "buildList" is not.

At time-of-writing, there are 3 misspellings:

  1. "buildlist" (should be "buildList") in src/Plugin/Sitemap/Vocabulary.php... manual inspection shows there are 3 instances of this in the code: 2 are spelled correctly ("buildList") but there's a recursive function call misspelled "buildlist", which is the issue identified by CSpell here.
  2. "fitler" (should be "filter") in js/sitemap.admin.es6.js (but oddly, not in js/sitemap.admin.js). This appears to be a jQuery Once key, but we don't have any FunctionalJavascript tests for JS regressions yet, so this will require some careful manual testing to ensure there are no regressions.
    • after we fix the misspelling here, we should possibly file a follow-up ticket to figure out why js/sitemap.admin.js no longer seems to be derived from sitemap.admin.es6.js
  3. "feedurl" (should be "feedUrl") in src/Plugin/Block/SitemapSyndicateBlock.php... manual inspection shows 4 instances of this misspelled variable name.

Proposed resolution

Fix the typos. Update .cspell-project-words.txt.

Remaining tasks

  2. Review and feedback
  3. RTBC and feedback
  4. Commit

User interface changes

None.

API changes

None.

Data model changes

None.

📌 Task
Status

Fixed

Version

2.0

Component

Code

Created by

🇨🇦Canada mparker17 UTC-4

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

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024