-
Improvement
-
Resolution: Fixed
-
Minor
-
4.5
-
MOODLE_405_STABLE
-
MOODLE_405_STABLE
-
MDL-82212-main -
Setup
- Apply the MDL-82212-testing-icon-deprecation.patch
patch (this will add a few deprecated icons)
git apply MDL-82212-testing-icon-deprecation.patch
Testing scenario 1: Visual test
- Login as admin.
- Go to Administration > Development > Debugging and enable Display debug messages.
- Go to Administration > Development > Purge caches , check All MUC caches and purge them.
- Open the browser console.
- Confirm there are, at least, 2 deprecated icon warnings:
Deprecated icon found: icon deprecated deprecated-core:a/em1_bwgreaterDeprecated icon found: icon fa fa-comment-o deprecated deprecated-core:t/message fa-fw
Testing scenario 2: Behat checker for deprecated icons
- Initialise behat without the new --no-icon-deprecations flag:
php admin/tool/behat/cli/init.php - Run the following behat scenario:
php admin/tool/behat/cli/run.php --name="There is no search if I am not enrolled in any course" - Confirm that you see the following output at the top:
Run optional tests:- Accessibility: Yes- SCSS deprecations: No- Icon deprecations: Yes - Confirm that the test fails:
Scenario: There is no search if I am not enrolled in any course # blocks/myoverview/tests/behat/block_myoverview_search.feature:41
When I am on the "My courses" page logged in as "student2" # blocks/myoverview/tests/behat/block_myoverview_search.feature:42
Deprecated icon in use. Enable $CFG->debugdisplay for detailed debugging information in the console (Exception)
- Run the following behat scenario:
php admin/tool/behat/cli/run.php --name="Student can favourite a discussion from within an individual discussion" - Confirm that the test fails too.
Testing scenario 3: Behat without checking deprecated icons
- Re-initialise behat with the --no-icon-deprecations flag:
php admin/tool/behat/cli/init.php --no-icon-deprecations - Run the following behat scenario:
php admin/tool/behat/cli/run.php --name="There is no search if I am not enrolled in any course" - Confirm that you see the following output at the top:
Run optional tests:- Accessibility: Yes- SCSS deprecations: No- Icon deprecations: No - Confirm that the test passes without errors.
- Run the following behat scenario:
php admin/tool/behat/cli/run.php --name="Student can favourite a discussion from within an individual discussion" - Confirm that the test passes too.
Setup Apply the MDL-82212-testing-icon-deprecation.patch patch (this will add a few deprecated icons) git apply MDL-82212-testing-icon-deprecation.patch Testing scenario 1: Visual test Login as admin. Go to Administration > Development > Debugging and enable Display debug messages. Go to Administration > Development > Purge caches , check All MUC caches and purge them. Open the browser console. Confirm there are, at least, 2 deprecated icon warnings: Deprecated icon found: icon deprecated deprecated-core:a/em1_bwgreater Deprecated icon found: icon fa fa-comment-o deprecated deprecated-core:t/message fa-fw Testing scenario 2: Behat checker for deprecated icons Initialise behat without the new --no-icon-deprecations flag: php admin/tool/behat/cli/init.php Run the following behat scenario: php admin/tool/behat/cli/run.php --name="There is no search if I am not enrolled in any course" Confirm that you see the following output at the top: Run optional tests: - Accessibility: Yes - SCSS deprecations: No - Icon deprecations: Yes Confirm that the test fails: Scenario: There is no search if I am not enrolled in any course # blocks/myoverview/tests/behat/block_myoverview_search.feature: 41 When I am on the "My courses" page logged in as "student2" # blocks/myoverview/tests/behat/block_myoverview_search.feature: 42 Deprecated icon in use. Enable $CFG->debugdisplay for detailed debugging information in the console (Exception) Run the following behat scenario: php admin/tool/behat/cli/run.php --name="Student can favourite a discussion from within an individual discussion" Confirm that the test fails too. Testing scenario 3: Behat without checking deprecated icons Re-initialise behat with the --no-icon-deprecations flag: php admin/tool/behat/cli/init.php --no-icon-deprecations Run the following behat scenario: php admin/tool/behat/cli/run.php --name="There is no search if I am not enrolled in any course" Confirm that you see the following output at the top: Run optional tests: - Accessibility: Yes - SCSS deprecations: No - Icon deprecations: No Confirm that the test passes without errors. Run the following behat scenario: php admin/tool/behat/cli/run.php --name="Student can favourite a discussion from within an individual discussion" Confirm that the test passes too. - Apply the MDL-82212-testing-icon-deprecation.patch
-
5
-
HQ 2024 Sprint I3.1 Moppies
While working on MDL-77754 to improve the Font Awesome icons and take advantage of the new ones in 6, a few icons have been marked as candidates for being deprecated because:
- They are not used in Moodle LMS (and hardly used by third-party plugins too).
- They are duplicated and could be merged, to make them easier to maintain. For instance, i/hide and t/hide use the same icon and, looking at https://docs.moodle.org/dev/Using_images_in_a_theme#Image_locations_within_Moodle , both folders are for "General icons", so one of them could be removed (in favour of the other).
A deprecation mechanism should be defined and implemented for icons, to help developers to detect them.
This mechanism, similar to what was done in MDL-78334 for CSS:
- Add a method, get_deprecated_icons(), to icon_system to return an array with the deprecated key icons (for instance, core:a/download_all):
public function get_deprecated_icons(): array {
return [
'core_a/download_all';
];} - Implement this method in the icon_system_fontawesome class.
- Use the same methodology in
MDL-78334for CSS, to identify where someone uses a deprecated icon. Make the duplication warning optional using debug developer mode. - Add some JS snippet run in the footer when debug developer mode is enabled, to display a console warning for deprecated icons:
document.querySelectorAll('.icon.deprecated').forEach((icon) => {
window.console.warn("Deprecated icon found: " + icon.className);
}); - Document it in devdocs.
- blocks
-
MDL-82460 Deprecate unused pix icons
-
- Open
-
- has a non-specific relationship to
-
-
- Closed
-
- has been marked as being related by
-
-
- Open
-
- links to
- mentioned in
-
Page Loading...
