Skip to content

feat(playground): improve layout and show diagnostics #122

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

Merged
tmlmt merged 1 commit into from
Oct 25, 2026
Merged

feat(playground): improve layout and show diagnostics #122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 54 additions & 0 deletions playground/app/components/DiagnosticCard.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
<script setup lang="ts">
import { formatCodeFrame } from "cooklang-parser";
import type { Diagnostic } from "cooklang-parser";

defineProps<{
diagnostic: Diagnostic;
rawRecipe: string;
}>();
</script>

<template>
<UCard
variant="subtle"
:class="[
'mb-4 border-[0.5px] text-sm',
{
'border-error-400/20 bg-error-400/10 text-error-700 dark:text-error-400':
diagnostic.severity === 'error',
'bg-warning-400/10 border-warning-400/50 text-warning-600 dark:border-warning-400/20 dark:text-warning-300':
diagnostic.severity === 'warning',
},
]"
:ui="{
header: 'sm:px-4 py-3',
footer: 'sm:px-4 py-2',
body: 'p-0 sm:p-0',
}"
>
<template #header>
<div>
<b>{{ diagnostic.severity.toUpperCase() }}[{{ diagnostic.code }}]:</b>
{{ diagnostic.message }}
</div>
</template>
<pre
v-if="diagnostic.span"
class="scrollbar-thumb-error-300/50 scrollbar-thin overflow-auto px-4 pt-3 pb-0 text-xs text-gray-800 dark:text-gray-200"
>{{ formatCodeFrame(diagnostic.span, rawRecipe) }}</pre>
<template #footer>
<div v-if="diagnostic.fix" class="mt-2">
<strong>Fix:</strong> {{ diagnostic.fix }}
</div>
<div v-if="diagnostic.docs" class="mt-2">
<strong>See: </strong>
<NuxtLink
:to="diagnostic.docs"
target="_blank"
class="hover:underline"
>{{ diagnostic.docs }}</NuxtLink
>
</div>
</template>
</UCard>
</template>
193 changes: 181 additions & 12 deletions playground/app/pages/index.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
<script setup lang="ts">
import type { TabsItem } from "@nuxt/ui";
import type { RecipeChoices, SpecificUnitSystem } from "cooklang-parser";
import { Recipe } from "cooklang-parser";
import { DiagnosticError, ParseStoppedError, Recipe } from "cooklang-parser";
import type {
RecipeChoices,
SpecificUnitSystem,
Diagnostic,
} from "cooklang-parser";
import pkg from "~~/../package.json";

const version = pkg.version;
Expand All @@ -12,6 +16,7 @@ const mobileItems = ref<TabsItem[]>([
{ label: "Editor", slot: "editor" },
{ label: "Render", slot: "render" },
{ label: "Choices", slot: "choices" },
{ label: "Diagnostics", slot: "diagnostics" },
{ label: "Raw", slot: "raw" },
]);

Expand All @@ -22,6 +27,7 @@ const desktopItemsLeft = ref<TabsItem[]>([
]);
const desktopItemsRight = ref<TabsItem[]>([
{ label: "Render", slot: "render" },
{ label: "Diagnostics", slot: "diagnostics" },
{ label: "Raw", slot: "raw" },
]);

