github-featured/dicebear--dicebear
2
0
Fork 0
Code Issues Pull Requests Deployments Models Agent Notes Packages Projects Releases Wiki Activity

style: reflow the docs files that eslint and prettier flagged

Browse Source 
The comment above StyleRow.credit opened with its text on the same line
as the /**, which multiline-comment-style does not count as JSDoc, so
the rule asked for line comments instead. It now starts on its own line
like the other doc blocks in the theme, which puts it back under the
checkJSDoc exception.

The rest is prettier. Four files from the licenses page work carried
hand-set line breaks. src/python/core/.pytest_cache/README.md is
generated and gitignored, but the prettier glob reaches into it anyway,
so the cache directory joins the other build output in .prettierignore.
This commit is contained in:
Florian Körner
2026-08-14 14:05:09 +02:00
parent 1d5f118943
commit e8b4c8c053
5 changed files with 50 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.prettierignore
+1
View File
@@ -12,6 +12,7 @@ tests
**/target/
**/vendor/
**/.dart_tool/
**/.pytest_cache/
apps/docs/.vitepress/cache/
src/js/core/src/Validator/*.js
apps/docs/.vitepress/llms.ts
+4 -5
View File
@@ -49,10 +49,7 @@ import {
} from './theme/config/styleCategories.ts';
import { usageSnippets } from './theme/config/usageSnippets.ts';
import { formatLicenseName } from './theme/utils/format.ts';
import {
attributionKind,
attributionPrefix,
} from './theme/utils/license.ts';
import { attributionKind, attributionPrefix } from './theme/utils/license.ts';
import { capitalCase } from 'change-case';
/**
@@ -547,7 +544,9 @@ The MIT license has a single condition: the copyright and permission notice
stays with the work.
${rows.MIT.join('\n')}${
mitNotice === undefined ? '' : `\n\nThe notice:\n\n${fence('', mitNotice)}`
mitNotice === undefined
? ''
: `\n\nThe notice:\n\n${fence('', mitNotice)}`
}`);
}
apps/docs/.vitepress/theme/components/pages/PageLicenses.vue
+35 -27
View File
@@ -28,8 +28,10 @@ interface StyleRow {
creatorUrl?: string;
licenseName: string;
licenseUrl?: string;
/** The license text from the definition; only the MIT rows surface it,
* since that license requires shipping its notice. */
/**
* The license text from the definition; only the MIT rows surface it,
* since that license requires shipping its notice.
*/
credit?: string;
seed: string;
}
@@ -193,8 +195,8 @@ function reflowParagraphs(text: string): string {
The person who associated a work with this deed has
<strong>dedicated</strong> the work to the public domain by waiving
all of his or her rights to the work worldwide under copyright law,
including all related and neighboring rights, to the extent allowed
by law.
including all related and neighboring rights, to the extent allowed by
law.
</p>
<p>
You can copy, modify, distribute and perform the work, even for
@@ -203,19 +205,19 @@ function reflowParagraphs(text: string): string {
</p>
<p class="page-licenses-quote-heading">Other Information</p>
<p>
In no way are the patent or trademark rights of any person affected
by CC0, nor are the rights that other persons may have in the work
or in how the work is used, such as publicity or privacy rights.
In no way are the patent or trademark rights of any person affected by
CC0, nor are the rights that other persons may have in the work or in
how the work is used, such as publicity or privacy rights.
</p>
<p>
Unless expressly stated otherwise, the person who associated a work
with this deed makes no warranties about the work, and disclaims
liability for all uses of the work, to the fullest extent permitted
by applicable law.
liability for all uses of the work, to the fullest extent permitted by
applicable law.
</p>
<p>
When using or citing the work, you should not imply endorsement by
the author or the affirmer.
When using or citing the work, you should not imply endorsement by the
author or the affirmer.
</p>
</template>
<template v-else-if="group.id === 'cc-by-4-0'">
@@ -225,8 +227,8 @@ function reflowParagraphs(text: string): string {
medium or format for any purpose, even commercially.
</p>
<p>
<strong>Adapt</strong> — remix, transform, and build upon the
material for any purpose, even commercially.
<strong>Adapt</strong> — remix, transform, and build upon the material
for any purpose, even commercially.
</p>
<p>
The licensor cannot revoke these freedoms as long as you follow the
@@ -235,14 +237,14 @@ function reflowParagraphs(text: string): string {
<p class="page-licenses-quote-heading">Under the following terms:</p>
<p>
<strong>Attribution</strong> — You must give appropriate credit,
provide a link to the license, and indicate if changes were made.
You may do so in any reasonable manner, but not in any way that
suggests the licensor endorses you or your use.
provide a link to the license, and indicate if changes were made. You
may do so in any reasonable manner, but not in any way that suggests
the licensor endorses you or your use.
</p>
<p>
<strong>No additional restrictions</strong> — You may not apply
legal terms or technological measures that legally restrict others
from doing anything the license permits.
<strong>No additional restrictions</strong> — You may not apply legal
terms or technological measures that legally restrict others from
doing anything the license permits.
</p>
<p class="page-licenses-quote-heading">Notices:</p>
<p>
@@ -252,9 +254,9 @@ function reflowParagraphs(text: string): string {
</p>
<p>
No warranties are given. The license may not give you all of the
permissions necessary for your intended use. For example, other
rights such as publicity, privacy, or moral rights may limit how
you use the material.
permissions necessary for your intended use. For example, other rights
such as publicity, privacy, or moral rights may limit how you use the
material.
</p>
</template>
<cite class="page-licenses-quote-cite">
@@ -276,7 +278,11 @@ function reflowParagraphs(text: string): string {
<UiCard flush>
<ul class="page-licenses-rows">
<li v-for="row in group.styles" :key="row.slug" class="page-licenses-row">
<li
v-for="row in group.styles"
:key="row.slug"
class="page-licenses-row"
>
<div class="page-licenses-avatar" aria-hidden="true">
<UiAvatar
:style-name="row.slug"
@@ -301,7 +307,9 @@ function reflowParagraphs(text: string): string {
rel="noopener noreferrer"
>{{ row.title ?? 'the original work' }}</a
>
<template v-else>{{ row.title ?? 'the original work' }}</template>
<template v-else>{{
row.title ?? 'the original work'
}}</template>
by
<a
v-if="row.creatorUrl"
@@ -354,9 +362,9 @@ function reflowParagraphs(text: string): string {
</a>
</header>
<p class="page-licenses-section-intro">
The source code in the dicebear/dicebear repository is available under
the MIT license. That covers the libraries, the HTTP API, and this
website. The copyright notice and the full license text are below.
The source code in the dicebear/dicebear repository is available under the
MIT license. That covers the libraries, the HTTP API, and this website.
The copyright notice and the full license text are below.
</p>
<UiCard flush>
apps/docs/.vitepress/theme/components/styles/StyleInfo.vue
+4 -1
View File
@@ -79,7 +79,10 @@ const sourceRows = computed<SourceRow[]>(() => {
{{ row.url }}
</a>
</span>
<UiCopyButton class="ui-copy-button style-info-copy" :text="row.url" />
<UiCopyButton
class="ui-copy-button style-info-copy"
:text="row.url"
/>
</dd>
</div>
</dl>
apps/docs/pages/licenses/index.md
+6 -6
View File
@@ -3,8 +3,8 @@ editLink: false
aside: false
description:
The licenses of all DiceBear avatar styles and the MIT license of the
DiceBear software.
The licenses of all DiceBear avatar styles and the MIT license of the DiceBear
software.
---
<script setup lang="ts">
@@ -13,9 +13,9 @@ import PageLicenses from '@theme/components/pages/PageLicenses.vue';
# Licenses
While the DiceBear code is MIT licensed (see [Software](#software)), each
artist chooses the license for their own avatar style. The overview below
groups the styles by license, with the artist, the source work, and the
license linked for each one.
While the DiceBear code is MIT licensed (see [Software](#software)), each artist
chooses the license for their own avatar style. The overview below groups the
styles by license, with the artist, the source work, and the license linked for
each one.
<PageLicenses />