From 95111a7543d935acba99b1aab2eceeee5fdc73ee Mon Sep 17 00:00:00 2001 From: Chris Thoburn Date: Tue, 12 Nov 2024 00:54:46 -0800 Subject: [PATCH] fix badge in readme --- README.md | 2 +- ...-gold _100.svg => NCC-1701-a-gold_100.svg} | 0 logos/docs-badge.svg | 2 + package.json | 3 +- pnpm-lock.yaml | 44 ++++++++++ scripts/generate-badge.mjs | 85 +++++++++++++++++++ 6 files changed, 134 insertions(+), 2 deletions(-) rename logos/{NCC-1701-a-gold _100.svg => NCC-1701-a-gold_100.svg} (100%) create mode 100644 logos/docs-badge.svg create mode 100644 scripts/generate-badge.mjs diff --git a/README.md b/README.md index ba5339b0347..87cb861758d 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ ![NPM Stable Version](https://img.shields.io/npm/v/ember-data/latest?label=version&style=flat&color=FFC474) ![NPM Downloads](https://img.shields.io/npm/dm/ember-data.svg?style=flat&color=FFC474) ![License](https://img.shields.io/github/license/emberjs/data.svg?style=flat&color=FFC474) -[![Docs](https://img.shields.io/badge/API%20Docs-grey?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMDAiIGhlaWdodD0iMTAwIj48cGF0aCBkPSJNOTEuMzYgMzMuNTY2cS02LjY0NS02LjYyMy0xNS45OTctNi42MjUtOC40MzkgMC0xNC43NjEgNS40ODUtNi4zMjkgNS40ODQtNy41OTQgMTMuNjA1bDQuNDY1LjM1MlE1OS4zIDQ2LjQxOCA2MC4xOCA0OGgxLjU4MnExLjQ3NiAwIDEuNDc2IDEuNDQxIDAgMS40NC0xLjQ3NiAxLjQzOEg2MC4zMnEtLjg0MyAxLjc5My0yLjg0NyAxLjg2M2wtNC40NjUuMzg3cTEuMjY2IDguMDg1IDcuNTk0IDEzLjU3dDE0Ljc2MSA1LjQ4NXE5LjM1MiAwIDE1Ljk5Ni02LjY0NSA2LjY0NS02LjY0NiA2LjY0NS0xNS45NTcgMC05LjM4OS02LjY0NS0xNi4wMTJabS02LjYyMiAxNS40NDJhLjQ0NS40NDUgMCAxIDAgLjg5IDAgLjQ0NS40NDUgMCAwIDAtLjg5IDBtLTguNzEtOS4yNThjMCAuMjQ2LjE5OS40NS40NDUuNDVhLjQ1LjQ1IDAgMCAwIC40NDUtLjQ1LjQ0NS40NDUgMCAxIDAtLjg5IDBtLTEuMDQgMGMwIC4yNDYuMi40NS40NDYuNDVhLjQ1LjQ1IDAgMCAwIC40NDUtLjQ1LjQ0NS40NDUgMCAxIDAtLjg5IDBtOS43NSAxMC4yOTdhLjQ0NS40NDUgMCAxIDAgLjg5IDAgLjQ0NS40NDUgMCAwIDAtLjg5IDBtLTguNzEgOS4zMDVhLjQ0NS40NDUgMCAxIDAgLjg5IDAgLjQ0NS40NDUgMCAwIDAtLjg5IDBtLTEuMDQgMGEuNDQ1LjQ0NSAwIDEgMCAuODkgMCAuNDQ1LjQ0NSAwIDAgMC0uODkgME00LjMyIDMyLjgxMnExLjc1Ny0uMzE1IDQuMjItLjQ5MmwtMy44NjgtLjA3Wk00NS45NzcgNDYuOTFxLTEuMDktLjI4LTIuMzU2LTEuNjE3bC04LjQzNy04LjYxM2gtOS4yNzhsMTQuNDggMTAuNTA4di4zNTFxMi43MDguNzc0IDUuNTktLjYzM1ptMy45NzItMTIuMzc1cS0uMTA1LjQyMS0uNDkyLjgwOWgtLjQyMmwtLjUyNy0uNDIyaC02LjYxdi0uMzg3Wm0tLjQ5Mi0xLjMzNnEuMzg3LjM4OC40OTIuODQ0SDQxLjl2LS4zODdoNi42MDlsLjUyNy0uNDU3Wk00LjMyIDY2LjM0OGwuMzUyLjU2MiAzLjg2Ny0uMDdxLTIuODEyLS4yODItNC4yMTktLjQ5Mk00NS45NzcgNTIuMjVxLTIuODgzLTEuNDQtNS41OS0uNjMzdi4zNTJMMjUuOTA3IDYyLjQ4aDkuMjc3bDguNDM3LTguNjQ4cTEuMy0xLjMzNSAyLjM1Ni0xLjU4Mm0zLjk3MiAxMi4zNzVINDEuOXYtLjM4N2g2LjYwOWwuNTI3LS40NTdoLjQyMnEuMzg3LjQ1Ny40OTIuODQ0bS0uNDkyIDEuM2gtLjQyMmwtLjUyNy0uNDIxaC02LjYxdi0uMzg3aDguMDUxcS0uMTA1LjM4Ny0uNDkyLjgwOW0tOC41NDMuODFxLjQ1Ny4xNzUuOTUuMTc1aDUuNDEzcTMuMDk0IDAgMy4wOTQtMi4xMSAwLTEuMDUyLTEuMTYtMS41NjJ0LTEuOTM0LS41MTFoLTUuNDE0cS0uNTk4IDAtLjk0OS4xNEgxMy4xMXEtLjYzMy4wMDEtNS44Ny40MDYtNS4yNC40MDQtNS4yMzkgMS4wMzZ2Ljk4NHEwIC41NjEgNS4yMzggMSA1LjIzOS40NCA1Ljg3MS40NDFabTEwLjQ0MS0xNy4yOTdoLTMuNTVxLS40MjMuMTQgMCAuMjhoMy41NVptLTMuNjIuNzAzaC0uNDU4di0xLjEyNWguNDU3cTIuMTQ1LS43NzMgNC4xMTQtLjk1bC4zODYtMi4xMDkuMzg3LjAzNWMuMDQ3LS4zNTEuMTQtLjg1MS4yODEtMS41MDhxLTMuNTg1LS4wNy04LjkzLjU2My40NTguNTIzLjk1LjkxLjU5Ny40MjIgMS4xNi41NjNsMS4wNTUuMjQ2LS45ODUuNDkycS0xLjY4OC44NDMtNC4xODMuODQ0LS42MzMgMC0uODgtLjAzNmExMCAxMCAwIDAgMS0uODQzLS4xNGwtLjI4MS0uMTA2di0uNDU3bC0yLjAwNC0xLjQ0MXEtNS4xNjIuNzA0LTYuOTkyLjczOC0zLjkzOC4wMzUtMy45MzggMi45MTggMCAyLjc3NyAzLjkzOCAyLjkxOCAyLjM1Ni4wMzYgNi45OTIuNzM4bDIuMDA0LTEuNDQxdi0uNDU3bC4yODEtLjEwNnEuMzE2LS4xMDUuODQ0LS4xNC4yNDYtLjAzNS44NzktLjAzNSAyLjQ5NiAwIDQuMTgzLjg0M2wuOTg1LjQ1Ny0xLjA1NS4yODJxLS41NjMuMTA2LTEuMTYuNTYyLS40NTcuMjgxLS45NS44OCA1LjEuNjMxIDguOTMuNTk3LS4yMS0uOTE1LS4yOC0xLjUxMmgtLjM4OGwtLjM4Ni0yLjA3NGEyMC43IDIwLjcgMCAwIDEtNC4xMTQtLjk1bTQuMDQyLTEuNjg4cS0xLjU4MS4yMS0yLjc3Ny41NjNoMi40MjZsLjMxNi0uMzUyWm0tLjM1MSAxLjY4OEg0OXExLjE5Ni4zMTYgMi43NzcuNTYybC0uMDM1LS4yMVptMTEuMzg2LS43MDNxMC0xLjA1NS0xLjA1LTEuMDU1aC0xLjc5M3EtLjgxLTEuNTgyLTIuNTMyLTEuNTgybC00Ljg1MS0uNDIyLS40OTIgMi40Ni0uMzUyLjQyM3YuNjMzbC4zNTIuNDIxLjQ5MiAyLjQyNiA0Ljg1Mi0uNDIycTEuOTMzIDAgMi42MzYtMS44MjhoMS42ODhxMS4wNSAwIDEuMDUtMS4wNTRtLTMuODk4LjE0cTAtMS40NC0xLjQ3Ny0xLjQ0MS0xLjQ0IDAtMS40NCAxLjQ0MSAwIDEuNDc2IDEuNDQgMS40NzcgMS40NzcgMCAxLjQ3Ny0xLjQ3N20uMzg3IDBxMCAxLjg2My0xLjg2NCAxLjg2My0xLjg2MyAwLTEuODYzLTEuODYzdDEuODY0LTEuODYzIDEuODYzIDEuODYzbS0xLjE2IDBxMC0uNzAzLS43MDMtLjcwMy0uNjY4IDAtLjY2OC43MDN0LjY2Ny43MDNxLjcwNCAwIC43MDQtLjcwM20uMzg2IDBxMCAxLjA5LTEuMDkgMS4wOS0xLjA1NCAwLTEuMDU0LTEuMDl0MS4wNTQtMS4wOXExLjA5IDAgMS4wOSAxLjA5bS0zLjY1Ni0uMTc2di4zNTJoLTIuOTE4di0uMzUyWm0yMS41NDcuMTc2cS0uMDctMS4wNTUtMS4wNTUtMS4wNTUtMS4wNTQgMC0xLjA1NCAxLjA1NXQxLjA1NCAxLjA1NSAxLjA1NS0xLjA1NW0uMzg3IDBxMCAxLjQ0Mi0xLjQ0MiAxLjQ0Mi0xLjQ0IDAtMS40NDEtMS40NDIgMC0xLjQ0IDEuNDQxLTEuNDQxIDEuNDQyIDAgMS40NDIgMS40NDFtMi43MDcgMHEwLTEuNzIzLTEuMjMtMi45NTMtMS4xOTYtMS4xOTUtMi45MTktMS4xOTUtMS44OTggMC00LjE0OCAxLjQ0MS0yLjMyIDEuNDQxLTIuMzIgMi43MDcgMCAxLjIzIDIuMzIgMi43MDcgMi4yNSAxLjQ0MiA0LjE0OCAxLjQ0MiAxLjcyMyAwIDIuOTE4LTEuMjMgMS4yMy0xLjE5NiAxLjIzLTIuOTE5bS40MjIgMHEwIDEuODYzLTEuMzM2IDMuMi0xLjMzNyAxLjMzNS0zLjIzNSAxLjMzNS0xLjk2OCAwLTQuMzYtMS41MTEtMi41My0xLjU4My0yLjUzLTMuMDI0IDAtMS40NCAyLjUzLTMuMDU4YzEuNTk1LTEuMDA4IDMuMDQ4LTEuNTA4IDQuMzYtMS41MDggMS4yMTkgMCAyLjI5Ny40NDEgMy4yMzUgMS4zMzJxMS4zMzUgMS4zNzEgMS4zMzYgMy4yMzRtLTQuNTM2LTIuNDI2cS0uNDkyIDAtMS41ODIuNDIyLS45ODQuNDkzLS45ODQuNjMzdjIuNzA3cTAgLjM4Ny45ODQuNjMzLjk4NS40MjIgMS41ODIuNDIyIDIuNDI3IDAgMi40OTctMi4zMiAwLTIuNDYxLTIuNDk3LTIuNDk3bTIuODgzIDIuNDI2di4wN3EwIDIuNjczLTIuODgzIDIuNzQzLS41NjIgMC0xLjc1Ny0uNDU3LS44NzktLjQ5My0uOTg1LS41OThhLjUzLjUzIDAgMCAxLS4yMS0uNDIydi0yLjcwN3EwLS4xNzUuMTc1LS4zODcuMzg3LS4zNTEgMS4wMi0uNTk3IDEuMTI1LS40NTcgMS43NTctLjQ1NyAyLjgxMy4wMzQgMi44ODMgMi44MTJNNDAuOTE0IDMyLjM5MUgxMy4xMXEtLjYzMyAwLTUuODcuNDIyLTUuMjQuNDItNS4yMzkgMS4wNTR2Ljk1cTAgLjU5NyA1LjIzOCAxLjAxOXQ1Ljg3MS40MjJoMjcuODA1cS40NTcuMTc2Ljk1LjE3Nmg1LjQxM3EuNjY3IDAgMS44OC0uNTYzdDEuMjE0LTEuNTEycS4wMzUtMi4xMDktMy4wOTQtMi4xMDloLTUuNDE0cS0uNTk4IDAtLjk0OS4xNG0wIDAiIHN0eWxlPSJzdHJva2U6bm9uZTtmaWxsLXJ1bGU6ZXZlbm9kZDtmaWxsOiNmZmM0NzQ7ZmlsbC1vcGFjaXR5OjEiLz48L3N2Zz4=&logoColor=FFC474)](https://api.emberjs.com/ember-data/release) +[![Docs](./logos/docs-badge.svg)](https://api.emberjs.com/ember-data/release) [![Discord Community Server](https://img.shields.io/badge/Discord-grey?logo=discord&logoColor=FFC474)](https://discord.gg/zT3asNS ) diff --git a/logos/NCC-1701-a-gold _100.svg b/logos/NCC-1701-a-gold_100.svg similarity index 100% rename from logos/NCC-1701-a-gold _100.svg rename to logos/NCC-1701-a-gold_100.svg diff --git a/logos/docs-badge.svg b/logos/docs-badge.svg new file mode 100644 index 00000000000..538e63241d9 --- /dev/null +++ b/logos/docs-badge.svg @@ -0,0 +1,2 @@ +Api DocsApi Docs \ No newline at end of file diff --git a/package.json b/package.json index 3e0b415c5ca..c4a6b601eb0 100644 --- a/package.json +++ b/package.json @@ -41,6 +41,7 @@ "@glint/environment-ember-template-imports": "1.5.0", "@glint/template": "1.5.0", "@types/semver": "^7.5.8", + "badge-maker": "4.1.0", "bun-types": "^1.1.30", "chalk": "^4.1.2", "co": "^4.6.0", @@ -165,4 +166,4 @@ "@ember/test-helpers@4.0.4": "patches/@ember__test-helpers@4.0.4.patch" } } -} +} \ No newline at end of file diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 45d4478581a..d62e2efed73 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -70,6 +70,9 @@ importers: '@types/semver': specifier: ^7.5.8 version: 7.5.8 + badge-maker: + specifier: 4.1.0 + version: 4.1.0 bun-types: specifier: ^1.1.30 version: 1.1.30 @@ -8740,6 +8743,12 @@ packages: resolution: {integrity: sha512-S2Hw0TtNkMJhIabBwIojKL9YHO5T0n5eNqWJ7Lrlel/zDbftQpxpapi8tZs3X1HWa+u+QeydGmzzNU0m09+Rcg==} engines: {node: '>=0.4.2'} + /anafanafo@2.0.0: + resolution: {integrity: sha512-Nlfq7NC4AOkTJerWRIZcOAiMNtIDVIGWGvQ98O7Jl6Kr2Dk0dX5u4MqN778kSRTy5KRqchpLdF2RtLFEz9FVkQ==} + dependencies: + char-width-table-consumer: 1.0.0 + dev: true + /ansi-align@3.0.1: resolution: {integrity: sha512-IOfwwBF5iczOjp/WeY4YxyjqAFMQoZufdQWDd19SEExbVLNXqvpzSJ/M7Za4/sCPmQ0+GRquoA7bGcINcxew6w==} dependencies: @@ -9262,6 +9271,15 @@ packages: /backburner.js@2.8.0: resolution: {integrity: sha512-zYXY0KvpD7/CWeOLF576mV8S+bQsaIoj/GNLXXB+Eb8SJcQy5lqSjkRrZ0MZhdKUs9QoqmGNIEIe3NQfGiiscQ==} + /badge-maker@4.1.0: + resolution: {integrity: sha512-qYImXoz0WZRMaauqSMo6QNurKp26K3RcOhefuGfno50xmAzHEJsgHbP4gnHs6Ps53KgQgFi4MJKB6Rq8H7siww==} + engines: {node: '>=16'} + hasBin: true + dependencies: + anafanafo: 2.0.0 + css-color-converter: 2.0.0 + dev: true + /balanced-match@1.0.2: resolution: {integrity: sha512-3oSeUO0TMV67hN1AmbXsK4yaqU7tjiHlbxRDZOpH0KW9+CeX4bRAaX0Anxt0tx2MrpRpWwQaPwIlISEJhYU5Pw==} @@ -9304,6 +9322,10 @@ packages: engines: {node: '>=8'} requiresBuild: true + /binary-search@1.3.6: + resolution: {integrity: sha512-nbE1WxOTTrUWIfsfZ4aHGYu5DOuNkbxGokjV6Z2kxfJK3uaAb8zNK1muzOeipoLHZjInT4Br88BHpzevc681xA==} + dev: true + /binaryextensions@2.3.0: resolution: {integrity: sha512-nAihlQsYGyc5Bwq6+EsubvANYGExeJKHDO3RjnvwU042fawQTQfM3Kxn7IHUXQOz4bzfwsGYYHGSvXyW4zOGLg==} engines: {node: '>=0.8'} @@ -10201,6 +10223,12 @@ packages: resolution: {integrity: sha512-kWWXztvZ5SBQV+eRgKFeh8q5sLuZY2+8WUIzlxWVTg+oGwY14qylx1KbKzHd8P6ZYkAg0xyIDU9JMHhyJMZ1jw==} engines: {node: '>=10'} + /char-width-table-consumer@1.0.0: + resolution: {integrity: sha512-Fz4UD0LBpxPgL9i29CJ5O4KANwaMnX/OhhbxzvNa332h+9+nRKyeuLw4wA51lt/ex67+/AdsoBQJF3kgX2feYQ==} + dependencies: + binary-search: 1.3.6 + dev: true + /chardet@0.7.0: resolution: {integrity: sha512-mT8iDcrh03qDGRRmoA2hmBJnxpllMR+0/0qlzjqZES6NdiWDcZkCNAk4rPFZ9Q85r27unkiNNg8ZOiwZXBHwcA==} @@ -10394,6 +10422,10 @@ packages: map-visit: 1.0.0 object-visit: 1.0.1 + /color-convert@0.5.3: + resolution: {integrity: sha512-RwBeO/B/vZR3dfKL1ye/vx8MHZ40ugzpyfeVG5GsiuGnrlMWe2o8wxBbLCpw9CsxV+wHuzYlCiWnybrIA0ling==} + dev: true + /color-convert@1.9.3: resolution: {integrity: sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==} dependencies: @@ -10856,6 +10888,14 @@ packages: resolution: {integrity: sha512-v1plID3y9r/lPhviJ1wrXpLeyUIGAZ2SHNYTEapm7/8A9nLPoyvVp3RK/EPFqn5kEznyWgYZNsRtYYIWbuG8KA==} engines: {node: '>=8'} + /css-color-converter@2.0.0: + resolution: {integrity: sha512-oLIG2soZz3wcC3aAl/7Us5RS8Hvvc6I8G8LniF/qfMmrm7fIKQ8RIDDRZeKyGL2SrWfNqYspuLShbnjBMVWm8g==} + dependencies: + color-convert: 0.5.3 + color-name: 1.1.4 + css-unit-converter: 1.1.2 + dev: true + /css-loader@5.2.7(webpack@5.94.0): resolution: {integrity: sha512-Q7mOvpBNBG7YrVGMxRxcBJZFL75o+cH2abNASdibkj/fffYD8qWbInZrD0S9ccI6vZclF3DsHE7njGlLtaHbhg==} engines: {node: '>= 10.13.0'} @@ -10882,6 +10922,10 @@ packages: source-map: 0.6.1 dev: true + /css-unit-converter@1.1.2: + resolution: {integrity: sha512-IiJwMC8rdZE0+xiEZHeru6YoONC4rfPMqGm2W85jMIbkFvv5nFTwJVFHam2eFrN6txmoUYFAFXiv8ICVeTO0MA==} + dev: true + /cssesc@3.0.0: resolution: {integrity: sha512-/Tb/JcjK111nNScGob5MNtsntNM1aCNUDipB/TkwZFhyDrrE47SOx/18wF2bbjgc3ZzCSKW1T5nt5EbFoAz/Vg==} engines: {node: '>=4'} diff --git a/scripts/generate-badge.mjs b/scripts/generate-badge.mjs new file mode 100644 index 00000000000..7484047a083 --- /dev/null +++ b/scripts/generate-badge.mjs @@ -0,0 +1,85 @@ +import { makeBadge } from 'badge-maker'; +import fs from 'fs'; +import path from 'path'; + +/* +{ + label: 'build', // (Optional) Badge label + message: 'passed', // (Required) Badge message + labelColor: '#555', // (Optional) Label color + color: '#4c1', // (Optional) Message color + logoBase64: 'data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSI2NCIgaGVpZ2h0PSI2NCI+PHJlY3Qgd2lkdGg9IjY0IiBoZWlnaHQ9IjY0IiByeD0iOCIgZmlsbD0iI2IxY2U1NiIvPjxwYXRoIGQ9Ik04IDBoMjR2NjRIOGMtNC40MzIgMC04LTMuNTY4LTgtOFY4YzAtNC40MzIgMy41NjgtOCA4LTh6IiBmaWxsPSIjNWQ1ZDVkIi8+PC9zdmc+' // (Optional) Any custom logo can be passed in a URL parameter by base64 encoding + links: ['https://example.com', 'https://example.com'], // (Optional) Links array of maximum two links + + // (Optional) One of: 'plastic', 'flat', 'flat-square', 'for-the-badge' or 'social' + // Each offers a different visual design. + style: 'flat', + + // (Optional) A string with only letters, numbers, -, and _. This can be used + // to ensure every element id within the SVG is unique and prevent CSS + // cross-contamination when the SVG badge is rendered inline in HTML pages. + idSuffix: 'dd' +} +*/ +const args = process.argv.slice(2); +const argNames = { + label: 'l', + message: 'm', + labelColor: 'lc', + color: 'c', + logoPath: 'p', + links: 'ls', + style: 's', + idSuffix: 'id', + out: 'o', +}; +const argsMap = { + l: 'label', + m: 'message', + lc: 'labelColor', + c: 'color', + p: 'logoPath', + ls: 'links', + s: 'style', + id: 'idSuffix', + o: 'out', +}; + +const format = { + color: 'grey', + style: 'flat', +}; +let outPath = ''; + +for (let i = 0; i < args.length; i += 2) { + if (!args[i].startsWith('-')) { + throw new Error(`Invalid argument: ${args[i]}`); + } + const arg = args[i].slice(1); + const value = args[i + 1]; + const name = arg in argNames ? arg : arg in argsMap ? argsMap[arg] : null; + + if (!name) { + throw new Error(`Invalid argument: ${arg}`); + } + + if (name !== 'logoPath' && name !== 'out') { + format[name] = value; + continue; + } + + if (name === 'out') { + outPath = path.join(process.cwd(), value); + continue; + } + + const base64 = fs.readFileSync(path.join(process.cwd(), value), 'utf8'); + format.logoBase64 = base64; // `data:image/svg+xml;base64,${base64}`; +} + +const svg = makeBadge(format); +if (outPath) { + fs.writeFileSync(outPath, svg); +} else { + console.log(svg); +}