oblique lake
I'm trying to invoke a function that basically runs some validation during project build or dev server run.
Its parsing some config files with zod. But when I import this inside the astro config file I errors that it cannot resolve anything
eg:
import { validateConfig } from "@utils/validation";
validateConfig();
queen gardenBOT
Hi @oblique lake. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:
Based on the information provided in the extracts, it seems that there are known issues with using TypeScript aliases in the astro.config.ts file. This is likely the cause of the error you're encountering when trying to import your validation function.
For example, in this issue (https://github.com/withastro/astro/issues/9782), a user reported a similar problem where using TypeScript aliases inside the astro.config.ts file resulted in an error. The same issue was reported in this other issue (https://github.com/withastro/astro/issues/9777) as well.
Unfortunately, the extracts do not provide a direct solution to this problem. However, it's worth noting that some users have reported success with using relative or absolute paths instead of aliases. You might want to try this as a workaround until the issue with aliases is resolved.
Here's an example of how you might adjust your import statement:
import { validateConfig } from "../utils/validation"; // Adjust the path as necessary
validateConfig();
@queen garden Even after using relative import, the errors are less but still there.
The errors now come from inside the validateConfig() function which also uses aliases.
Is there another place I can put my validation in order to run on dev/build start?
queen gardenBOT
Let me check the knowledge base for you. One moment! :books:
Based on the information provided in the extracts, it seems that the Astro configuration file (astro.config.ts) has some limitations when it comes to handling TypeScript aliases and certain Vite-specific properties.
As a workaround, you could consider moving your validation logic to a separate script that you run before starting your development server or building your project. This script could be set up as a pre-build or pre-start task in your package.json file.
Here's an example of how you might set this up:
"scripts": {
"validate": "node ./path-to-your-validation-script.js",
"dev": "npm run validate && astro dev",
"build": "npm run validate && astro build"
}
In this setup, running npm run dev or npm run build would first run your validation script and then start the development server or build your project, respectively.
Please adjust the paths and script names according to your project's setup.
oblique lake
@queen garden Its a .ts file so if I put it there, I would also need to compile it first and its not pretty
Can I use it like some kind of inline-integration?
queen gardenBOT
Let me check the knowledge base for you. One moment! :books:
Based on the information provided in the extracts, Astro does support inline integrations in the astro.config.mjs file. However, these integrations are typically used to add functionality to Astro, such as adding support for a new file type or integrating with a third-party service. It's not clear from the extracts whether you can use an inline integration to run a validation function.
Here's an example of how you might define an inline integration:
import { defineConfig } from 'astro/config';
export default defineConfig({
integrations: [
{
name: 'namespace:id',
hooks: {
/* ... */
},
},
],
});
In this example, the hooks object would contain functions that define the behavior of the integration. However, the extracts do not provide any information on whether you can use these hooks to run a validation function.
If you're looking for a way to run your validation function without having to compile it first, you might consider writing it in JavaScript instead of TypeScript. This would allow you to run the function directly with Node.js, without the need for a separate compilation step.