jacob-mathison/tuono
1
0
Fork 0
mirror of https://github.com/tuono-labs/tuono synced 2026-07-25 12:52:47 -07:00
Code Issues Packages Projects Releases Wiki Activity

fix: update lazyLoadComponent fn name to __tuono__internal__lazyLoadComponent (#222)

Browse Source
This commit is contained in:
Valerio Ageno
2024-12-15 09:22:19 +01:00
committed by GitHub
parent 4abc163a59
commit 14bea36356
22 changed files with 83 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.prettierignore
+6 -1
View File
@@ -1 +1,6 @@
pnpm-lock.yaml
pnpm-lock.yaml
dist
.tuono
packages/lazy-fn-vite-plugin/tests/sources/*
apps/documentation/package.json
+1 -1
View File
@@ -6,7 +6,7 @@
"type": "module",
"scripts": {
"lint": "eslint .",
"format": "prettier -u --write --ignore-unknown .",
"format": "prettier --write --ignore-unknown .",
"format:check": "prettier --check --ignore-unknown .",
"types": "tsc --noEmit"
},
eslint.config.js
+1
View File
@@ -14,6 +14,7 @@ export default tseslint.config(
// #region package-specific
'packages/fs-router-vite-plugin/tests/generator/**',
'packages/lazy-fn-vite-plugin/tests/sources/**',
'packages/tuono/bin/**',
// #endregion package-specific
packages/lazy-fn-vite-plugin/.prettierignore
-2
View File
@@ -1,2 +0,0 @@
dist
pnpm-lock.yaml
packages/lazy-fn-vite-plugin/package.json
+2 -2
View File
@@ -7,8 +7,8 @@
"dev": "vite build --watch",
"build": "vite build",
"lint": "eslint .",
"format": "prettier -u --write --ignore-unknown '**/*'",
"format:check": "prettier --check --ignore-unknown '**/*'",
"format": "prettier --write --ignore-unknown --ignore-path ../../.prettierignore .",
"format:check": "prettier --check --ignore-unknown --ignore-path ../../.prettierignore .",
"types": "tsc --noEmit",
"test:watch": "vitest",
"test": "vitest run"
packages/lazy-fn-vite-plugin/src/constants.ts
+1 -1
View File
@@ -1,3 +1,3 @@
export const TUONO_DYNAMIC_FN_ID = 'dynamic'
export const TUONO_LAZY_FN_ID = 'lazyLoadComponent'
export const TUONO_LAZY_FN_ID = '__tuono__internal__lazyLoadComponent'
export const TUONO_MAIN_PACKAGE = 'tuono'
packages/lazy-fn-vite-plugin/src/index.ts
+1 -1
View File
@@ -33,7 +33,7 @@ const RemoveTuonoLazyImport: PluginItem = {
/**
* [CLIENT build]
* This plugin replace the `dynamic` function with the `lazyLoadComponent` one
* This plugin replace the `dynamic` function with the `__tuono__internal__lazyLoadComponent` one
*/
const ReplaceTuonoLazyImport: PluginItem = {
name: 'remove-tuono-lazy-import-plugin',
packages/lazy-fn-vite-plugin/tests/sources/external-dynamic/client.expected.tsx
+4
View File
@@ -0,0 +1,4 @@
import { createRoute } from 'tuono';
import { dynamic } from 'external-lib';
const IndexImport = dynamic(() => import('./../src/routes/index'));
const PokemonspokemonImport = dynamic(() => import('./../src/routes/pokemons/[pokemon]'));
packages/lazy-fn-vite-plugin/tests/sources/external-dynamic/server.expected.tsx
+4
View File
@@ -0,0 +1,4 @@
import { createRoute } from 'tuono';
import { dynamic } from 'external-lib';
const IndexImport = dynamic(() => import('./../src/routes/index'));
const PokemonspokemonImport = dynamic(() => import('./../src/routes/pokemons/[pokemon]'));
packages/lazy-fn-vite-plugin/tests/sources/external-dynamic/source.tsx
+7
View File
@@ -0,0 +1,7 @@
import { createRoute } from 'tuono'
import { dynamic } from 'external-lib'
const IndexImport = dynamic(() => import('./../src/routes/index'))
const PokemonspokemonImport = dynamic(
() => import('./../src/routes/pokemons/[pokemon]'),
)
packages/lazy-fn-vite-plugin/tests/sources/vanilla/client.expected.tsx
+3
View File
@@ -0,0 +1,3 @@
import { createRoute, __tuono__internal__lazyLoadComponent as dynamic } from 'tuono';
const IndexImport = dynamic(() => import('./../src/routes/index'));
const PokemonspokemonImport = dynamic(() => import('./../src/routes/pokemons/[pokemon]'));
packages/lazy-fn-vite-plugin/tests/sources/vanilla/server.expected.tsx
+3
View File
@@ -0,0 +1,3 @@
import { createRoute } from 'tuono';
import IndexImport from "./../src/routes/index";
import PokemonspokemonImport from "./../src/routes/pokemons/[pokemon]";
packages/lazy-fn-vite-plugin/tests/sources/vanilla/source.tsx
+6
View File
@@ -0,0 +1,6 @@
import { createRoute, dynamic } from 'tuono'
const IndexImport = dynamic(() => import('./../src/routes/index'))
const PokemonspokemonImport = dynamic(
() => import('./../src/routes/pokemons/[pokemon]'),
)
packages/lazy-fn-vite-plugin/tests/transpileSource.test.ts
+33 -59
View File
@@ -1,27 +1,11 @@
import fs from 'node:fs/promises'
import path from 'node:path'
import { it, expect, describe } from 'vitest'
import type { Plugin } from 'vite'
import { LazyLoadingPlugin } from '../src'
const SOURCE_CODE = `
import { createRoute, dynamic } from 'tuono'
const IndexImport = dynamic(() => import('./../src/routes/index'))
const PokemonspokemonImport = dynamic(
() => import('./../src/routes/pokemons/[pokemon]'),
)
`
const NON_DYNAMIC_SOURCE = `
import { createRoute } from 'tuono'
import {dynamic} from 'external-lib'
const IndexImport = dynamic(() => import('./../src/routes/index'))
const PokemonspokemonImport = dynamic(
() => import('./../src/routes/pokemons/[pokemon]'),
)
`
type ViteTransformHandler = Exclude<
Plugin['transform'],
// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
@@ -33,45 +17,35 @@ function getTransform(): (...args: Parameters<ViteTransformHandler>) => string {
return LazyLoadingPlugin().transform as never
}
describe('Transpile tuono source', () => {
it('Into the client bundle', () => {
const pluginTransform = getTransform()
const bundle = pluginTransform(SOURCE_CODE, 'id')
expect(bundle)
.toBe(`import { createRoute, lazyLoadComponent as dynamic } from 'tuono';
const IndexImport = dynamic(() => import('./../src/routes/index'));
const PokemonspokemonImport = dynamic(() => import('./../src/routes/pokemons/[pokemon]'));`)
})
describe('"dynamic" fn', async () => {
const folderNames = await fs.readdir(`${process.cwd()}/tests/sources`)
it('Into the server bundle', () => {
const pluginTransform = getTransform()
const bundle = pluginTransform(SOURCE_CODE, 'id', {
ssr: true,
})
expect(bundle).toBe(`import { createRoute } from 'tuono';
import IndexImport from "./../src/routes/index";
import PokemonspokemonImport from "./../src/routes/pokemons/[pokemon]";`)
})
})
describe('Non tuono dynamic function', () => {
it('Into the client bundle', () => {
const pluginTransform = getTransform()
const bundle = pluginTransform(NON_DYNAMIC_SOURCE, 'id')
expect(bundle).toBe(`import { createRoute } from 'tuono';
import { dynamic } from 'external-lib';
const IndexImport = dynamic(() => import('./../src/routes/index'));
const PokemonspokemonImport = dynamic(() => import('./../src/routes/pokemons/[pokemon]'));`)
})
it('Into the server bundle', () => {
const pluginTransform = getTransform()
const bundle = pluginTransform(NON_DYNAMIC_SOURCE, 'id', {
ssr: true,
})
expect(bundle).toBe(`import { createRoute } from 'tuono';
import { dynamic } from 'external-lib';
const IndexImport = dynamic(() => import('./../src/routes/index'));
const PokemonspokemonImport = dynamic(() => import('./../src/routes/pokemons/[pokemon]'));`)
})
it.each(folderNames)(
'should correctly build the "%s" dynamic fn',
async (folderName) => {
const testDirPath = `${process.cwd()}/tests/sources/${folderName}`
const source = await fs.readFile(
path.join(testDirPath, 'source.tsx'),
'utf-8',
)
const pluginTransform = getTransform()
const clientBundle = pluginTransform(source, 'id')
const serverBundle = pluginTransform(source, 'id', { ssr: true })
const expectedClientSrc = `${testDirPath}/client.expected.tsx`
const expectedServerSrc = `${testDirPath}/server.expected.tsx`
await expect(clientBundle).toMatchFileSnapshot(
expectedClientSrc,
`${testDirPath} client build should be equal to ${expectedClientSrc}`,
)
await expect(serverBundle).toMatchFileSnapshot(
expectedServerSrc,
`${testDirPath} server build should be equal to ${expectedServerSrc}`,
)
},
)
})
packages/lazy-fn-vite-plugin/tsconfig.json
+2 -1
View File
@@ -1,4 +1,5 @@
{
"extends": "../../tsconfig.json",
"include": ["src", "tests", "vite.config.ts"]
"include": ["src", "tests", "vite.config.ts"],
"exclude": ["tests/sources"]
}
packages/router/.prettierignore
-2
View File
@@ -1,2 +0,0 @@
dist
pnpm-lock.yaml
packages/router/package.json
+2 -2
View File
@@ -7,8 +7,8 @@
"dev": "vite build --watch",
"build": "vite build",
"lint": "eslint .",
"format": "prettier -u --write --ignore-unknown '**/*'",
"format:check": "prettier --check --ignore-unknown '**/*'",
"format": "prettier --write --ignore-unknown --ignore-path ../../.prettierignore .",
"format:check": "prettier --check --ignore-unknown --ignore-path ../../.prettierignore .",
"types": "tsc --noEmit",
"test:watch": "vitest",
"test": "vitest run"
packages/router/src/dynamic.tsx
+3 -1
View File
@@ -41,7 +41,9 @@ export const dynamic = (importFn: ImportFn): React.JSX.Element => {
return <></>
}
export const lazyLoadComponent = (factory: ImportFn): RouteComponent => {
export const __tuono__internal__lazyLoadComponent = (
factory: ImportFn,
): RouteComponent => {
let LoadedComponent: ComponentType<any> | undefined
const LazyComponent = React.lazy(factory) as unknown as RouteComponent
packages/router/src/index.ts
+1 -1
View File
@@ -2,5 +2,5 @@ export { RouterProvider } from './components/RouterProvider'
export { default as Link } from './components/Link'
export { createRouter } from './router'
export { createRoute, createRootRoute } from './route'
export { dynamic, lazyLoadComponent } from './dynamic'
export { dynamic, __tuono__internal__lazyLoadComponent } from './dynamic'
export { useRouter } from './hooks/useRouter'
packages/tuono/.prettierignore
-2
View File
@@ -1,2 +0,0 @@
dist
pnpm-lock.yaml
packages/tuono/package.json
+2 -2
View File
@@ -7,8 +7,8 @@
"dev": "vite build --watch",
"build": "vite build",
"lint": "eslint .",
"format": "prettier -u --write --ignore-unknown '**/*'",
"format:check": "prettier --check --ignore-unknown '**/*'",
"format": "prettier --write --ignore-unknown --ignore-path ../../.prettierignore .",
"format:check": "prettier --check --ignore-unknown --ignore-path ../../.prettierignore .",
"types": "tsc --noEmit",
"test:watch": "vitest",
"test": "vitest run"
packages/tuono/src/index.ts
+1 -1
View File
@@ -7,8 +7,8 @@ export {
Link,
RouterProvider,
dynamic,
lazyLoadComponent,
useRouter,
__tuono__internal__lazyLoadComponent,
} from 'tuono-router'
export type { TuonoProps } from './types'