1
0
mirror of https://github.com/simple-icons/simple-icons.git synced 2025-01-25 01:32:58 +02:00

Add XO linter (#10643)

This commit is contained in:
LitoMore 2024-03-25 01:38:18 +08:00 committed by GitHub
parent d66bdb1380
commit bf69b6dee0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
30 changed files with 633 additions and 493 deletions

View File

@ -16,5 +16,5 @@
separateMajorMinor: false, separateMajorMinor: false,
// We manually update digest dependencies (eg. hashes in Github actions) // We manually update digest dependencies (eg. hashes in Github actions)
digest: { enabled: false }, digest: {enabled: false},
} }

View File

@ -54,13 +54,13 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: npm i --ignore-scripts --no-audit --no-fund run: npm i --ignore-scripts --no-audit --no-fund
- name: Update major version in CDN URLs - name: Update major version in CDN URLs
run: node ./scripts/release/update-cdn-urls.js run: ./scripts/release/update-cdn-urls.js
- name: Update SVGs count milestone - name: Update SVGs count milestone
run: node ./scripts/release/update-svgs-count.js run: ./scripts/release/update-svgs-count.js
- name: Update slugs table - name: Update slugs table
run: node ./scripts/release/update-slugs-table.js run: ./scripts/release/update-slugs-table.js
- name: Update SDK Typescript definitions - name: Update SDK Typescript definitions
run: node ./scripts/release/update-sdk-ts-defs.js run: ./scripts/release/update-sdk-ts-defs.js
- name: Commit version bump - name: Commit version bump
uses: stefanzweifel/git-auto-commit-action@v5 uses: stefanzweifel/git-auto-commit-action@v5
with: with:

View File

@ -43,9 +43,9 @@ jobs:
- name: Install dependencies - name: Install dependencies
run: npm i --ignore-scripts --no-audit --no-fund run: npm i --ignore-scripts --no-audit --no-fund
- name: Reformat to regular markdown - name: Reformat to regular markdown
run: node ./scripts/release/reformat-markdown.js "${{ steps.get-version.outputs.version }}" run: ./scripts/release/reformat-markdown.js "${{ steps.get-version.outputs.version }}"
- name: Update SDK Typescript definitions - name: Update SDK Typescript definitions
run: node ./scripts/release/update-sdk-ts-defs.js run: ./scripts/release/update-sdk-ts-defs.js
- name: Build NodeJS package - name: Build NodeJS package
run: npm run build run: npm run build
- name: Deploy to NPM - name: Deploy to NPM
@ -65,7 +65,7 @@ jobs:
- id: get-version - id: get-version
uses: ./.github/actions/get-version uses: ./.github/actions/get-version
- name: Reformat to regular markdown - name: Reformat to regular markdown
run: node ./scripts/release/reformat-markdown.js "${{ steps.get-version.outputs.version }}" run: ./scripts/release/reformat-markdown.js "${{ steps.get-version.outputs.version }}"
- name: Configure GIT credentials - name: Configure GIT credentials
run: | run: |
git config user.name "${GITHUB_ACTOR}" git config user.name "${GITHUB_ACTOR}"

View File

@ -32,12 +32,12 @@
"aka": { "aka": {
"description": "The brand is also known as (e.g. full length name or abbreviation)", "description": "The brand is also known as (e.g. full length name or abbreviation)",
"type": "array", "type": "array",
"items": { "type": "string" } "items": {"type": "string"}
}, },
"dup": { "dup": {
"description": "Different brands that use the exact same icon", "description": "Different brands that use the exact same icon",
"type": "array", "type": "array",
"items": { "$ref": "#/definitions/duplicate" } "items": {"$ref": "#/definitions/duplicate"}
}, },
"loc": { "loc": {
"description": "Localized names of the brand", "description": "Localized names of the brand",
@ -46,7 +46,7 @@
"old": { "old": {
"description": "Old names, for backwards compatibility", "description": "Old names, for backwards compatibility",
"type": "array", "type": "array",
"items": { "type": "string" } "items": {"type": "string"}
} }
}, },
"minProperties": 1, "minProperties": 1,
@ -702,7 +702,7 @@
"icons": { "icons": {
"description": "A list of brands", "description": "A list of brands",
"type": "array", "type": "array",
"items": { "$ref": "#/definitions/brand" } "items": {"$ref": "#/definitions/brand"}
} }
}, },
"additionalProperties": false, "additionalProperties": false,

View File

@ -6,12 +6,3 @@
# We use our own formatting for the data files. # We use our own formatting for the data files.
_data/simple-icons.json _data/simple-icons.json
# JavaScript templates are invalid JavaScript so cannot be formatted.
scripts/build/templates/*.js
# Generated JavaScript files don't need to be formatted
index.js
index.mjs
index.d.ts
sdk.js

View File

@ -1,3 +1,4 @@
{ {
"singleQuote": true "singleQuote": true,
"bracketSpacing": false
} }

49
.xo-config.json Normal file
View File

@ -0,0 +1,49 @@
{
"prettier": true,
"space": 2,
"plugins": ["import"],
"rules": {
"n/no-unsupported-features": "off",
"n/no-unsupported-features/node-builtins": "off",
"n/file-extension-in-import": "off",
"sort-imports": [
"error",
{
"ignoreCase": false,
"ignoreDeclarationSort": true,
"ignoreMemberSort": false,
"memberSyntaxSortOrder": ["none", "all", "multiple", "single"],
"allowSeparatedGroups": false
}
],
"import/no-named-as-default": "off",
"import/extensions": "off",
"import/order": [
"error",
{
"groups": ["builtin", "external", "parent", "sibling", "index"],
"alphabetize": {
"order": "asc",
"caseInsensitive": true
},
"warnOnUnassignedImports": true,
"newlines-between": "never"
}
]
},
"overrides": [
{
"files": ["sdk.mjs", "sdk.d.ts"],
"nodeVersion": ">=14"
},
{
"files": [
"scripts/**/*",
"tests/**/*",
"svglint.config.mjs",
"svgo.config.mjs"
],
"nodeVersion": ">=18"
}
]
}

View File

