Skip to content

Fix @ aliases on Windows #14

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
merged 2 commits into from
Aug 3, 2025
Merged

Fix @ aliases on Windows #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af0c14f
Fix `@` aliases on Windows
skirtles-code Aug 1, 2025
caed897
Add docs for `customResolver` usage
skirtles-code Aug 1, 2025
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
15 changes: 11 additions & 4 deletions ...ges/create-vue-lib/src/template/playground/config/packages/playground/vite.config.mts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<%_ if (config.includeAtAliases) { _%>
import { relative, sep as pathSeparator } from 'node:path'
<%_ } _%>
import { fileURLToPath, URL } from 'node:url'

import { defineConfig, type UserConfig } from 'vite'
Expand Down Expand Up @@ -28,10 +31,14 @@ export default defineConfig(({ mode }): UserConfig => ({
find: '@',
replacement: '@',
customResolver(source, importer, options) {
const filePath = source.replace(
/^@\//,
importer?.startsWith(librarySrc) ? librarySrc : playgroundSrc
)
let target = playgroundSrc

// If the importer is inside librarySrc we resolve @ to that path
if (importer && relative(importer, librarySrc).split(pathSeparator).every(p => p === '..')) {
target = librarySrc
}

const filePath = source.replace(/^@\//, target)

return this.resolve(filePath, importer, options)
}
Expand Down
15 changes: 11 additions & 4 deletions ...ages/create-vue-lib/src/template/vitepress/config/packages/docs/.vitepress/config.mts.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<%_ if (config.includeAtAliases) { _%>
import { relative, sep as pathSeparator } from 'node:path'
<%_ } _%>
import { fileURLToPath, URL } from 'node:url'

import { defineConfigWithTheme } from 'vitepress'
Expand Down Expand Up @@ -50,10 +53,14 @@ export default ({ mode }: { mode: string }) => defineConfigWithTheme({
find: '@',
replacement: '@',
customResolver(source, importer, options) {
const filePath = source.replace(
/^@\//,
importer?.startsWith(librarySrc) ? librarySrc : docsSrc
)
let target = docsSrc

// If the importer is inside librarySrc we resolve @ to that path
if (importer && relative(importer, librarySrc).split(pathSeparator).every(p => p === '..')) {
target = librarySrc
}

const filePath = source.replace(/^@\//, target)

return this.resolve(filePath, importer, options)
}
Expand Down
2 changes: 2 additions & 0 deletions packages/docs/src/why.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ As we can't build all the output files we need in one go, we instead run Vite th

In `rollupOptions` we configure `external: ['vue']`. This tells rollup to keep any imports from the `vue` package as imports, rather than pulling all the code into the built library. For output formats that don't support `import` it will be rewritten accordingly, e.g. using `require()` for CommonJS. For global (IIFE) builds, there is the extra setting `globals: { vue: 'Vue' }`, which tells rollup to rewrite imports like `import { ref } from 'vue'` as `const { ref } = Vue`, or code that's equivalent.

For pages that use [`@` aliases for `src` paths](questions#configure-src-alias), a `customResolver` is needed in the playground and docs packages. These packages pull in the library source code directly, so they need to resolve an `@` within the library code differently from an `@` within their own code.

## `__DEV__` and `__TEST__`

The project supports 'global variables' for `__DEV__` and `__TEST__`. The `__TEST__` variable isn't included by default and requires the `--extended` flag to opt in.
Expand Down