Skip to content
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

Jump to bottom

docs: use defineProps deconstruction #3090

Merged
merged 4 commits into from
Sep 16, 2024
Merged

docs: use defineProps deconstruction #3090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
70d433e
docs: use defineProps deconstruction
ST-DDT Sep 5, 2024
8987fbb
Merge branch 'next' into docs/props-deconstruction
ST-DDT Sep 9, 2024
e80d394
Merge branch 'next' into docs/props-deconstruction
ST-DDT Sep 14, 2024
2763ef9
Merge branch 'next' into docs/props-deconstruction
ST-DDT Sep 16, 2024
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
2 changes: 1 addition & 1 deletion docs/.vitepress/components/Banner.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
import { useElementSize } from '@vueuse/core';
import { ref, watchEffect } from 'vue';

defineProps<{
const { version } = defineProps<{
version: string;
}>();

Expand Down
17 changes: 10 additions & 7 deletions docs/.vitepress/components/api-docs/method-parameters.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<script setup lang="ts">
import type { ApiDocsMethodParameter } from './method';

const props = defineProps<{ parameters: ApiDocsMethodParameter[] }>();
const { parameters } = defineProps<{ parameters: ApiDocsMethodParameter[] }>();
</script>

<template>
Expand All @@ -18,19 +18,22 @@ const props = defineProps<{ parameters: ApiDocsMethodParameter[] }>();
</tr>
</thead>
<tbody>
<tr v-for="parameter of props.parameters" :key="parameter.name">
<tr
v-for="{ name, description, type, default: def } of parameters"
:key="name"
>
<td
:class="{
deprecated: parameter.description.includes('DEPRECATED'),
deprecated: description.includes('DEPRECATED'),
}"
>
{{ parameter.name }}
{{ name }}
</td>
<td>{{ parameter.type }}</td>
<td>{{ type }}</td>
<td>
<code v-if="parameter.default">{{ parameter.default }}</code>
<code v-if="def">{{ def }}</code>
</td>
<td v-html="parameter.description"></td>
<td v-html="description"></td>
</tr>
</tbody>
</table>
Expand Down
57 changes: 33 additions & 24 deletions docs/.vitepress/components/api-docs/method.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,60 @@ import { slugify } from '../../shared/utils/slugify';
import type { ApiDocsMethod } from './method';
import MethodParameters from './method-parameters.vue';

const props = defineProps<{ method: ApiDocsMethod }>();
const { method } = defineProps<{ method: ApiDocsMethod }>();
const {
deprecated,
description,
since,
parameters,
returns,
throws,
signature,
examples,
seeAlsos,
sourcePath,
} = method;
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved

function seeAlsoToUrl(see: string): string {
const [, module, method] = see.replace(/\(.*/, '').split('\.');
if (!method) {
return 'faker.html#' + slugify(module);
const [, module, methodName] = see.replace(/\(.*/, '').split('\.');

if (!methodName) {
return `faker.html#${slugify(module)}`;
}
return module + '.html#' + slugify(method);

return `${module}.html#${slugify(methodName)}`;
}
</script>

<template>
<div>
<div v-if="props.method.deprecated" class="warning custom-block">
<div v-if="deprecated" class="warning custom-block">
<p class="custom-block-title">Deprecated</p>
<p>This method is deprecated and will be removed in a future version.</p>
<span v-html="props.method.deprecated" />
<span v-html="deprecated" />
</div>

<div v-html="props.method.description"></div>
<div v-html="description"></div>

<p v-if="props.method.since">
<em>Available since v{{ props.method.since }}</em>
<p v-if="since">
<em>Available since v{{ since }}</em>
</p>

<MethodParameters
v-if="props.method.parameters.length > 0"
:parameters="props.method.parameters"
/>
<MethodParameters v-if="parameters.length > 0" :parameters="parameters" />

<p><strong>Returns:</strong> {{ props.method.returns }}</p>
<p><strong>Returns:</strong> {{ returns }}</p>

<p v-if="props.method.throws">
<strong>Throws:</strong> <span v-html="props.method.throws" />
</p>
<p v-if="throws"><strong>Throws:</strong> <span v-html="throws" /></p>

<div v-html="props.method.signature" />
<div v-html="signature" />

<h3>Examples</h3>
<div v-html="props.method.examples" />
<div v-html="examples" />

<div v-if="props.method.seeAlsos.length > 0">
<div v-if="seeAlsos.length > 0">
<h3>See Also</h3>
<ul>
<li v-for="seeAlso of props.method.seeAlsos" :key="seeAlso">
<li v-for="seeAlso of seeAlsos" :key="seeAlso">
<a
v-if="seeAlso.startsWith('faker.')"
:href="seeAlsoToUrl(seeAlso)"
Expand All @@ -59,12 +68,12 @@ function seeAlsoToUrl(see: string): string {
</ul>
</div>

<div v-if="props.method.sourcePath">
<div v-if="sourcePath">
<h3>Source</h3>
<ul>
<li>
<a
:href="sourceBaseUrl + props.method.sourcePath"
:href="sourceBaseUrl + sourcePath"
target="_blank"
class="source-link"
>
Expand Down