web/simple-icons
1
0
Fork 0
mirror of https://github.com/simple-icons/simple-icons.git synced 2025-11-23 21:34:49 +02:00
Code Releases Activity

Stricter rules for JSDoc documentation blocks (#11881)

Browse Source
This commit is contained in:
Álvaro Mondéjar Rubio
2024-09-29 16:28:34 +02:00
committed by GitHub
parent 1a5a37cc2d
commit 5183e3c06b
13 changed files with 150 additions and 136 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
scripts/add-icon-data.js
View File

@@ -41,8 +41,9 @@ const licenseTypes =
);
/**
* @param {string} input URL input
* @returns {Promise<boolean|string>} Whether the input is a valid URL
* Whether an input is a valid URL.
* @param {string} input URL input.
* @returns {Promise<boolean|string>} Whether the input is a valid URL.
*/
const isValidURL = async (input) => {
const regex = await urlRegex();
@@ -50,15 +51,17 @@ const isValidURL = async (input) => {
};
/**
* @param {string} input Hex color
* @returns {boolean|string} Whether the input is a valid hex color
* Whether an input is a valid hex color.
* @param {string} input Hex color.
* @returns {boolean|string} Whether the input is a valid hex color.
*/
const isValidHexColor = (input) =>
HEX_REGEX.test(input) || 'Must be a valid hex code.';
/**
* @param {string} input New icon input
* @returns {boolean} Whether the icon is new
* Whether an icon is not already in the dataset.
* @param {string} input New icon input.
* @returns {boolean} Whether the icon is new.
*/
const isNewIcon = (input) =>
!iconsData.icons.some(
@@ -67,8 +70,9 @@ const isNewIcon = (input) =>
);
/**
* @param {string} input Color input
* @returns {string} Preview of the color
* Compute a preview of a color to use in prompt background.
* @param {string} input Color input.
* @returns {string} Preview of the color.
*/
const previewHexColor = (input) => {
const color = normalizeColor(input);