[META] Generate issues from @todo's in code

Created on 17 March 2022, almost 3 years ago
Updated 6 June 2023, over 1 year ago

Problem/Motivation

There were several @TODOs written into the initial prototype that we should capture as issues here.

Steps to reproduce

Look through all the code at https://drupalcode.org/project/project_browser

Proposed resolution

Look through each and every file and identify any @todo's by file and line number. Excluding sveltejs/public/build and fixtures/ .
Describe to the best of your ability. Create a child issue of this one describing each todo.

Be sure to tag each issue with Project Browser Initiative.

I think all child issues have been created.
Below is a summary:

The list of TODOs

project_browser.libraries.yml
https://git.drupalcode.org/project/project_browser/-/blob/1.0.x/project_...
- # @todo Add "defer" propecty to generated < script > tag.
- sveltejs/public/build/bundle.js: {}
line #3

Review steps

Search the project code for all instances of @todo, ensure that each one corresponds to a drupal.org issue, and ensure that each of those issues are listed as child issues of this one.

πŸ“Œ Task
Status

Fixed

Version

1.0

Component

Code

Created by

πŸ‡ΊπŸ‡ΈUnited States chrisfromredfin Portland, Maine

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • I created a few issues from @todo's that I found in the codebase.

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

    I checked that each @todo had a link to an issue. Two were missing links which I have added and made a patch.

    And now the search results are:

    $ grep -ri @todo . | grep -v .js
    ./tests/src/Traits/PackageManagerFixtureUtilityTrait.php:    // @todo Move back to static::$modules in https://www.drupal.org/i/3349193.
    ./tests/src/FunctionalJavascript/ProjectBrowserUiTest.php:    // @todo Remove try/catch in https://www.drupal.org/i/3349193.
    ./src/ProjectBrowserServiceProvider.php:    // @todo Remove the following Drupal 10.0 autowiring shim in
    ./src/Controller/InstallerController.php:   * @todo add return type when php 7.4 support ends. https://www.drupal.org/i/3348960
    ./src/Controller/InstallerController.php:    // @todo Expand to support other plugins in https://drupal.org/i/3312354.
    ./src/ProjectBrowser/Project.php:      // @todo Not used in Svelte. Audit in https://www.drupal.org/i/3309273.
    ./project_browser.libraries.yml:    # @todo Add "defer" property to generated <script> tag. https://www.drupal.org/i/3348954
    ./drupalci.yml:          # @todo Replace in favor of commit-code-check.sh once https://www.drupal.org/project/drupal/issues/3314100 lands.
    ./scripts/commit-code-check.sh:# @todo https://www.drupal.org/project/drupalci_testbot/issues/3181869

    and for ProjectBrowserServiceProvider

    $ grep -ri -A1 @todo src/ProjectBrowserServiceProvider.php 
        // @todo Remove the following Drupal 10.0 autowiring shim in
        //   https://www.drupal.org/i/3349193.

    Then, I think these two can be closed.

  • Status changed to Needs review over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States mike.roman Chicago
  • Status changed to Fixed over 1 year ago
  • πŸ‡ΊπŸ‡ΈUnited States chrisfromredfin Portland, Maine

    Thanks! The only one I see left is for a PHP return type that could/should be added when we drop 7.4 support. That's a long way off and I think that todo should be removed in another issue. Thanks for your help here!

  • Automatically closed - issue fixed for 2 weeks with no activity.

Production build 0.71.5 2024