diff --git a/.gitignore b/.gitignore index 5505a6a..5101a00 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,9 @@ public/static/monaco/*.worker.js.map heroku .vercel + +.output +.tanstack +.playwright-cli +test-results +playwright-report diff --git a/.prettierignore b/.prettierignore index ed8fa3e..72bc038 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1 +1,2 @@ public/static/monaco +routeTree.gen.ts diff --git a/README.md b/README.md index c3355c1..26fa6e2 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,35 @@ +## Development + +Requires Node.js 22.12 or newer and Yarn 1.22. + +```sh +yarn install --frozen-lockfile +yarn dev +``` + +Open http://127.0.0.1:3000. The app uses TanStack Start, React 18, and Vite. Converter components live in `pages/`; file routes live in `routes/`. The document and page metadata render on the server, while the interactive Evergreen UI and Monaco editors render on the client. Heavy conversions run in browser workers or WebAssembly; the existing server-backed converters use `server/converters/`. + +```sh +yarn typecheck +yarn test +yarn build +yarn start +``` + +The production server uses Nitro and requires Node.js. `.output/` is a self-contained deployment artifact, including the older TypeScript compiler and declaration files needed by the converters. Vercel configuration retains the existing redirects; no deployment is needed for local development. + +With a development or production server running: + +```sh +TEST_BASE_URL=http://127.0.0.1:3000 yarn test:api +TEST_BASE_URL=http://127.0.0.1:3000 yarn test:browser +``` + +Browser tests use an installed Google Chrome. They cover every converter's default example, representative edited inputs, navigation/persistence, metadata, redirects, and 404 responses. Evergreen 4 and the existing Monaco wrapper still emit React deprecation warnings in development; upgrading that UI is separate from this framework migration. + ## Credits The logo has been designed by [mikicon](https://thenounproject.com/mikicon/). @@ -24,11 +53,9 @@ The logo has been designed by [mikicon](https://thenounproject.com/mikicon/). MIT @ Ritesh Kumar -## Development +## Adding a converter -- Run `yarn && yarn dev` for development. -- Every route is a diggerent file in the `pages/*` directory -- You can add a new transformer by adding a file there and adding the route in `utils/routes.tsx` +Add the converter component in `pages/`, a matching file route in `routes/`, and its navigation entry in `utils/routes.tsx`. TanStack Router regenerates `routeTree.gen.ts` during development and builds. ## Self Hosting diff --git a/pages/_app.tsx b/components/AppShell.tsx similarity index 79% rename from pages/_app.tsx rename to components/AppShell.tsx index 5f31f10..4f21420 100644 --- a/pages/_app.tsx +++ b/components/AppShell.tsx @@ -4,10 +4,7 @@ import Navigator from "@components/Navigator"; import "@styles/main.css"; import NProgress from "nprogress"; -import Router, { useRouter } from "next/router"; -import { activeRouteData } from "@utils/routes"; -import Head from "next/head"; -import { Meta } from "@components/Meta"; +import { Outlet, useRouterState } from "@tanstack/react-router"; import { useDarkMode } from "@hooks/useDarkMode"; const logo = ( @@ -31,57 +28,25 @@ const logo = ( ); -export default function App(props) { +export default function AppShell() { const { isDarkMode, toggleDarkMode } = useDarkMode(); - const router = useRouter(); + const isLoading = useRouterState({ select: state => state.isLoading }); + const pathname = useRouterState({ select: state => state.location.pathname }); useEffect(() => { - let timer; - - const stopProgress = () => { + if (!isLoading) { + NProgress.done(); + return; + } + const timer = setTimeout(() => NProgress.start(), 300); + return () => { clearTimeout(timer); NProgress.done(); }; - - const startProgress = () => NProgress.start(); - - const showProgressBar = () => { - timer = setTimeout(startProgress, 300); - router.events.on("routeChangeComplete", stopProgress); - router.events.on("routeChangeError", stopProgress); - }; - - router.events.on("routeChangeStart", showProgressBar); - - return () => { - router.events.off("routeChangeComplete", stopProgress); - router.events.off("routeChangeError", stopProgress); - router.events.off("routeChangeStart", showProgressBar); - timer && clearTimeout(timer); - }; - }, []); - - const { Component, pageProps } = props; - - const activeRoute = activeRouteData(router.pathname); + }, [isLoading]); return ( <> - {router.pathname === "/" || !router.pathname ? ( - - ) : ( - - )} - + + + ); diff --git a/components/ConversionPanel.tsx b/components/ConversionPanel.tsx index fa38a73..10c30ea 100644 --- a/components/ConversionPanel.tsx +++ b/components/ConversionPanel.tsx @@ -3,19 +3,19 @@ import EditorPanel, { EditorPanelProps } from "@components/EditorPanel"; import * as React from "react"; import { useEffect, useState } from "react"; import { Language, useData } from "@hooks/useData"; -import { useRouter } from "next/router"; +import { useRouterState } from "@tanstack/react-router"; import { activeRouteData } from "@utils/routes"; -import PrettierWorker from "@workers/prettier.worker"; +import PrettierWorker from "@workers/prettier.worker.ts?worker"; import { getWorker } from "@utils/workerWrapper"; let prettierWorker; -function getEditorLanguage(lang: Language) { +function getEditorLanguage(lang?: Language) { const mapping = { flow: "typescript" }; - return mapping[lang] || lang; + return lang ? mapping[lang] || lang : lang; } export type Transformer = (args: { @@ -67,8 +67,8 @@ const ConversionPanel: React.FunctionComponent = function( const [message, setMessage] = useState(""); const [showUpdateSpinner, toggleUpdateSpinner] = useState(false); - const router = useRouter(); - const route = activeRouteData(router.pathname); + const pathname = useRouterState({ select: state => state.location.pathname }); + const route = activeRouteData(pathname); let packageDetails; diff --git a/components/EditorPanel.tsx b/components/EditorPanel.tsx index 8c0ea14..1fb1ef3 100644 --- a/components/EditorPanel.tsx +++ b/components/EditorPanel.tsx @@ -11,7 +11,7 @@ import { Tooltip } from "evergreen-ui"; import React, { useCallback, useEffect, useRef, useState } from "react"; -import dynamic from "next/dynamic"; +import { lazy, Suspense } from "react"; import copy from "clipboard-copy"; import Npm from "@assets/svgs/Npm"; import { useDropzone } from "react-dropzone"; @@ -41,9 +41,7 @@ export interface EditorPanelProps { }; } -const Monaco = dynamic(() => import("../components/Monaco"), { - ssr: false -}); +const Monaco = lazy(() => import("./Monaco")); export default function EditorPanel({ editable = true, @@ -82,11 +80,6 @@ export default function EditorPanel({ [showSettingsDialogue] ); - useEffect(() => { - // @ts-ignore - window.__webpack_public_path__ = "/_next/static/"; - }, []); - const getSettings = useCallback( () => ( <> @@ -99,7 +92,7 @@ export default function EditorPanel({ Settings - {settingElement({ + {settingElement?.({ toggle: _toggleSettingsDialog, open: showSettingsDialogue })} @@ -115,7 +108,7 @@ export default function EditorPanel({ reader.readAsText(file, "utf-8"); reader.onload = () => { setValue(reader.result as string); - onChange(reader.result as string); + onChange?.(reader.result as string); close(); }; }, []); @@ -146,7 +139,7 @@ export default function EditorPanel({ setValue(value); setFetchingUrl(""); close(); - onChange(value); + onChange?.(value); })(); }, [fetchingUrl, onChange] @@ -283,15 +276,17 @@ export default function EditorPanel({ toggleSettings: _toggleSettingsDialog })} - { - setValue(value); - onChange(value); - }} - /> + Loading editor…}> + { + setValue(value); + onChange?.(value); + }} + /> + ); diff --git a/components/Form.tsx b/components/Form.tsx index 1c732d0..493dffb 100644 --- a/components/Form.tsx +++ b/components/Form.tsx @@ -59,7 +59,7 @@ const Form = ({ let FormField, select; if (type === InputType.TEXT_INPUT) FormField = TextInput; else if (type === InputType.SWITCH) FormField = Switch; - else if (type === InputType.SELECT) + else if (type === InputType.SELECT && options) select = (