Skip to content

[#2227] Replace prettier plugin for jsdoc. #2226

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AlexSkrypnyk merged 1 commit into from
Jan 14, 2026
Merged

[#2227] Replace prettier plugin for jsdoc. #2226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"plugins": ["prettier-plugin-jsdoc"],
"plugins": ["@homer0/prettier-plugin-jsdoc"],
"jsdocReplaceTagsSynonyms": false,
"overrides": [
{
"files": ["*.css"],
Expand Down
3 changes: 2 additions & 1 deletion .vortex/installer/tests/Fixtures/handler_process/_baseline/.prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"plugins": ["prettier-plugin-jsdoc"],
"plugins": ["@homer0/prettier-plugin-jsdoc"],
"jsdocReplaceTagsSynonyms": false,
"overrides": [
{
"files": ["*.css"],
Expand Down
2 changes: 1 addition & 1 deletion .vortex/installer/tests/Fixtures/handler_process/_baseline/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
"lint-fix": "yarn run lint-fix-js && yarn run lint-fix-css"
},
"devDependencies": {
"@homer0/prettier-plugin-jsdoc": "__VERSION__",
"eslint": "__VERSION__",
"eslint-config-airbnb-base": "__VERSION__",
"eslint-config-prettier": "__VERSION__",
Expand All @@ -25,7 +26,6 @@
"eslint-plugin-prettier": "__VERSION__",
"eslint-plugin-yml": "__VERSION__",
"prettier": "__VERSION__",
"prettier-plugin-jsdoc": "__VERSION__",
"stylelint": "__VERSION__",
"stylelint-config-standard": "__VERSION__",
"stylelint-order": "__VERSION__"
Expand Down
16 changes: 13 additions & 3 deletions ...staller/tests/Fixtures/handler_process/_baseline/web/modules/custom/sw_base/js/sw_base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
/**
* Counter block functionality.
*
* @param {HTMLElement} context Context element to search for counter
* blocks.
* @param {HTMLElement} context Context element to search for counter
* blocks.
*/
initCounterBlock(context) {
const counterBlocks = context.querySelectorAll('[data-sw-base-counter]');
Expand Down Expand Up @@ -74,12 +74,22 @@
/**
* Remove updated class after a delay for visual feedback.
*
* @param {HTMLElement} element The element to remove the class from.
* @param {HTMLElement} element The element to remove the class from.
*/
removeUpdatedClassAfterDelay(element) {
setTimeout(function removeUpdatedClass() {
element.classList.remove('updated');
}, 300);
},

/**
* Get the current counter value from localStorage.
*
* @return {number} The current counter value, or 0 if not set.
*/
getCounterValue() {
const storageKey = 'ys_counter_value';
return parseInt(localStorage.getItem(storageKey), 10) || 0;
},
};
})(Drupal);
2 changes: 2 additions & 0 deletions ...ller/tests/Fixtures/handler_process/_baseline/web/themes/custom/star_wars/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/**/*
*.yml
18 changes: 18 additions & 0 deletions ...ler/tests/Fixtures/handler_process/_baseline/web/themes/custom/star_wars/.prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"printWidth": 80,
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"plugins": ["@homer0/prettier-plugin-jsdoc"],
"jsdocReplaceTagsSynonyms": false,
"overrides": [
{
"files": ["*.css"],
"options": {
"parser": "css",
"printWidth": 10000,
"singleQuote": false
}
}
]
}
6 changes: 3 additions & 3 deletions ...ller/tests/Fixtures/handler_process/_baseline/web/themes/custom/star_wars/js/star_wars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
* @file Global theme behaviors.
* @param $
* @param Drupal
* @global Drupal, jQuery
* @global Drupal, JQuery.
*/

/**
* Global theme behaviors.
*
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
*/
(function StarWarsBehaviors($, Drupal) {
Drupal.behaviors.star_wars = {
Expand Down
2 changes: 1 addition & 1 deletion ...staller/tests/Fixtures/handler_process/_baseline/web/themes/custom/star_wars/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"private": true,
"description": "NodeJS dependencies for star wars project",
"devDependencies": {
"@homer0/prettier-plugin-jsdoc": "__VERSION__",
"autoprefixer": "__VERSION__",
"chokidar-cli": "__VERSION__",
"eslint": "__VERSION__",
Expand All @@ -18,7 +19,6 @@
"postcss": "__VERSION__",
"postcss-cli": "__VERSION__",
"prettier": "__VERSION__",
"prettier-plugin-jsdoc": "__VERSION__",
"sass": "__VERSION__",
"stylelint": "__VERSION__",
"stylelint-config-standard": "__VERSION__",
Expand Down
16 changes: 13 additions & 3 deletions ...ests/Fixtures/handler_process/hosting_acquia/docroot/modules/custom/sw_base/js/sw_base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
/**
* Counter block functionality.
*
* @param {HTMLElement} context Context element to search for counter
* blocks.
* @param {HTMLElement} context Context element to search for counter
* blocks.
*/
initCounterBlock(context) {
const counterBlocks = context.querySelectorAll('[data-sw-base-counter]');
Expand Down Expand Up @@ -74,12 +74,22 @@
/**
* Remove updated class after a delay for visual feedback.
*
* @param {HTMLElement} element The element to remove the class from.
* @param {HTMLElement} element The element to remove the class from.
*/
removeUpdatedClassAfterDelay(element) {
setTimeout(function removeUpdatedClass() {
element.classList.remove('updated');
}, 300);
},

/**
* Get the current counter value from localStorage.
*
* @return {number} The current counter value, or 0 if not set.
*/
getCounterValue() {
const storageKey = 'ys_counter_value';
return parseInt(localStorage.getItem(storageKey), 10) || 0;
},
};
})(Drupal);
2 changes: 2 additions & 0 deletions ...s/Fixtures/handler_process/hosting_acquia/docroot/themes/custom/star_wars/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/**/*
*.yml
18 changes: 18 additions & 0 deletions .../Fixtures/handler_process/hosting_acquia/docroot/themes/custom/star_wars/.prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"printWidth": 80,
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"plugins": ["@homer0/prettier-plugin-jsdoc"],
"jsdocReplaceTagsSynonyms": false,
"overrides": [
{
"files": ["*.css"],
"options": {
"parser": "css",
"printWidth": 10000,
"singleQuote": false
}
}
]
}
6 changes: 3 additions & 3 deletions ...s/Fixtures/handler_process/hosting_acquia/docroot/themes/custom/star_wars/js/star_wars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
* @file Global theme behaviors.
* @param $
* @param Drupal
* @global Drupal, jQuery
* @global Drupal, JQuery.
*/

/**
* Global theme behaviors.
*
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
*/
(function StarWarsBehaviors($, Drupal) {
Drupal.behaviors.star_wars = {
Expand Down
2 changes: 1 addition & 1 deletion ...ests/Fixtures/handler_process/hosting_acquia/docroot/themes/custom/star_wars/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"private": true,
"description": "NodeJS dependencies for star wars project",
"devDependencies": {
"@homer0/prettier-plugin-jsdoc": "__VERSION__",
"autoprefixer": "__VERSION__",
"chokidar-cli": "__VERSION__",
"eslint": "__VERSION__",
Expand All @@ -18,7 +19,6 @@
"postcss": "__VERSION__",
"postcss-cli": "__VERSION__",
"prettier": "__VERSION__",
"prettier-plugin-jsdoc": "__VERSION__",
"sass": "__VERSION__",
"stylelint": "__VERSION__",
"stylelint-config-standard": "__VERSION__",
Expand Down
Empty file added ...ests/Fixtures/handler_process/hosting_acquia/web/themes/custom/star_wars/-.prettierignore
View file
Open in desktop
Empty file.
Empty file added ...sts/Fixtures/handler_process/hosting_acquia/web/themes/custom/star_wars/-.prettierrc.json
View file
Open in desktop
Empty file.
16 changes: 13 additions & 3 deletions ...andler_process/hosting_project_name___acquia/docroot/modules/custom/sw_base/js/sw_base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
/**
* Counter block functionality.
*
* @param {HTMLElement} context Context element to search for counter
* blocks.
* @param {HTMLElement} context Context element to search for counter
* blocks.
*/
initCounterBlock(context) {
const counterBlocks = context.querySelectorAll('[data-sw-base-counter]');
Expand Down Expand Up @@ -74,12 +74,22 @@
/**
* Remove updated class after a delay for visual feedback.
*
* @param {HTMLElement} element The element to remove the class from.
* @param {HTMLElement} element The element to remove the class from.
*/
removeUpdatedClassAfterDelay(element) {
setTimeout(function removeUpdatedClass() {
element.classList.remove('updated');
}, 300);
},

/**
* Get the current counter value from localStorage.
*
* @return {number} The current counter value, or 0 if not set.
*/
getCounterValue() {
const storageKey = 'ys_counter_value';
return parseInt(localStorage.getItem(storageKey), 10) || 0;
},
};
})(Drupal);
2 changes: 2 additions & 0 deletions ...ler_process/hosting_project_name___acquia/docroot/themes/custom/star_wars/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/**/*
*.yml
18 changes: 18 additions & 0 deletions ...er_process/hosting_project_name___acquia/docroot/themes/custom/star_wars/.prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"printWidth": 80,
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"plugins": ["@homer0/prettier-plugin-jsdoc"],
"jsdocReplaceTagsSynonyms": false,
"overrides": [
{
"files": ["*.css"],
"options": {
"parser": "css",
"printWidth": 10000,
"singleQuote": false
}
}
]
}
6 changes: 3 additions & 3 deletions ...ler_process/hosting_project_name___acquia/docroot/themes/custom/star_wars/js/star_wars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
* @file Global theme behaviors.
* @param $
* @param Drupal
* @global Drupal, jQuery
* @global Drupal, JQuery.
*/

/**
* Global theme behaviors.
*
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
*/
(function StarWarsBehaviors($, Drupal) {
Drupal.behaviors.star_wars = {
Expand Down
2 changes: 1 addition & 1 deletion ...andler_process/hosting_project_name___acquia/docroot/themes/custom/star_wars/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"private": true,
"description": "NodeJS dependencies for star wars project",
"devDependencies": {
"@homer0/prettier-plugin-jsdoc": "__VERSION__",
"autoprefixer": "__VERSION__",
"chokidar-cli": "__VERSION__",
"eslint": "__VERSION__",
Expand All @@ -18,7 +19,6 @@
"postcss": "__VERSION__",
"postcss-cli": "__VERSION__",
"prettier": "__VERSION__",
"prettier-plugin-jsdoc": "__VERSION__",
"sass": "__VERSION__",
"stylelint": "__VERSION__",
"stylelint-config-standard": "__VERSION__",
Expand Down
Empty file added ...andler_process/hosting_project_name___acquia/web/themes/custom/star_wars/-.prettierignore
View file
Open in desktop
Empty file.
Empty file added ...ndler_process/hosting_project_name___acquia/web/themes/custom/star_wars/-.prettierrc.json
View file
Open in desktop
Empty file.
16 changes: 13 additions & 3 deletions ...sts/Fixtures/handler_process/names/web/modules/custom/the_force_base/js/the_force_base.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
/**
* Counter block functionality.
*
* @param {HTMLElement} context Context element to search for counter
* blocks.
* @param {HTMLElement} context Context element to search for counter
* blocks.
*/
initCounterBlock(context) {
const counterBlocks = context.querySelectorAll('[data-the-force-base-counter]');
Expand Down Expand Up @@ -74,12 +74,22 @@
/**
* Remove updated class after a delay for visual feedback.
*
* @param {HTMLElement} element The element to remove the class from.
* @param {HTMLElement} element The element to remove the class from.
*/
removeUpdatedClassAfterDelay(element) {
setTimeout(function removeUpdatedClass() {
element.classList.remove('updated');
}, 300);
},

/**
* Get the current counter value from localStorage.
*
* @return {number} The current counter value, or 0 if not set.
*/
getCounterValue() {
const storageKey = 'ys_counter_value';
return parseInt(localStorage.getItem(storageKey), 10) || 0;
},
};
})(Drupal);
2 changes: 2 additions & 0 deletions ...staller/tests/Fixtures/handler_process/names/web/themes/custom/lightsaber/.prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules/**/*
*.yml
18 changes: 18 additions & 0 deletions ...taller/tests/Fixtures/handler_process/names/web/themes/custom/lightsaber/.prettierrc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"printWidth": 80,
"semi": true,
"singleQuote": true,
"trailingComma": "all",
"plugins": ["@homer0/prettier-plugin-jsdoc"],
"jsdocReplaceTagsSynonyms": false,
"overrides": [
{
"files": ["*.css"],
"options": {
"parser": "css",
"printWidth": 10000,
"singleQuote": false
}
}
]
}
6 changes: 3 additions & 3 deletions ...taller/tests/Fixtures/handler_process/names/web/themes/custom/lightsaber/js/lightsaber.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
* @file Global theme behaviors.
* @param $
* @param Drupal
* @global Drupal, jQuery
* @global Drupal, JQuery.
*/

/**
* Global theme behaviors.
*
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
* @param {jQuery} $ The jQuery object.
* @param {Drupal} Drupal The Drupal object.
*/
(function LightsaberBehaviors($, Drupal) {
Drupal.behaviors.lightsaber = {
Expand Down
2 changes: 1 addition & 1 deletion .../installer/tests/Fixtures/handler_process/names/web/themes/custom/lightsaber/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"private": true,
"description": "NodeJS dependencies for New hope project",
"devDependencies": {
"@homer0/prettier-plugin-jsdoc": "__VERSION__",
"autoprefixer": "__VERSION__",
"chokidar-cli": "__VERSION__",
"eslint": "__VERSION__",
Expand All @@ -18,7 +19,6 @@
"postcss": "__VERSION__",
"postcss-cli": "__VERSION__",
"prettier": "__VERSION__",
"prettier-plugin-jsdoc": "__VERSION__",
"sass": "__VERSION__",
"stylelint": "__VERSION__",
"stylelint-config-standard": "__VERSION__",
Expand Down
Empty file added ...staller/tests/Fixtures/handler_process/names/web/themes/custom/star_wars/-.prettierignore
View file
Open in desktop
Empty file.
Empty file added ...taller/tests/Fixtures/handler_process/names/web/themes/custom/star_wars/-.prettierrc.json
View file
Open in desktop
Empty file.
Empty file added ...r/tests/Fixtures/handler_process/theme_claro/web/themes/custom/star_wars/-.prettierignore
View file
Open in desktop
Empty file.
Empty file added .../tests/Fixtures/handler_process/theme_claro/web/themes/custom/star_wars/-.prettierrc.json
View file
Open in desktop
Empty file.
Loading