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

feat(astro) pass config to vite alias #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(astro) pass config to vite alias #2

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
5 changes: 5 additions & 0 deletions .changeset/strong-colts-study.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'astro': patch
---

Pass config aliases directly to Vite alias
34 changes: 4 additions & 30 deletions packages/astro/src/vite-plugin-config-alias/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,14 +64,6 @@ const getConfigAlias = (settings: AstroSettings): Alias[] | null => {
}
}

// compile the baseUrl expression and push it to the list
// - `baseUrl` changes the way non-relative specifiers are resolved
// - if `baseUrl` exists then all non-relative specifiers are resolved relative to it
aliases.push({
find: /^(?!\.*\/)(.+)$/,
replacement: `${[...baseUrl].map((segment) => (segment === '$' ? '$$' : segment)).join('')}/$1`,
});

return aliases;
};

Expand All @@ -81,7 +73,6 @@ export default function configAliasVitePlugin({
}: {
settings: AstroSettings;
}): vite.PluginOption {
const { config } = settings;
/** Aliases from the tsconfig.json or jsconfig.json configuration. */
const configAlias = getConfigAlias(settings);

Expand All @@ -91,27 +82,10 @@ export default function configAliasVitePlugin({
return {
name: 'astro:tsconfig-alias',
enforce: 'pre',
async resolveId(sourceId: string, importer, options) {
/** Resolved ID conditionally handled by any other resolver. (this gives priority to all other resolvers) */
const resolvedId = await this.resolve(sourceId, importer, { skipSelf: true, ...options });

// if any other resolver handles the file, return that resolution
if (resolvedId) return resolvedId;

// conditionally resolve the source ID from any matching alias or baseUrl
for (const alias of configAlias) {
if (alias.find.test(sourceId)) {
/** Processed Source ID with our alias applied. */
const aliasedSourceId = sourceId.replace(alias.find, alias.replacement);

/** Resolved ID conditionally handled by any other resolver. (this also gives priority to all other resolvers) */
const resolvedAliasedId = await this.resolve(aliasedSourceId, importer, {
skipSelf: true,
...options,
});

// if the existing resolvers find the file, return that resolution
if (resolvedAliasedId) return resolvedAliasedId;
config() {
return {
resolve: {
alias: configAlias
}
}
},
Expand Down
46 changes: 46 additions & 0 deletions packages/astro/test/alias-jsconfig.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import { expect } from 'chai';
import * as cheerio from 'cheerio';
import { isWindows, loadFixture } from './test-utils.js';

describe('Aliases with jsconfig.json', () => {
let fixture;

before(async () => {
fixture = await loadFixture({
root: './fixtures/alias-jsconfig/',
});
});

if (isWindows) return;

describe('dev', () => {
let devServer;

before(async () => {
devServer = await fixture.startDevServer();
});

after(async () => {
await devServer.stop();
});

it('can load client components', async () => {
const html = await fixture.fetch('/').then((res) => res.text());
const $ = cheerio.load(html);

const style = $('style');

// bundledCSS = (await fixture.readFile(bundledCSSHREF.replace(/^\/?/, '/')))
// .replace(/\s/g, '')
// .replace('/n', '');

expect(true).to.equal(true)

// Should render aliased element
// expect($('#client').text()).to.equal('test');

// const scripts = $('script').toArray();
// expect(scripts.length).to.be.greaterThan(0);
});
});
});
4 changes: 4 additions & 0 deletions packages/astro/test/fixtures/alias-jsconfig/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import { defineConfig } from 'astro/config';

// https://astro.build/config
export default defineConfig({});
8 changes: 8 additions & 0 deletions packages/astro/test/fixtures/alias-jsconfig/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"name": "@test/aliases-jsconfig",
"version": "0.0.0",
"private": true,
"dependencies": {
"astro": "workspace:*"
}
}
15 changes: 15 additions & 0 deletions packages/astro/test/fixtures/alias-jsconfig/src/pages/index.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
import 'src:styles/index.css'
---
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<title>Aliases using JSConfig</title>
</head>
<body>
<main>
<h1>Aliases using JSConfig</h1>
</main>
</body>
</html>
1 change: 1 addition & 0 deletions packages/astro/test/fixtures/alias-jsconfig/src/styles/index.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@import "src:styles/shared.css";
3 changes: 3 additions & 0 deletions packages/astro/test/fixtures/alias-jsconfig/src/styles/shared.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*, ::before, ::after {
box-sizing: border-box;
}
8 changes: 8 additions & 0 deletions packages/astro/test/fixtures/alias-jsconfig/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"src:*": ["src/*"]
}
}
}
6 changes: 6 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.