Expand Down Expand Up @@ -70,8 +76,44 @@ Bake for ~{55-60%min} until golden.
> This recipe was written using [cooklang](https://cooklang.org) syntax and additional extensions.
`);

const diagnostics = ref<Diagnostic[]>([]);
const parseStopped = ref(false);
const hasErrors = ref(false);
const hasWarnings = ref(false);
const activeDesktopRightTab = ref("render");
const parsedRecipe = ref<Recipe | undefined>();

// Step 1: Parse the raw recipe text
const parsedRecipe = computed(() => new Recipe(rawRecipe.value));
watch(
rawRecipe,
() => {
try {
diagnostics.value = [];
parseStopped.value = false;
hasErrors.value = false;
hasWarnings.value = false;
const recipe = new Recipe(rawRecipe.value);
if (recipe.diagnostics.some((d) => d.severity === "error")) {
hasErrors.value = true;
}
if (recipe.diagnostics.length) {
hasWarnings.value = true;
}
diagnostics.value = recipe.diagnostics;
parsedRecipe.value = recipe;
} catch (error) {
if (error instanceof DiagnosticError) {
hasErrors.value = true;
diagnostics.value = error.diagnostics;
}
if (error instanceof ParseStoppedError) {
parseStopped.value = true;
parsedRecipe.value = undefined;
}
}
},
{ immediate: true },
);

// Servings state for scaling
const servings = ref<number>(1);
Expand All @@ -91,11 +133,19 @@ const convertedRecipe = computed(() => {
if (unitSystem.value === null) {
return parsedRecipe.value;
}
return parsedRecipe.value.convertTo(unitSystem.value, conversionMethod.value);
if (parsedRecipe.value)
return parsedRecipe.value.convertTo(
unitSystem.value,
conversionMethod.value,
);
return null;
});

// Step 3: Apply scaling (if different from base servings)
const scaledRecipe = computed(() => {
if (!convertedRecipe.value) {
return null;
}
const baseServings = convertedRecipe.value.servings;
if (baseServings && servings.value !== baseServings) {
return convertedRecipe.value.scaleTo(servings.value);
Expand All @@ -105,7 +155,7 @@ const scaledRecipe = computed(() => {

// Initialize and reset servings when recipe servings change
watch(
() => parsedRecipe.value.servings,
() => (parsedRecipe.value ? parsedRecipe.value.servings : undefined),
(newServings) => {
if (newServings !== undefined) {
servings.value = newServings;
Expand Down Expand Up @@ -179,7 +229,14 @@ watch(
</template>

<template #choices>
<UAlert
v-if="rawRecipe.trim().length === 0"
color="neutral"
variant="subtle"
description="No recipe parsed yet."
/>
<RecipeChoices
v-else-if="parsedRecipe"
v-model:servings="servings"
v-model:choices="choices"
v-model:unit-system="unitSystem"
Expand All @@ -192,22 +249,114 @@ watch(
<!-- Desktop: 2 tabs on the right half -->
<div class="hidden md:block">
<UTabs
v-model="activeDesktopRightTab"
value-key="slot"
:items="desktopItemsRight"
:ui="{
label: 'dark:text-gray-300 dark:hover:text-white',
content: 'h-[calc(100vh-9.5rem)] overflow-auto',
content: 'h-[calc(100vh-9.5rem)]',
}"
>
<template #render>
<div class="w-full text-sm">
<RecipeRender :recipe="scaledRecipe" :choices="choices" />
</div>
<UAlert
v-if="rawRecipe.trim().length === 0"
color="neutral"
variant="subtle"
description="No recipe parsed yet."
/>
<UCard
v-else
class="h-full w-full text-sm"
:ui="{
root: 'flex h-full flex-col',
body: 'flex-1 overflow-auto',
footer: 'shrink-0',
}"
>
<UAlert
v-if="parseStopped"
color="error"
variant="subtle"
title="Invalid recipe"
description="A fatal error was encountered while parsing the recipe."
/>
<RecipeRender
v-else-if="scaledRecipe"
:recipe="scaledRecipe"
:choices="choices"
/>
<template #footer>
<div v-if="parseStopped" class="text-red-700 dark:text-red-400">
✕ Fatal error
</div>
<div
v-else-if="hasErrors"
class="text-red-700 dark:text-red-400"
>
✕ Errors:
<UButton
variant="link"
color="error"
class="pl-0 text-red-700 dark:text-red-400"
@click="activeDesktopRightTab = 'diagnostics'"
>click to see them</UButton
>
</div>
<div
v-else-if="hasWarnings"
class="text-orange-400 dark:text-orange-300"
>
⚠ Warnings:
<UButton
variant="link"
color="warning"
class="pl-0 text-orange-400 dark:text-orange-300"
@click="activeDesktopRightTab = 'diagnostics'"
>click to see them</UButton
>
</div>
<div v-else class="text-green-600">✓ No issues</div>
</template>
</UCard>
</template>

<template #diagnostics>
<UCard
class="h-full w-full"
:ui="{
root: 'flex h-full flex-col',
body: 'flex-1 overflow-auto',
}"
>
<div v-if="diagnostics.length">
<DiagnosticCard
v-for="(diagnostic, index) in diagnostics.sort((a, b) =>
a.severity.localeCompare(b.severity),
)"
:key="index"
:diagnostic="diagnostic"
:raw-recipe="rawRecipe"
/>
</div>
<UAlert
v-else
color="success"
variant="subtle"
description="Recipe parsed without any issue"
/>
</UCard>
</template>

<template #raw>
<div class="w-full">
<UCard
class="h-full w-full"
:ui="{
root: 'flex h-full flex-col',
body: 'flex-1 overflow-auto',
}"
>
<pre class="text-xs">{{ scaledRecipe }}</pre>
</div>
</UCard>
</template>
</UTabs>
</div>
Expand All @@ -229,6 +378,10 @@ watch(
/>
</template>

<template #diagnostics>
<div class="w-full" />
</template>

<template #raw>
<div class="w-full">
<pre class="text-xs">{{ scaledRecipe }}</pre>
Expand All @@ -237,17 +390,33 @@ watch(

<template #choices>
<RecipeChoices
v-if="parsedRecipe"
v-model:servings="servings"
v-model:choices="choices"
v-model:unit-system="unitSystem"
v-model:conversion-method="conversionMethod"
:recipe="parsedRecipe"
/>
<UAlert v-else color="neutral" variant="subtle">
No recipe parsed yet.
</UAlert>
</template>

<template #render>
<div class="w-full text-sm">
<RecipeRender :recipe="scaledRecipe" :choices="choices" />
<RecipeRender
v-if="scaledRecipe"
:recipe="scaledRecipe"
:choices="choices"
/>
<UAlert
v-else
color="neutral"
variant="subtle"
title="Invalid recipe"
>
No recipe parsed yet.
</UAlert>
</div>
</template>
</UTabs>
Expand Down
Loading