@ -88,6 +88,7 @@
"chalk": "5.3.0", "chalk": "5.3.0",
"editorconfig-checker": "5.1.5", "editorconfig-checker": "5.1.5",
"esbuild": "0.19.4", "esbuild": "0.19.4",
"eslint-plugin-import": "2.29.1",
"fake-diff": "1.0.0", "fake-diff": "1.0.0",
"fast-fuzzy": "1.12.0", "fast-fuzzy": "1.12.0",
"get-relative-luminance": "1.0.0", "get-relative-luminance": "1.0.0",
@ -97,23 +98,24 @@
"markdown-link-check": "3.11.2", "markdown-link-check": "3.11.2",
"mocha": "10.2.0", "mocha": "10.2.0",
"named-html-entities-json": "1.0.0", "named-html-entities-json": "1.0.0",
"prettier": "3.0.3",
"svg-path-bbox": "1.2.5", "svg-path-bbox": "1.2.5",
"svg-path-segments": "1.0.0", "svg-path-segments": "1.0.0",
"svglint": "2.4.0", "svglint": "2.4.0",
"svgo": "3.0.2", "svgo": "3.0.2",
"svgpath": "2.6.0", "svgpath": "2.6.0",
"typescript": "5.2.2" "typescript": "5.2.2",
"xo": "0.58.0"
}, },
"scripts": { "scripts": {
"build": "node scripts/build/package.js", "build": "./scripts/build/package.js",
"clean": "node scripts/build/clean.js", "clean": "./scripts/build/clean.js",
"format": "prettier --cache --write .", "format": "prettier --cache --write --ignore-unknown '**/*.!(js|jsx|mjs|cjs|ts|tsx|mts|cts|svg)' && xo --fix",
"lint": "npm run ourlint && npm run jslint && npm run jsonlint && npm run svglint && npm run wslint", "lint": "npm run ourlint && npm run prettierlint && npm run jslint && npm run jsonlint && npm run svglint && npm run wslint",
"ourlint": "node scripts/lint/ourlint.js", "ourlint": "./scripts/lint/ourlint.js",
"jslint": "prettier --cache --check .", "prettierlint": "prettier --cache --check --ignore-unknown '**/*.!(js|jsx|mjs|cjs|ts|tsx|mts|cts|svg)'",
"jsonlint": "node scripts/lint/jsonlint.js", "jslint": "xo",
"svglint": "svglint --ci $npm_config_icons", "jsonlint": "./scripts/lint/jsonlint.js",
"svglint": "svglint --ci $npm_config_icons --config svglint.config.mjs",
"wslint": "editorconfig-checker", "wslint": "editorconfig-checker",
"prepare": "husky", "prepare": "husky",
"prepublishOnly": "npm run build", "prepublishOnly": "npm run build",
@ -121,8 +123,8 @@
"test": "mocha tests --reporter tests/min-reporter.cjs --inline-diffs", "test": "mocha tests --reporter tests/min-reporter.cjs --inline-diffs",
"pretest": "npm run prepublishOnly", "pretest": "npm run prepublishOnly",
"posttest": "npm run postpublish", "posttest": "npm run postpublish",
"get-filename": "node scripts/get-filename.js", "get-filename": "./scripts/get-filename.js",
"add-icon-data": "node scripts/add-icon-data.js" "add-icon-data": "./scripts/add-icon-data.js"
}, },
"engines": { "engines": {
"node": ">=0.12.18" "node": ">=0.12.18"

29
scripts/add-icon-data.js Normal file → Executable file
View File

@ -1,22 +1,23 @@
#!/usr/bin/env node
import process from 'node:process'; import process from 'node:process';
import {ExitPromptError, checkbox, confirm, input} from '@inquirer/prompts';
import chalk from 'chalk'; import chalk from 'chalk';
import { input, confirm, checkbox, ExitPromptError } from '@inquirer/prompts'; import {search} from 'fast-fuzzy';
import autocomplete from 'inquirer-autocomplete-standalone';
import getRelativeLuminance from 'get-relative-luminance'; import getRelativeLuminance from 'get-relative-luminance';
import { search } from 'fast-fuzzy'; import autocomplete from 'inquirer-autocomplete-standalone';
import { import {
URL_REGEX, URL_REGEX,
collator, collator,
getIconsDataString, getIconsDataString,
titleToSlug,
normalizeColor, normalizeColor,
titleToSlug,
} from '../sdk.mjs'; } from '../sdk.mjs';
import { getJsonSchemaData, writeIconsData } from './utils.js'; import {getJsonSchemaData, writeIconsData} from './utils.js';
const iconsData = JSON.parse(await getIconsDataString()); const iconsData = JSON.parse(await getIconsDataString());
const jsonSchema = await getJsonSchemaData(); const jsonSchema = await getJsonSchemaData();
const HEX_REGEX = /^#?[a-f0-9]{3,8}$/i; const HEX_REGEX = /^#?[a-f\d]{3,8}$/i;
const aliasTypes = ['aka', 'old'].map((key) => ({ const aliasTypes = ['aka', 'old'].map((key) => ({
name: `${key} (${jsonSchema.definitions.brand.properties.aliases.properties[key].description})`, name: `${key} (${jsonSchema.definitions.brand.properties.aliases.properties[key].description})`,
@ -25,7 +26,7 @@ const aliasTypes = ['aka', 'old'].map((key) => ({
const licenseTypes = const licenseTypes =
jsonSchema.definitions.brand.properties.license.oneOf[0].properties.type.enum.map( jsonSchema.definitions.brand.properties.license.oneOf[0].properties.type.enum.map(
(license) => ({ name: license, value: license }), (license) => ({name: license, value: license}),
); );
const isValidURL = (input) => const isValidURL = (input) =>
@ -35,7 +36,7 @@ const isValidHexColor = (input) =>
HEX_REGEX.test(input) || 'Must be a valid hex code.'; HEX_REGEX.test(input) || 'Must be a valid hex code.';
const isNewIcon = (input) => const isNewIcon = (input) =>
!iconsData.icons.find( !iconsData.icons.some(
(icon) => (icon) =>
icon.title === input || titleToSlug(icon.title) === titleToSlug(input), icon.title === input || titleToSlug(icon.title) === titleToSlug(input),
) || 'This icon title or slug already exists.'; ) || 'This icon title or slug already exists.';
@ -83,10 +84,10 @@ try {
? { ? {
type: await autocomplete({ type: await autocomplete({
message: "What is the icon's license?", message: "What is the icon's license?",
source: async (input) => { async source(input) {
input = (input || '').trim(); input = (input || '').trim();
return input return input
? search(input, licenseTypes, { keySelector: (x) => x.value }) ? search(input, licenseTypes, {keySelector: (x) => x.value})
: licenseTypes; : licenseTypes;
}, },
}), }),
@ -107,12 +108,14 @@ try {
}).then(async (aliases) => { }).then(async (aliases) => {
const result = {}; const result = {};
for (const alias of aliases) { for (const alias of aliases) {
// eslint-disable-next-line no-await-in-loop
result[alias] = await input({ result[alias] = await input({
message: `What ${alias} aliases would you like to add? (separate with commas)`, message: `What ${alias} aliases would you like to add? (separate with commas)`,
}).then((aliases) => }).then((aliases) =>
aliases.split(',').map((alias) => alias.trim()), aliases.split(',').map((alias) => alias.trim()),
); );
} }
return result; return result;
}) })
: undefined, : undefined,
@ -136,11 +139,11 @@ try {
console.log(chalk.red('\nAborted.')); console.log(chalk.red('\nAborted.'));
process.exit(1); process.exit(1);
} }
} catch (err) { } catch (error) {
if (err instanceof ExitPromptError) { if (error instanceof ExitPromptError) {
console.log(chalk.red('\nAborted.')); console.log(chalk.red('\nAborted.'));
process.exit(1); process.exit(1);
} }
throw err; throw error;
} }

38
scripts/build/clean.js Normal file → Executable file
View File

@ -1,29 +1,37 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Clean files built by the build process. * Clean files built by the build process.
*/ */
import fs from 'node:fs'; import fs from 'node:fs/promises';
import path from 'node:path'; import path from 'node:path';
import { getDirnameFromImportMeta } from '../../sdk.mjs'; import process from 'node:process';
import {getDirnameFromImportMeta} from '../../sdk.mjs';
const __dirname = getDirnameFromImportMeta(import.meta.url); const __dirname = getDirnameFromImportMeta(import.meta.url);
const rootDirectory = path.resolve(__dirname, '..', '..'); const rootDirectory = path.resolve(__dirname, '..', '..');
const files = ['index.js', 'index.mjs', 'index.d.ts', 'sdk.js']; const files = ['index.js', 'index.mjs', 'index.d.ts', 'sdk.js'];
const fileExists = (fpath) => const fileExists = (fpath) =>
new Promise((r) => fs.access(fpath, fs.constants.F_OK, (e) => r(!e))); fs
.access(fpath, fs.constants.F_OK)
.then(() => true)
.catch(() => false);
Promise.all( try {
files.map(async (file) => { Promise.all(
const filepath = path.join(rootDirectory, file); files.map(async (file) => {
if (!(await fileExists(filepath))) { const filepath = path.join(rootDirectory, file);
console.error(`File ${file} does not exist, skipping...`); if (!(await fileExists(filepath))) {
return; console.error(`File ${file} does not exist, skipping...`);
} return;
return fs.promises.unlink(filepath); }
}),
).catch((error) => { return fs.unlink(filepath);
console.error(`Error cleaning files: ${error.message}`); }),
);
} catch (error) {
console.error('Error cleaning files:', error);
process.exit(1); process.exit(1);
}); }

65
scripts/build/package.js Normal file → Executable file
View File

@ -1,36 +1,40 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Simple Icons package build script. * Simple Icons package build script.
*/ */
import { promises as fs } from 'node:fs'; import {promises as fs} from 'node:fs';
import path from 'node:path'; import path from 'node:path';
import util from 'node:util'; import util from 'node:util';
import { transform as esbuildTransform } from 'esbuild'; import {transform as esbuildTransform} from 'esbuild';
import { import {
collator,
getDirnameFromImportMeta,
getIconSlug, getIconSlug,
getIconsData,
slugToVariableName,
svgToPath, svgToPath,
titleToHtmlFriendly, titleToHtmlFriendly,
slugToVariableName,
getIconsData,
getDirnameFromImportMeta,
collator,
} from '../../sdk.mjs'; } from '../../sdk.mjs';
const __dirname = getDirnameFromImportMeta(import.meta.url); const __dirname = getDirnameFromImportMeta(import.meta.url);
const UTF8 = 'utf8'; const UTF8 = 'utf8';
const rootDir = path.resolve(__dirname, '..', '..'); const rootDirectory = path.resolve(__dirname, '..', '..');
const iconsDir = path.resolve(rootDir, 'icons'); const iconsDirectory = path.resolve(rootDirectory, 'icons');
const indexJsFile = path.resolve(rootDir, 'index.js'); const indexJsFile = path.resolve(rootDirectory, 'index.js');
const indexMjsFile = path.resolve(rootDir, 'index.mjs'); const indexMjsFile = path.resolve(rootDirectory, 'index.mjs');
const sdkJsFile = path.resolve(rootDir, 'sdk.js'); const sdkJsFile = path.resolve(rootDirectory, 'sdk.js');
const sdkMjsFile = path.resolve(rootDir, 'sdk.mjs'); const sdkMjsFile = path.resolve(rootDirectory, 'sdk.mjs');
const indexDtsFile = path.resolve(rootDir, 'index.d.ts'); const indexDtsFile = path.resolve(rootDirectory, 'index.d.ts');
const templatesDir = path.resolve(__dirname, 'templates'); const templatesDirectory = path.resolve(__dirname, 'templates');
const iconObjectTemplateFile = path.resolve(templatesDir, 'icon-object.js'); const iconObjectTemplateFile = path.resolve(
templatesDirectory,
'icon-object.js.template',
);
const build = async () => { const build = async () => {
const icons = await getIconsData(); const icons = await getIconsData();
@ -38,8 +42,9 @@ const build = async () => {
// Local helper functions // Local helper functions
const escape = (value) => { const escape = (value) => {
return value.replace(/(?<!\\)'/g, "\\'"); return value.replaceAll(/(?<!\\)'/g, "\\'");
}; };
const licenseToObject = (license) => { const licenseToObject = (license) => {
if (license === undefined) { if (license === undefined) {
return; return;
@ -48,8 +53,10 @@ const build = async () => {
if (license.url === undefined) { if (license.url === undefined) {
license.url = `https://spdx.org/licenses/${license.type}`; license.url = `https://spdx.org/licenses/${license.type}`;
} }
return license; return license;
}; };
const iconToObject = (icon) => { const iconToObject = (icon) => {
return util.format( return util.format(
iconObjectTemplate, iconObjectTemplate,
@ -65,11 +72,13 @@ const build = async () => {
: '', : '',
); );
}; };
const writeJs = async (filepath, rawJavaScript, opts = null) => {
opts = opts === null ? { minify: true } : opts; const writeJs = async (filepath, rawJavaScript, options = null) => {
const { code } = await esbuildTransform(rawJavaScript, opts); options = options === null ? {minify: true} : options;
const {code} = await esbuildTransform(rawJavaScript, options);
await fs.writeFile(filepath, code); await fs.writeFile(filepath, code);
}; };
const writeTs = async (filepath, rawTypeScript) => { const writeTs = async (filepath, rawTypeScript) => {
await fs.writeFile(filepath, rawTypeScript); await fs.writeFile(filepath, rawTypeScript);
}; };
@ -78,13 +87,13 @@ const build = async () => {
const buildIcons = await Promise.all( const buildIcons = await Promise.all(
icons.map(async (icon) => { icons.map(async (icon) => {
const filename = getIconSlug(icon); const filename = getIconSlug(icon);
const svgFilepath = path.resolve(iconsDir, `${filename}.svg`); const svgFilepath = path.resolve(iconsDirectory, `${filename}.svg`);
icon.svg = await fs.readFile(svgFilepath, UTF8); icon.svg = await fs.readFile(svgFilepath, UTF8);
icon.path = svgToPath(icon.svg); icon.path = svgToPath(icon.svg);
icon.slug = filename; icon.slug = filename;
const iconObject = iconToObject(icon); const iconObject = iconToObject(icon);
const iconExportName = slugToVariableName(icon.slug); const iconExportName = slugToVariableName(icon.slug);
return { icon, iconObject, iconExportName }; return {icon, iconObject, iconExportName};
}), }),
); );
@ -93,33 +102,33 @@ const build = async () => {
const iconsBarrelMjs = []; const iconsBarrelMjs = [];
buildIcons.sort((a, b) => collator.compare(a.icon.title, b.icon.title)); buildIcons.sort((a, b) => collator.compare(a.icon.title, b.icon.title));
for (const { iconObject, iconExportName } of buildIcons) { for (const {iconObject, iconExportName} of buildIcons) {
iconsBarrelDts.push(`export const ${iconExportName}:I;`); iconsBarrelDts.push(`export const ${iconExportName}:I;`);
iconsBarrelJs.push(`${iconExportName}:${iconObject},`); iconsBarrelJs.push(`${iconExportName}:${iconObject},`);
iconsBarrelMjs.push(`export const ${iconExportName}=${iconObject}`); iconsBarrelMjs.push(`export const ${iconExportName}=${iconObject}`);
} }
// constants used in templates to reduce package size // Constants used in templates to reduce package size
const constantsString = `const a='<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>',b='</title><path d="',c='"/></svg>';`; const constantsString = `const a='<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>',b='</title><path d="',c='"/></svg>';`;
// write our file containing the exports of all icons in CommonJS ... // Write our file containing the exports of all icons in CommonJS ...
const rawIndexJs = `${constantsString}module.exports={${iconsBarrelJs.join( const rawIndexJs = `${constantsString}module.exports={${iconsBarrelJs.join(
'', '',
)}};`; )}};`;
await writeJs(indexJsFile, rawIndexJs); await writeJs(indexJsFile, rawIndexJs);
// and ESM // ... and ESM
const rawIndexMjs = constantsString + iconsBarrelMjs.join(''); const rawIndexMjs = constantsString + iconsBarrelMjs.join('');
await writeJs(indexMjsFile, rawIndexMjs); await writeJs(indexMjsFile, rawIndexMjs);
// and create a type declaration file // ... and create a type declaration file
const rawIndexDts = `import {SimpleIcon} from "./types";export {SimpleIcon};type I=SimpleIcon;${iconsBarrelDts.join( const rawIndexDts = `import {SimpleIcon} from "./types";export {SimpleIcon};type I=SimpleIcon;${iconsBarrelDts.join(
'', '',
)}`; )}`;
await writeTs(indexDtsFile, rawIndexDts); await writeTs(indexDtsFile, rawIndexDts);
// create a CommonJS SDK file // Create a CommonJS SDK file
await writeJs(sdkJsFile, await fs.readFile(sdkMjsFile, UTF8), { await writeJs(sdkJsFile, await fs.readFile(sdkMjsFile, UTF8), {
format: 'cjs', format: 'cjs',
}); });
}; };
build(); await build();

8
scripts/get-filename.js Normal file → Executable file
View File

@ -1,3 +1,4 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Script that takes a brand name as argument and outputs the corresponding * Script that takes a brand name as argument and outputs the corresponding
@ -5,16 +6,13 @@
*/ */
import process from 'node:process'; import process from 'node:process';
import { titleToSlug } from '../sdk.mjs'; import {titleToSlug} from '../sdk.mjs';
if (process.argv.length < 3) { if (process.argv.length < 3) {
console.error('Provide a brand name as argument'); console.error('Provide a brand name as argument');
process.exit(1); process.exit(1);
} else { } else {
const brandName = process.argv const brandName = process.argv[2];
.slice(3)
.reduce((acc, arg) => `${acc} ${arg}`, process.argv[2]);
const filename = titleToSlug(brandName); const filename = titleToSlug(brandName);
console.log(`For '${brandName}' use the file 'icons/${filename}.svg'`); console.log(`For '${brandName}' use the file 'icons/${filename}.svg'`);
} }

11
scripts/lint/jsonlint.js Normal file → Executable file
View File

@ -1,20 +1,21 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* CLI tool to run jsonschema on the simple-icons.json data file. * CLI tool to run jsonschema on the simple-icons.json data file.
*/ */
import process from 'node:process'; import process from 'node:process';
import { Validator } from 'jsonschema'; import {Validator} from 'jsonschema';
import { getIconsData } from '../../sdk.mjs'; import {getIconsData} from '../../sdk.mjs';
import { getJsonSchemaData } from '../utils.js'; import {getJsonSchemaData} from '../utils.js';
const icons = await getIconsData(); const icons = await getIconsData();
const schema = await getJsonSchemaData(); const schema = await getJsonSchemaData();
const validator = new Validator(); const validator = new Validator();
const result = validator.validate({ icons }, schema); const result = validator.validate({icons}, schema);
if (result.errors.length > 0) { if (result.errors.length > 0) {
result.errors.forEach((error) => console.error(error)); for (const error of result.errors) console.error(error);
console.error(`Found ${result.errors.length} error(s) in simple-icons.json`); console.error(`Found ${result.errors.length} error(s) in simple-icons.json`);
process.exit(1); process.exit(1);
} }

40
scripts/lint/ourlint.js Normal file → Executable file
View File

@ -1,3 +1,4 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Linters for the package that can't easily be implemented in the existing * Linters for the package that can't easily be implemented in the existing
@ -5,9 +6,8 @@
*/ */
import process from 'node:process'; import process from 'node:process';
import { URL } from 'node:url';
import fakeDiff from 'fake-diff'; import fakeDiff from 'fake-diff';
import { getIconsDataString, normalizeNewlines, collator } from '../../sdk.mjs'; import {collator, getIconsDataString, normalizeNewlines} from '../../sdk.mjs';
/** /**
* Contains our tests so they can be isolated from each other. * Contains our tests so they can be isolated from each other.
@ -15,39 +15,43 @@ import { getIconsDataString, normalizeNewlines, collator } from '../../sdk.mjs';
*/ */
const TESTS = { const TESTS = {
/* Tests whether our icons are in alphabetical order */ /* Tests whether our icons are in alphabetical order */
alphabetical: (data) => { alphabetical(data) {
const collector = (invalidEntries, icon, index, array) => { const collector = (invalidEntries, icon, index, array) => {
if (index > 0) { if (index > 0) {
const prev = array[index - 1]; const previous = array[index - 1];
const comparison = collator.compare(icon.title, prev.title); const comparison = collator.compare(icon.title, previous.title);
if (comparison < 0) { if (comparison < 0) {
invalidEntries.push(icon); invalidEntries.push(icon);
} else if (comparison === 0) { } else if (
if (prev.slug) { comparison === 0 &&
if (!icon.slug || collator.compare(icon.slug, prev.slug) < 0) { previous.slug &&
invalidEntries.push(icon); (!icon.slug || collator.compare(icon.slug, previous.slug) < 0)
} ) {
} invalidEntries.push(icon);
} }
} }
return invalidEntries; return invalidEntries;
}; };
const format = (icon) => { const format = (icon) => {
if (icon.slug) { if (icon.slug) {
return `${icon.title} (${icon.slug})`; return `${icon.title} (${icon.slug})`;
} }
return icon.title; return icon.title;
}; };
// eslint-disable-next-line unicorn/no-array-reduce, unicorn/no-array-callback-reference
const invalids = data.icons.reduce(collector, []); const invalids = data.icons.reduce(collector, []);
if (invalids.length) { if (invalids.length > 0) {
return `Some icons aren't in alphabetical order: return `Some icons aren't in alphabetical order:
${invalids.map((icon) => format(icon)).join(', ')}`; ${invalids.map((icon) => format(icon)).join(', ')}`;
} }
}, },
/* Check the formatting of the data file */ /* Check the formatting of the data file */
prettified: (data, dataString) => { prettified(data, dataString) {
const normalizedDataString = normalizeNewlines(dataString); const normalizedDataString = normalizeNewlines(dataString);
const dataPretty = `${JSON.stringify(data, null, 4)}\n`; const dataPretty = `${JSON.stringify(data, null, 4)}\n`;
@ -58,9 +62,9 @@ const TESTS = {
}, },
/* Check redundant trailing slash in URL */ /* Check redundant trailing slash in URL */
checkUrl: (data) => { checkUrl(data) {
const hasRedundantTrailingSlash = (url) => { const hasRedundantTrailingSlash = (url) => {
const origin = new URL(url).origin; const {origin} = new global.URL(url);
return /^\/+$/.test(url.replace(origin, '')); return /^\/+$/.test(url.replace(origin, ''));
}; };
@ -89,9 +93,11 @@ const data = JSON.parse(dataString);
const errors = ( const errors = (
await Promise.all(Object.values(TESTS).map((test) => test(data, dataString))) await Promise.all(Object.values(TESTS).map((test) => test(data, dataString)))
).filter(Boolean); )
// eslint-disable-next-line unicorn/no-await-expression-member
.filter(Boolean);
if (errors.length > 0) { if (errors.length > 0) {
errors.forEach((error) => console.error(`\u001b[31m${error}\u001b[0m`)); for (const error of errors) console.error(`\u001B[31m${error}\u001B[0m`);
process.exit(1); process.exit(1);
} }

24
scripts/release/reformat-markdown.js Normal file → Executable file
View File

@ -1,19 +1,21 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Rewrite some Markdown files. * Rewrite some Markdown files.
*/ */
import {readFile, writeFile} from 'node:fs/promises';
import path from 'node:path'; import path from 'node:path';
import { writeFile, readFile } from 'node:fs/promises'; import process from 'node:process';
import { getDirnameFromImportMeta } from '../../sdk.mjs'; import {getDirnameFromImportMeta} from '../../sdk.mjs';
const LINKS_BRANCH = process.argv[2] || 'develop'; const LINKS_BRANCH = process.argv[2] || 'develop';
const __dirname = getDirnameFromImportMeta(import.meta.url); const __dirname = getDirnameFromImportMeta(import.meta.url);
const rootDir = path.resolve(__dirname, '..', '..'); const rootDirectory = path.resolve(__dirname, '..', '..');
const readmeFile = path.resolve(rootDir, 'README.md'); const readmeFile = path.resolve(rootDirectory, 'README.md');
const disclaimerFile = path.resolve(rootDir, 'DISCLAIMER.md'); const disclaimerFile = path.resolve(rootDirectory, 'DISCLAIMER.md');
const reformat = async (filePath) => { const reformat = async (filePath) => {
const fileContent = await readFile(filePath, 'utf8'); const fileContent = await readFile(filePath, 'utf8');
@ -21,17 +23,17 @@ const reformat = async (filePath) => {
filePath, filePath,
fileContent fileContent
// Replace all CDN links with raw links // Replace all CDN links with raw links
.replace( .replaceAll(
/https:\/\/cdn.simpleicons.org\/(.+)\/000\/fff/g, /https:\/\/cdn.simpleicons.org\/(.+)\/000\/fff/g,
`https://raw.githubusercontent.com/simple-icons/simple-icons/${LINKS_BRANCH}/icons/$1.svg`, `https://raw.githubusercontent.com/simple-icons/simple-icons/${LINKS_BRANCH}/icons/$1.svg`,
) )
// Replace all GitHub blockquotes with regular markdown // Replace all GitHub blockquotes with regular markdown
// Reference: https://github.com/orgs/community/discussions/16925 // Reference: https://github.com/orgs/community/discussions/16925
.replace( .replaceAll(
/\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\](?!\()/g, /\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)](?!\()/g,
function (str, $0) { function (string_, $0) {
const capital = $0.substr(0, 1); const capital = $0.slice(0, 1);
const body = $0.substr(1).toLowerCase(); const body = $0.slice(1).toLowerCase();
return `**${capital + body}**`; return `**${capital + body}**`;
}, },
), ),

23
scripts/release/update-cdn-urls.js Normal file → Executable file
View File

@ -1,35 +1,36 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Updates the CDN URLs in the README.md to match the major version in the * Updates the CDN URLs in the README.md to match the major version in the
* NPM package manifest. Does nothing if the README.md is already up-to-date. * NPM package manifest. Does nothing if the README.md is already up-to-date.
*/ */
import process from 'node:process';
import fs from 'node:fs/promises'; import fs from 'node:fs/promises';
import path from 'node:path'; import path from 'node:path';
import { getDirnameFromImportMeta } from '../../sdk.mjs'; import process from 'node:process';
import {getDirnameFromImportMeta} from '../../sdk.mjs';
const __dirname = getDirnameFromImportMeta(import.meta.url); const __dirname = getDirnameFromImportMeta(import.meta.url);
const rootDir = path.resolve(__dirname, '..', '..'); const rootDirectory = path.resolve(__dirname, '..', '..');
const packageJsonFile = path.resolve(rootDir, 'package.json'); const packageJsonFile = path.resolve(rootDirectory, 'package.json');
const readmeFile = path.resolve(rootDir, 'README.md'); const readmeFile = path.resolve(rootDirectory, 'README.md');
const getMajorVersion = (semVerVersion) => { const getMajorVersion = (semVersion) => {
const majorVersionAsString = semVerVersion.split('.')[0]; const majorVersionAsString = semVersion.split('.')[0];
return parseInt(majorVersionAsString); return Number.parseInt(majorVersionAsString, 10);
}; };
const getManifest = async () => { const getManifest = async () => {
const manifestRaw = await fs.readFile(packageJsonFile, 'utf-8'); const manifestRaw = await fs.readFile(packageJsonFile, 'utf8');
return JSON.parse(manifestRaw); return JSON.parse(manifestRaw);
}; };
const updateVersionInReadmeIfNecessary = async (majorVersion) => { const updateVersionInReadmeIfNecessary = async (majorVersion) => {
let content = await fs.readFile(readmeFile, 'utf8'); let content = await fs.readFile(readmeFile, 'utf8');
content = content.replace( content = content.replaceAll(
/simple-icons@v[0-9]+/g, /simple-icons@v\d+/g,
`simple-icons@v${majorVersion}`, `simple-icons@v${majorVersion}`,
); );

34
scripts/release/update-sdk-ts-defs.js Normal file → Executable file
View File

@ -1,33 +1,34 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Updates the SDK Typescript definitions located in the file sdk.d.ts * Updates the SDK Typescript definitions located in the file sdk.d.ts
* to match the current definitions of functions of sdk.mjs. * to match the current definitions of functions of sdk.mjs.
*/ */
import process from 'node:process'; import {execSync} from 'node:child_process';
import fs from 'node:fs/promises'; import fs from 'node:fs/promises';
import path from 'node:path'; import path from 'node:path';
import { execSync } from 'node:child_process'; import process from 'node:process';
import { getDirnameFromImportMeta } from '../../sdk.mjs'; import {getDirnameFromImportMeta} from '../../sdk.mjs';
const __dirname = getDirnameFromImportMeta(import.meta.url); const __dirname = getDirnameFromImportMeta(import.meta.url);
const rootDir = path.resolve(__dirname, '..', '..'); const rootDirectory = path.resolve(__dirname, '..', '..');
const sdkTs = path.resolve(rootDir, 'sdk.d.ts'); const sdkTs = path.resolve(rootDirectory, 'sdk.d.ts');
const sdkMts = path.resolve(rootDir, 'sdk.d.mts'); const sdkMts = path.resolve(rootDirectory, 'sdk.d.mts');
const sdkMjs = path.resolve(rootDir, 'sdk.mjs'); const sdkMjs = path.resolve(rootDirectory, 'sdk.mjs');
const generateSdkMts = async () => { const generateSdkMts = async () => {
// remove temporally type definitions imported with comments // Remove temporally type definitions imported with comments
// in sdk.mjs to avoid circular imports // in sdk.mjs to avoid circular imports
const originalSdkMjsContent = await fs.readFile(sdkMjs, 'utf-8'); const originalSdkMjsContent = await fs.readFile(sdkMjs, 'utf8');
const tempSdkMjsContent = originalSdkMjsContent const temporarySdkMjsContent = originalSdkMjsContent
.split('\n') .split('\n')
.filter((line) => { .filter((line) => {
return !line.startsWith(' * @typedef {import("./sdk")'); return !line.startsWith(' * @typedef {import("./sdk")');
}) })
.join('\n'); .join('\n');
await fs.writeFile(sdkMjs, tempSdkMjsContent); await fs.writeFile(sdkMjs, temporarySdkMjsContent);
try { try {
execSync( execSync(
'npx tsc sdk.mjs' + 'npx tsc sdk.mjs' +
@ -41,6 +42,7 @@ const generateSdkMts = async () => {
); );
process.exit(1); process.exit(1);
} }
await fs.writeFile(sdkMjs, originalSdkMjsContent); await fs.writeFile(sdkMjs, originalSdkMjsContent);
}; };
@ -49,13 +51,15 @@ const generateSdkTs = async () => {
.access(sdkMts) .access(sdkMts)
.then(() => true) .then(() => true)
.catch(() => false); .catch(() => false);
fileExists && (await fs.unlink(sdkMts)); if (fileExists) await fs.unlink(sdkMts);
await generateSdkMts(); await generateSdkMts();
const autogeneratedMsg = '/* The next code is autogenerated from sdk.mjs */'; const autogeneratedMessage =
'/* The next code is autogenerated from sdk.mjs */';
const newSdkTsContent = const newSdkTsContent =
(await fs.readFile(sdkTs, 'utf-8')).split(autogeneratedMsg)[0] + // eslint-disable-next-line unicorn/no-await-expression-member
`${autogeneratedMsg}\n\n${await fs.readFile(sdkMts, 'utf-8')}`; (await fs.readFile(sdkTs, 'utf8')).split(autogeneratedMessage)[0] +
`${autogeneratedMessage}\n\n${await fs.readFile(sdkMts, 'utf8')}`;
await fs.writeFile(sdkTs, newSdkTsContent); await fs.writeFile(sdkTs, newSdkTsContent);
await fs.unlink(sdkMts); await fs.unlink(sdkMts);

14
scripts/release/update-slugs-table.js Normal file → Executable file
View File

@ -1,22 +1,23 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Generates a MarkDown file that lists every brand name and their slug. * Generates a MarkDown file that lists every brand name and their slug.
*/ */
import { promises as fs } from 'node:fs'; import fs from 'node:fs/promises';
import path from 'node:path'; import path from 'node:path';
import { fileURLToPath } from 'node:url'; import {fileURLToPath} from 'node:url';
import { getIconsData, getIconSlug } from '../../sdk.mjs'; import {getIconSlug, getIconsData} from '../../sdk.mjs';
const __filename = fileURLToPath(import.meta.url); const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename); const __dirname = path.dirname(__filename);
const rootDir = path.resolve(__dirname, '..', '..'); const rootDirectory = path.resolve(__dirname, '..', '..');
const slugsFile = path.resolve(rootDir, 'slugs.md'); const slugsFile = path.resolve(rootDirectory, 'slugs.md');
let content = `<!-- let content = `<!--
This file is automatically generated. If you want to change something, please This file is automatically generated. If you want to change something, please
update the script at '${path.relative(rootDir, __filename)}'. update the script at '${path.relative(rootDirectory, __filename)}'.
--> -->
# Simple Icons slugs # Simple Icons slugs
@ -31,4 +32,5 @@ for (const icon of icons) {
const brandSlug = getIconSlug(icon); const brandSlug = getIconSlug(icon);
content += `| \`${brandName}\` | \`${brandSlug}\` |\n`; content += `| \`${brandName}\` | \`${brandSlug}\` |\n`;
} }
await fs.writeFile(slugsFile, content); await fs.writeFile(slugsFile, content);

20
scripts/release/update-svgs-count.js Normal file → Executable file
View File

@ -1,3 +1,4 @@
#!/usr/bin/env node
/** /**
* @fileoverview * @fileoverview
* Replaces the SVG count milestone "Over <NUMBER> Free SVG icons..." located * Replaces the SVG count milestone "Over <NUMBER> Free SVG icons..." located
@ -5,32 +6,33 @@
* more than the previous milestone. * more than the previous milestone.
*/ */
import process from 'node:process';
import fs from 'node:fs/promises'; import fs from 'node:fs/promises';
import path from 'node:path'; import path from 'node:path';
import { getDirnameFromImportMeta, getIconsData } from '../../sdk.mjs'; import process from 'node:process';
import {getDirnameFromImportMeta, getIconsData} from '../../sdk.mjs';
const regexMatcher = /Over\s(\d+)\s/; const regexMatcher = /Over\s(\d+)\s/;
const updateRange = 100; const updateRange = 100;
const __dirname = getDirnameFromImportMeta(import.meta.url); const __dirname = getDirnameFromImportMeta(import.meta.url);
const rootDir = path.resolve(__dirname, '..', '..'); const rootDirectory = path.resolve(__dirname, '..', '..');
const readmeFile = path.resolve(rootDir, 'README.md'); const readmeFile = path.resolve(rootDirectory, 'README.md');
const readmeContent = await fs.readFile(readmeFile, 'utf-8'); const readmeContent = await fs.readFile(readmeFile, 'utf8');
let overNIconsInReadme; let overNIconsInReadme;
try { try {
overNIconsInReadme = parseInt(regexMatcher.exec(readmeContent)[1]); overNIconsInReadme = Number.parseInt(regexMatcher.exec(readmeContent)[1], 10);
} catch (err) { } catch (error) {
console.error( console.error(
'Failed to obtain number of SVG icons of current milestone in README:', 'Failed to obtain number of SVG icons of current milestone in README:',
err, error,
); );
process.exit(1); process.exit(1);
} }
const nIcons = (await getIconsData()).length; const iconsData = await getIconsData();
const nIcons = iconsData.length;
const newNIcons = overNIconsInReadme + updateRange; const newNIcons = overNIconsInReadme + updateRange;
if (nIcons > newNIcons) { if (nIcons > newNIcons) {

View File

@ -1,17 +1,17 @@
import path from 'node:path';
import fs from 'node:fs/promises'; import fs from 'node:fs/promises';
import { getDirnameFromImportMeta, getIconDataPath } from '../sdk.mjs'; import path from 'node:path';
import {getDirnameFromImportMeta, getIconDataPath} from '../sdk.mjs';
const __dirname = getDirnameFromImportMeta(import.meta.url); const __dirname = getDirnameFromImportMeta(import.meta.url);
/** /**
* Get JSON schema data. * Get JSON schema data.
* @param {String} rootDir Path to the root directory of the project. * @param {String} rootDirectory Path to the root directory of the project.
*/ */
export const getJsonSchemaData = async ( export const getJsonSchemaData = async (
rootDir = path.resolve(__dirname, '..'), rootDirectory = path.resolve(__dirname, '..'),
) => { ) => {
const jsonSchemaPath = path.resolve(rootDir, '.jsonschema.json'); const jsonSchemaPath = path.resolve(rootDirectory, '.jsonschema.json');
const jsonSchemaString = await fs.readFile(jsonSchemaPath, 'utf8'); const jsonSchemaString = await fs.readFile(jsonSchemaPath, 'utf8');
return JSON.parse(jsonSchemaString); return JSON.parse(jsonSchemaString);
}; };
@ -19,14 +19,14 @@ export const getJsonSchemaData = async (
/** /**
* Write icons data to _data/simple-icons.json. * Write icons data to _data/simple-icons.json.
* @param {Object} iconsData Icons data object. * @param {Object} iconsData Icons data object.
* @param {String} rootDir Path to the root directory of the project. * @param {String} rootDirectory Path to the root directory of the project.
*/ */
export const writeIconsData = async ( export const writeIconsData = async (
iconsData, iconsData,
rootDir = path.resolve(__dirname, '..'), rootDirectory = path.resolve(__dirname, '..'),
) => { ) => {
await fs.writeFile( await fs.writeFile(
getIconDataPath(rootDir), getIconDataPath(rootDirectory),
`${JSON.stringify(iconsData, null, 4)}\n`, `${JSON.stringify(iconsData, null, 4)}\n`,
'utf8', 'utf8',
); );

16
sdk.d.ts vendored
View File

@ -3,7 +3,7 @@
* Types for Simple Icons SDK. * Types for Simple Icons SDK.
*/ */
import type { CustomLicense, SPDXLicense } from './types'; import type {CustomLicense, SPDXLicense} from './types';
/** /**
* The data for a third-party extension. * The data for a third-party extension.
@ -33,14 +33,14 @@ type ThirdPartyExtensionSubject = {
export type Aliases = { export type Aliases = {
aka?: string[]; aka?: string[];
dup?: DuplicateAlias[]; dup?: DuplicateAlias[];
loc?: { [key: string]: string }; loc?: Record<string, string>;
}; };
type DuplicateAlias = { type DuplicateAlias = {
title: string; title: string;
hex?: string; hex?: string;
guidelines?: string; guidelines?: string;
loc?: { [key: string]: string }; loc?: Record<string, string>;
}; };
/** /**
@ -62,8 +62,8 @@ export type IconData = {
/* The next code is autogenerated from sdk.mjs */ /* The next code is autogenerated from sdk.mjs */
export const URL_REGEX: RegExp; export const URL_REGEX: RegExp; // eslint-disable-line @typescript-eslint/naming-convention
export const SVG_PATH_REGEX: RegExp; export const SVG_PATH_REGEX: RegExp; // eslint-disable-line @typescript-eslint/naming-convention
export function getDirnameFromImportMeta(importMetaUrl: string): string; export function getDirnameFromImportMeta(importMetaUrl: string): string;
export function getIconSlug(icon: IconData): string; export function getIconSlug(icon: IconData): string;
export function svgToPath(svg: string): string; export function svgToPath(svg: string): string;
@ -71,9 +71,9 @@ export function titleToSlug(title: string): string;
export function slugToVariableName(slug: string): string; export function slugToVariableName(slug: string): string;
export function titleToHtmlFriendly(brandTitle: string): string; export function titleToHtmlFriendly(brandTitle: string): string;
export function htmlFriendlyToTitle(htmlFriendlyTitle: string): string; export function htmlFriendlyToTitle(htmlFriendlyTitle: string): string;
export function getIconDataPath(rootDir?: string): string; export function getIconDataPath(rootDirectory?: string): string;
export function getIconsDataString(rootDir?: string): string; export function getIconsDataString(rootDirectory?: string): string;
export function getIconsData(rootDir?: string): IconData[]; export function getIconsData(rootDirectory?: string): IconData[];
export function normalizeNewlines(text: string): string; export function normalizeNewlines(text: string): string;
export function normalizeColor(text: string): string; export function normalizeColor(text: string): string;
export function getThirdPartyExtensions( export function getThirdPartyExtensions(

64
sdk.mjs
View File

@ -3,9 +3,9 @@
* Simple Icons SDK. * Simple Icons SDK.
*/ */
import path from 'node:path';
import fs from 'node:fs/promises'; import fs from 'node:fs/promises';
import { fileURLToPath } from 'node:url'; import path from 'node:path';
import {fileURLToPath} from 'node:url';
/** /**
* @typedef {import("./sdk").ThirdPartyExtension} ThirdPartyExtension * @typedef {import("./sdk").ThirdPartyExtension} ThirdPartyExtension
@ -26,12 +26,12 @@ const TITLE_TO_SLUG_REPLACEMENTS = {
ŧ: 't', ŧ: 't',
}; };
const TITLE_TO_SLUG_CHARS_REGEX = RegExp( const TITLE_TO_SLUG_CHARS_REGEX = new RegExp(
`[${Object.keys(TITLE_TO_SLUG_REPLACEMENTS).join('')}]`, `[${Object.keys(TITLE_TO_SLUG_REPLACEMENTS).join('')}]`,
'g', 'g',
); );
const TITLE_TO_SLUG_RANGE_REGEX = /[^a-z0-9]/g; const TITLE_TO_SLUG_RANGE_REGEX = /[^a-z\d]/g;
/** /**
* Regex to validate HTTPs URLs. * Regex to validate HTTPs URLs.
@ -41,7 +41,7 @@ export const URL_REGEX = /^https:\/\/[^\s"']+$/;
/** /**
* Regex to validate SVG paths. * Regex to validate SVG paths.
*/ */
export const SVG_PATH_REGEX = /^m[-mzlhvcsqtae0-9,. ]+$/i; export const SVG_PATH_REGEX = /^m[-mzlhvcsqtae\d,. ]+$/i;
/** /**
* Get the directory name where this file is located from `import.meta.url`, * Get the directory name where this file is located from `import.meta.url`,
@ -74,12 +74,12 @@ export const svgToPath = (svg) => svg.split('"', 8)[7];
export const titleToSlug = (title) => export const titleToSlug = (title) =>
title title
.toLowerCase() .toLowerCase()
.replace( .replaceAll(
TITLE_TO_SLUG_CHARS_REGEX, TITLE_TO_SLUG_CHARS_REGEX,
(char) => TITLE_TO_SLUG_REPLACEMENTS[char], (char) => TITLE_TO_SLUG_REPLACEMENTS[char],
) )
.normalize('NFD') .normalize('NFD')
.replace(TITLE_TO_SLUG_RANGE_REGEX, ''); .replaceAll(TITLE_TO_SLUG_RANGE_REGEX, '');
/** /**
* Converts a slug into a variable name that can be exported. * Converts a slug into a variable name that can be exported.
@ -99,12 +99,12 @@ export const slugToVariableName = (slug) => {
*/ */
export const titleToHtmlFriendly = (brandTitle) => export const titleToHtmlFriendly = (brandTitle) =>
brandTitle brandTitle
.replace(/&/g, '&amp;') .replaceAll('&', '&amp;')
.replace(/"/g, '&quot;') .replaceAll('"', '&quot;')
.replace(/</g, '&lt;') .replaceAll('<', '&lt;')
.replace(/>/g, '&gt;') .replaceAll('>', '&gt;')
.replace(/./g, (char) => { .replaceAll(/./g, (char) => {
const charCode = char.charCodeAt(0); const charCode = char.codePointAt(0);
return charCode > 127 ? `&#${charCode};` : char; return charCode > 127 ? `&#${charCode};` : char;
}); });
@ -116,43 +116,45 @@ export const titleToHtmlFriendly = (brandTitle) =>
*/ */
export const htmlFriendlyToTitle = (htmlFriendlyTitle) => export const htmlFriendlyToTitle = (htmlFriendlyTitle) =>
htmlFriendlyTitle htmlFriendlyTitle
.replace(/&#([0-9]+);/g, (_, num) => String.fromCodePoint(parseInt(num))) .replaceAll(/&#(\d+);/g, (_, number_) =>
.replace( String.fromCodePoint(Number.parseInt(number_, 10)),
)
.replaceAll(
/&(quot|amp|lt|gt);/g, /&(quot|amp|lt|gt);/g,
(_, ref) => ({ quot: '"', amp: '&', lt: '<', gt: '>' })[ref], (_, reference) => ({quot: '"', amp: '&', lt: '<', gt: '>'})[reference],
); );
/** /**
* Get path of *_data/simpe-icons.json*. * Get path of *_data/simpe-icons.json*.
* @param {String} rootDir Path to the root directory of the project * @param {String} rootDirectory Path to the root directory of the project
* @returns {String} Path of *_data/simple-icons.json* * @returns {String} Path of *_data/simple-icons.json*
*/ */
export const getIconDataPath = ( export const getIconDataPath = (
rootDir = getDirnameFromImportMeta(import.meta.url), rootDirectory = getDirnameFromImportMeta(import.meta.url),
) => { ) => {
return path.resolve(rootDir, '_data', 'simple-icons.json'); return path.resolve(rootDirectory, '_data', 'simple-icons.json');
}; };
/** /**
* Get contents of *_data/simple-icons.json*. * Get contents of *_data/simple-icons.json*.
* @param {String} rootDir Path to the root directory of the project * @param {String} rootDirectory Path to the root directory of the project
* @returns {String} Content of *_data/simple-icons.json* * @returns {String} Content of *_data/simple-icons.json*
*/ */
export const getIconsDataString = ( export const getIconsDataString = (
rootDir = getDirnameFromImportMeta(import.meta.url), rootDirectory = getDirnameFromImportMeta(import.meta.url),
) => { ) => {
return fs.readFile(getIconDataPath(rootDir), 'utf8'); return fs.readFile(getIconDataPath(rootDirectory), 'utf8');
}; };
/** /**
* Get icons data as object from *_data/simple-icons.json*. * Get icons data as object from *_data/simple-icons.json*.
* @param {String} rootDir Path to the root directory of the project * @param {String} rootDirectory Path to the root directory of the project
* @returns {IconData[]} Icons data as array from *_data/simple-icons.json* * @returns {IconData[]} Icons data as array from *_data/simple-icons.json*
*/ */
export const getIconsData = async ( export const getIconsData = async (
rootDir = getDirnameFromImportMeta(import.meta.url), rootDirectory = getDirnameFromImportMeta(import.meta.url),
) => { ) => {
const fileContents = await getIconsDataString(rootDir); const fileContents = await getIconsDataString(rootDirectory);
return JSON.parse(fileContents).icons; return JSON.parse(fileContents).icons;
}; };
@ -162,7 +164,7 @@ export const getIconsData = async (
* @returns {String} The text with Windows newline characters replaced by Unix ones * @returns {String} The text with Windows newline characters replaced by Unix ones
*/ */
export const normalizeNewlines = (text) => { export const normalizeNewlines = (text) => {
return text.replace(/\r\n/g, '\n'); return text.replaceAll('\r\n', '\n');
}; };
/** /**
@ -173,10 +175,14 @@ export const normalizeNewlines = (text) => {
export const normalizeColor = (text) => { export const normalizeColor = (text) => {
let color = text.replace('#', '').toUpperCase(); let color = text.replace('#', '').toUpperCase();
if (color.length < 6) { if (color.length < 6) {
color = [...color.slice(0, 3)].map((x) => x.repeat(2)).join(''); color = color
.slice(0, 3)
.map((x) => x.repeat(2))
.join('');
} else if (color.length > 6) { } else if (color.length > 6) {
color = color.slice(0, 6); color = color.slice(0, 6);
} }
return color; return color;
}; };
@ -201,11 +207,11 @@ export const getThirdPartyExtensions = async (
module = module.split('<img src="')[0]; module = module.split('<img src="')[0];
return { return {
module: { module: {
name: /\[(.+)\]/.exec(module)[1], name: /\[(.+)]/.exec(module)[1],
url: /\((.+)\)/.exec(module)[1], url: /\((.+)\)/.exec(module)[1],
}, },
author: { author: {
name: /\[(.+)\]/.exec(author)[1], name: /\[(.+)]/.exec(author)[1],
url: /\((.+)\)/.exec(author)[1], url: /\((.+)\)/.exec(author)[1],
}, },
}; };

File diff suppressed because it is too large Load Diff

View File

@ -1,4 +1,4 @@
export default { const config = {
multipass: true, multipass: true,
eol: 'lf', eol: 'lf',
plugins: [ plugins: [
@ -62,7 +62,7 @@ export default {
// Convert basic shapes (such as <circle>) to <path> // Convert basic shapes (such as <circle>) to <path>
name: 'convertShapeToPath', name: 'convertShapeToPath',
params: { params: {
// including <arc> // Including <arc>
convertArcs: true, convertArcs: true,
}, },
}, },
@ -93,7 +93,7 @@ export default {
// to the <svg> tag if it's not there already // to the <svg> tag if it's not there already
name: 'addAttributesToSVGElement', name: 'addAttributesToSVGElement',
params: { params: {
attributes: [{ role: 'img', xmlns: 'http://www.w3.org/2000/svg' }], attributes: [{role: 'img', xmlns: 'http://www.w3.org/2000/svg'}],
}, },
}, },
'removeOffCanvasPaths', 'removeOffCanvasPaths',
@ -102,3 +102,5 @@ export default {
'reusePaths', 'reusePaths',
], ],
}; };
export default config;

View File

@ -1,16 +1,16 @@
import { test } from 'mocha'; import {strict as assert} from 'node:assert';
import { strict as assert } from 'node:assert'; import {test} from 'mocha';
import { getThirdPartyExtensions } from '../sdk.mjs'; import {getThirdPartyExtensions} from '../sdk.mjs';
test('README third party extensions must be alphabetically sorted', async () => { test('README third party extensions must be alphabetically sorted', async () => {
const thirdPartyExtensions = await getThirdPartyExtensions(); const thirdPartyExtensions = await getThirdPartyExtensions();
assert.ok(thirdPartyExtensions.length > 0); assert.ok(thirdPartyExtensions.length > 0);
const thirdPartyExtensionsNames = thirdPartyExtensions.map( const thirdPartyExtensionsNames = thirdPartyExtensions.map(
(ext) => ext.module.name, (extension) => extension.module.name,
); );
const expectedOrder = thirdPartyExtensionsNames.slice().sort(); const expectedOrder = [...thirdPartyExtensionsNames].sort();
assert.deepEqual( assert.deepEqual(
thirdPartyExtensionsNames, thirdPartyExtensionsNames,
expectedOrder, expectedOrder,

View File

@ -1,6 +1,6 @@
import { getIconsData, getIconSlug, slugToVariableName } from '../sdk.mjs';
import * as simpleIcons from '../index.mjs'; import * as simpleIcons from '../index.mjs';
import { testIcon } from './test-icon.js'; import {getIconSlug, getIconsData, slugToVariableName} from '../sdk.mjs';
import {testIcon} from './test-icon.js';
for (const icon of await getIconsData()) { for (const icon of await getIconsData()) {
const slug = getIconSlug(icon); const slug = getIconSlug(icon);

View File

@ -1,6 +1,6 @@
const { reporters, Runner } = require('mocha'); const {reporters, Runner} = require('mocha');
const { EVENT_RUN_END } = Runner.constants; const {EVENT_RUN_END} = Runner.constants;
class EvenMoreMin extends reporters.Base { class EvenMoreMin extends reporters.Base {
constructor(runner) { constructor(runner) {

View File

@ -1,7 +1,7 @@
import {strict as assert} from 'node:assert';
import fs from 'node:fs/promises'; import fs from 'node:fs/promises';
import path from 'node:path'; import path from 'node:path';
import { strict as assert } from 'node:assert'; import {describe, it} from 'mocha';
import { describe, it } from 'mocha';
import { import {
SVG_PATH_REGEX, SVG_PATH_REGEX,
URL_REGEX, URL_REGEX,
@ -9,7 +9,7 @@ import {
titleToSlug, titleToSlug,
} from '../sdk.mjs'; } from '../sdk.mjs';
const iconsDir = path.resolve( const iconsDirectory = path.resolve(
getDirnameFromImportMeta(import.meta.url), getDirnameFromImportMeta(import.meta.url),
'..', '..',
'icons', 'icons',
@ -26,7 +26,7 @@ const iconsDir = path.resolve(
* @param {String} slug Icon data slug * @param {String} slug Icon data slug
*/ */
export const testIcon = (icon, subject, slug) => { export const testIcon = (icon, subject, slug) => {
const svgPath = path.resolve(iconsDir, `${slug}.svg`); const svgPath = path.resolve(iconsDirectory, `${slug}.svg`);
describe(icon.title, () => { describe(icon.title, () => {
it('has the correct "title"', () => { it('has the correct "title"', () => {
@ -81,7 +81,7 @@ export const testIcon = (icon, subject, slug) => {
}); });
if (icon.slug) { if (icon.slug) {
// if an icon data has a slug, it must be different to the // If an icon data has a slug, it must be different to the
// slug inferred from the title, which prevents adding // slug inferred from the title, which prevents adding
// unnecessary slugs to icons data // unnecessary slugs to icons data
it(`'${icon.title}' slug must be necessary`, () => { it(`'${icon.title}' slug must be necessary`, () => {

5
types.d.ts vendored
View File

@ -5,6 +5,7 @@
*/ */
export type License = SPDXLicense | CustomLicense; export type License = SPDXLicense | CustomLicense;
// eslint-disable-next-line @typescript-eslint/naming-convention
export type SPDXLicense = { export type SPDXLicense = {
type: string; type: string;
url: string; url: string;
@ -18,7 +19,7 @@ export type CustomLicense = {
/** /**
* The data for a Simple Icon as is exported by the npm package. * The data for a Simple Icon as is exported by the npm package.
*/ */
export interface SimpleIcon { export type SimpleIcon = {
title: string; title: string;
slug: string; slug: string;
svg: string; svg: string;
@ -27,4 +28,4 @@ export interface SimpleIcon {
hex: string; hex: string;
guidelines?: string; guidelines?: string;
license?: License; license?: License;
} };