Cannot find module 'astro:content' #5711

azan-n · 2023-01-01T06:52:28Z

What version of `astro` are you using?

1.8.0

Are you using an SSR adapter? If so, which one?

No

What package manager are you using?

npm, pnpm

What operating system are you using?

macOS 13

Describe the Bug

I have been eagerly waiting for even a beta of the Content Collections RFC to start shipping my blog. Thanks to @bholmesdev I got a chance much earlier than I could expect. I upgraded from 1.6.4(?) to 1.8.0 but I got the TS error Cannot find module 'astro:content' or its corresponding type declarations.ts(2307) when trying to import the defineCollection function.

Steps to reproduce

pnpm create astro@latest or npm create astro@latest
Create a 'content' directory and create a 'config.ts' within the folder
Write import { defineCollection, z } from "astro:content" within the 'config.ts'

Continuing with this state of the application leads to no errors during the build or in the dev server.

Link to Minimal Reproducible Example

https://stackblitz.com/edit/github-j2falm?file=content/config.ts

Participation

I am willing to submit a pull request for this issue.

The text was updated successfully, but these errors were encountered:

bholmesdev · 2023-01-01T17:37:24Z

Hey @azan-n! Yes, you’ll need to run a build or use our new sync command to generate this module. Try running pnpm astro sync in your terminal.

azan-n · 2023-01-02T13:13:41Z

Try running pnpm astro sync in your terminal.

I have tried this with npx, pnpm, and pnpx in separate repos. Regardless, the error does not go away.

EDIT: In all cases, I do get a message that reads [content] Types generated 34ms

bholmesdev · 2023-01-02T14:09:59Z

@azan-n hm, and do you see a src/content/types.generated.d.ts file? If not, there might be something else going wrong. You can also quit and restart your editor, or reset the TS language server using the VS Code command palette (cmd + shift + P):

bholmesdev · 2023-01-02T18:01:54Z

Update: just realized types only generate if there is at least one .md or .mdx file inside a collection directory. It won't run on an empty content/ folder! Let me know if adding a file resolves your issue.

I also agree this is pretty confusing. Will address with a bug fix 👍

azan-n · 2023-01-03T04:10:03Z

do you see a src/content/types.generated.d.ts file?

No.

reset the TS language server

I make it a point after every generation command. I realize TS can be a bit slow to catchup.

at least one .md or .mdx file inside a collection directory

In all cases, I have had .md files in nested or the same directory as content/. I have no generated file in it, and the error persists.

I also agree this is pretty confusing. Will address with a bug fix 👍

Thanks so much for the support. I've had quite some time on my badge writing documentation. I'd love to help with it if required.

r-sp · 2023-01-06T19:10:07Z

I got the same msg Cannot find module 'astro:content' or its corresponding type declarations.ts(2307).

After creating hello-world.md inside content/blog/, and trying reset TS language server after that I try running npx astro sync, all problem gone.

Don't forget configuring schema and collection entry. Thanks 👍

bholmesdev · 2023-01-06T21:22:03Z

@rizkysaskiaputra Ah yes, I think an empty config file will block type gen as well. I think relaxing the error detection on collection files before generating types would be helpful. Good to know that works for you though!

azan-n · 2023-01-14T07:41:28Z

@rizkysaskiaputra Ah yes, I think an empty config file will block type gen as well. I think relaxing the error detection on collection files before generating types would be helpful. Good to know that works for you though!

My config file has been complete with schema declarations and the import statement. I just updated to 1.9.2 and still face the same issue.

EDIT: Updated to 2.0.0-beta.2. It works now. Thanks so much.

bholmesdev · 2023-01-14T23:52:32Z

So glad to hear that @azan-n! To anyone following the thread, you'll find future content collections improvements on the 2.0 beta branch. Install in your projects with npm i astro@beta. If you have the MDX integration, bump with npm i @astrojs/mdx@beta as well.

natguy · 2023-01-24T04:52:45Z

Hello, I'm getting a postCSS / @astrojs/tailwind error when I update this existing project to astro@beta & @astrojs/mdx@beta

Does @astrojs/tailwind 2.1.3 need to be updated too?

error Cannot read properties of undefined (reading 'postcss')
File:
/Users/.../node_modules/@astrojs/tailwind/dist/index.js:78:22
Code:
77 | const tailwindConfig = (userConfig == null ? void 0 : userConfig.value) ?? getDefaultTailwindConfig(config.srcDir);
> 78 | config.style.postcss.plugins.push(tailwindPlugin(tailwindConfig));
| ^
79 | config.style.postcss.plugins.push(autoprefixerPlugin);
80 | if (applyBaseStyles) {
81 | injectScript("page-ssr", import '@astrojs/tailwind/base.css';);
Stacktrace:
TypeError: Cannot read properties of undefined (reading 'postcss')

Dependencies:

"dependencies": {
"@astrojs/markdown-remark": "^1.2.0",
"@astrojs/mdx": "^1.0.0-beta.2",
"@astrojs/rss": "^2.0.0",
"@astrojs/sitemap": "^1.0.0",
"@astrojs/tailwind": "^2.1.3",
"@astropub/md": "^0.1.4",
"astro": "^2.0.0-beta.4",
"tailwindcss": "^3.2.4"
},
"devDependencies": {
"@tailwindcss/typography": "^0.5.9"
}

tailwind.config.cjs:

module.exports = {
content: ['./src/**/*.{astro,html,js,jsx,md,mdx,svelte,ts,tsx,vue}'],
theme: {
extend: {},
},
plugins: [
require('@tailwindcss/typography'),
],
}

Note: build and sync + having a mdx file in /content/mycollection didn't fix the missing 'astro:content' module.

Thanks.

bholmesdev · 2023-01-24T12:10:29Z

@natguy Ah yes, you'll need to install @astrojs/tailwind@beta as well. We've introduced a small breaking changes to the integration internals. Happy to share we are baselining our betas today though, so you'll be free to install @latest soon enough 😄

ilievskif · 2023-01-30T19:26:02Z

@natguy Ah yes, you'll need to install @astrojs/tailwind@beta as well. We've introduced a small breaking changes to the integration internals. Happy to share we are baselining our betas today though, so you'll be free to install @latest soon enough 😄

This was the solution. Thank you!

bholmesdev · 2023-01-30T19:58:12Z

@ilievskif Nice! We just baselined all of our betas, so installing @latest for Astro core and the Tailwind integration should do the trick too 🙌

MerlinMason · 2023-04-03T17:09:14Z

I'm getting this same issue with Astro 2.1.9 in my src/content/config.ts file.

The code runs fine but I get an error from eslint/no-unresolved, is there specific way Eslint should be configured? I couldn't spot anything in the docs or examples.

bholmesdev · 2023-04-05T18:24:52Z

@MerlinMason Interesting, there shouldn't be anything else to configure here. I assume you tried running astro sync or astro dev to generate the astro:content module?

MerlinMason · 2023-04-06T08:45:53Z

Hi Ben, thanks for getting back to me!

Yeah the .astro/types.d.ts file exists, I'm running my dev server with astro check --watch & astro dev. There's also a src/env.d.ts which references the generated types. Regenerating the types with astro sync doesn't seem to make a difference.

I'm able to import astro:content into my .astro pages and the linter is happy, but importing into rss.xml.js or config.ts and it complains.

Looking inside .astro/types.d.ts I can see the following module has been declared 10 times (is that expected?)

declare module 'astro:content' {
	interface Render {
		'.mdx': Promise<{
			Content: import('astro').MarkdownInstance<{}>['Content'];
			headings: import('astro').MarkdownHeading[];
			remarkPluginFrontmatter: Record<string, any>;
		}>;
	}
}

And then there's a few other type definitions, but nothing else that mentions astro:content.

bholmesdev · 2023-04-07T13:55:04Z

Got it, thanks for confirming @MerlinMason. And that definitely shouldn't be declared 10 times! 😅 I'll look into that separately.

And admittedly... it sounds like everything is wired up correctly for you. I'm wondering if there's some eslint rule that's conflicting here. Can you send your eslint and prettier configs to be sure?

MerlinMason · 2023-04-18T22:01:07Z

Hi Ben, apologies for the huge delay here, I've been away on holiday and just catching up with messages - thanks again for looking into this!

Here's my config files, apologies the Eslint config is slightly long.

Prettier

{
    "tabWidth": 4,
    "printWidth": 100,
    "arrowParens": "always",
    "proseWrap": "always",
    "overrides": [
        {
            "files": "*.mdx",
            "options": {
                "printWidth": 80
            }
        }
    ]
}

Eslint

{
    "env": {
        "browser": true,
        "es2021": true,
        "jest/globals": true
    },
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "ecmaFeatures": {
            "jsx": true
        },
        "ecmaVersion": "latest",
        "sourceType": "module"
    },
    "globals": {
        "React": true,
        "JSX": true
    },
    "processor": "disable/disable",
    "extends": [
        "plugin:@typescript-eslint/recommended",
        "plugin:react/recommended",
        "plugin:astro/recommended",
        "airbnb",
        "plugin:react/jsx-runtime",
        "plugin:react-hooks/recommended",
        "plugin:jest/recommended",
        "plugin:jest/style",
        "prettier"
    ],
    "plugins": ["react", "@typescript-eslint", "import", "jsx-a11y", "jest", "disable", "prettier"],
    "rules": {
        "import/extensions": 0,
        "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
        "react/require-default-props": 0,
        "react/function-component-definition": [2, { "namedComponents": "arrow-function" }],
        "react/jsx-filename-extension": [2, { "extensions": [".js", ".jsx", ".tsx", ".mdx"] }],
        "react/jsx-props-no-spreading": 0
    },
    "settings": {
        "react": {
            "version": "detect"
        },
        "import/parsers": {
            "@typescript-eslint/parser": [".ts", ".tsx"]
        },
        "import/resolver": {
            "typescript": {
                "alwaysTryTypes": true // always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
            }
        }
    },
    "overrides": [
        {
            "files": ["**/*.mdx"],
            "extends": ["plugin:mdx/recommended"],
            "settings": {
                "mdx/code-blocks": true,
                "mdx/language-mapper": {}
            }
        },
        {
            // we need to make sure we're not linting js files twice
            "files": ["**/*.js", "**/*.jsx"],
            "settings": {
                "disable/plugins": "@typescript-eslint"
            }
        },
        {
            "files": ["*.astro"],
            "parser": "astro-eslint-parser",
            "parserOptions": {
                "parser": "@typescript-eslint/parser",
                "extraFileExtensions": [".astro"]
            }
        }
    ]
}

johny · 2023-05-10T21:26:10Z

This issue should be reopened, its still happening unfortunately 🤷

bholmesdev · 2023-05-17T16:37:23Z

@johny Curious if you have a repro different from Merlin's above? This should be handled with the fixes outlined above, so I have a feeling we're fixing edge cases now

bholmesdev · 2023-05-17T17:27:36Z

@MerlinMason Late reply incoming! I poked around your setup, and I found eslint-config-airbnb and the import plugin were causing the issue.

First removing airbnb, I found installing eslint-import-resolver-typescript fixed any import/nounresolved errors. Trying to add airbnb back, a bit of Googling brought me to eslint-config-airbnb-typescript. Here's my final eslint and dependencies:

.eslintrc.json

{
    "env": {
        "browser": true,
        "es2021": true,
        "jest/globals": true
    },
    "parser": "@typescript-eslint/parser",
    "parserOptions": {
        "ecmaFeatures": {
            "jsx": true
        },
        "ecmaVersion": "latest",
        "sourceType": "module",
        "project": "./tsconfig.json"
    },
    "globals": {
        "React": true,
        "JSX": true
    },
    "processor": "disable/disable",
    "extends": [
        "plugin:@typescript-eslint/recommended",
        "plugin:react/recommended",
        "plugin:astro/recommended",
        "airbnb",
        "airbnb-typescript",
        "plugin:react/jsx-runtime",
        "plugin:react-hooks/recommended",
        "plugin:jest/recommended",
        "plugin:jest/style",
        "prettier"
    ],
    "plugins": ["react", "@typescript-eslint", "import", "jsx-a11y", "jest", "disable", "prettier"],
    "rules": {
        "import/extensions": 0,
        "import/no-extraneous-dependencies": ["error", { "devDependencies": true }],
        "react/require-default-props": 0,
        "react/function-component-definition": [2, { "namedComponents": "arrow-function" }],
        "react/jsx-filename-extension": [2, { "extensions": [".js", ".jsx", ".tsx", ".mdx"] }],
        "react/jsx-props-no-spreading": 0
    },
    "settings": {
        "react": {
            "version": "detect"
        },
        "import/parsers": {
            "@typescript-eslint/parser": [".ts", ".tsx"]
        },
        "import/resolver": {
            "typescript": {
                "alwaysTryTypes": true
            }
        }
    },
    "overrides": [
        {
            "files": ["**/*.mdx"],
            "extends": ["plugin:mdx/recommended"],
            "settings": {
                "mdx/code-blocks": true,
                "mdx/language-mapper": {}
            }
        },
        {
            "files": ["**/*.js", "**/*.jsx"],
            "settings": {
                "disable/plugins": "@typescript-eslint"
            }
        },
        {
            "files": ["*.astro"],
            "parser": "astro-eslint-parser",
            "parserOptions": {
                "parser": "@typescript-eslint/parser",
                "extraFileExtensions": [".astro"]
            }
        }
    ]
}

package.json

{
  "dependencies": {
    "@astrojs/markdoc": "^0.1.2",
    "@astrojs/mdx": "^0.19.1",
    "astro": "^2.4.1",
    "eslint-config-airbnb": "^19.0.4",
    "kleur": "^4.1.5",
    "react": "^18.2.0"
  },
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^5.59.6",
    "@typescript-eslint/parser": "^5.59.6",
    "eslint": "^8.40.0",
    "eslint-config-airbnb-typescript": "^17.0.0",
    "eslint-config-prettier": "^8.8.0",
    "eslint-import-resolver-typescript": "^3.5.5",
    "eslint-plugin-airbnb": "0.0.1-security",
    "eslint-plugin-astro": "^0.27.0",
    "eslint-plugin-disable": "^2.0.3",
    "eslint-plugin-import": "^2.27.5",
    "eslint-plugin-jest": "^27.2.1",
    "eslint-plugin-jsx-a11y": "^6.7.1",
    "eslint-plugin-mdx": "^2.1.0",
    "eslint-plugin-prettier": "^4.2.1",
    "eslint-plugin-react": "^7.32.2",
    "jest": "^29.5.0",
    "typescript": "^5.0.4"
  }
}

Hope this helps!

bholmesdev · 2023-05-23T22:02:53Z

Closing since this issue hasn't seen any replies. Seems reported issues with astro:content are linter-specific. Feel free to respond to my messages above as we debug @MerlinMason!

lloydjatkinson · 2023-06-23T10:59:19Z

This is an issue again with Astro 2.7:

 FAIL  src/domain/article-query.spec.ts [ src/domain/article-query.spec.ts ]
 FAIL  src/domain/book-query.spec.ts [ src/domain/book-query.spec.ts ]
 FAIL  src/domain/note-query.spec.ts [ src/domain/note-query.spec.ts ]
Error: Failed to load url astro:content (resolved id: astro:content) in /workspace/lloydatkinson.net/src/domain/types.ts. Does the file exist?

bluwy · 2023-06-23T13:38:27Z

@lloydjatkinson can you open a new issue with a repro? Thanks!

RayyanNafees · 2023-07-22T07:25:15Z

I just solved the issue by adding module declaration for .astro files in src/env.d.ts

declare module '*.astro'

…stro#5711)

tsevdos · 2023-09-08T19:00:59Z

If you are getting this error while deploying to Cloudflare Pages (SSG), you can resolve it with 2 options:

Either your change your build command to npx astro sync && npm run build on Cloudflare's dashboard (very easy solution)

OR

You generate the types locally by running the sync command locally npx astro sync and then commit / push the generated tsconfig.tsbuildinfo file to your repo. You only need to do this, if you change your .md / .mdx schema. Finally, you might have this file listed on your .gitignore file so be careful.

Edit: the second solution is not working, my bad...

number44 · 2023-09-19T18:53:37Z

I had the same problem, command "npm run astro check" worked for me.

arvi · 2023-09-30T08:45:26Z

Had the same problem and npm run build then restarting TS server is what worked for me. 😄

AndresdoSantos · 2023-10-01T18:41:18Z

In my case I put the wrong name in the folder, instead of putting /content I put /contents 😄...This took me 30 minutes lol

bennycode · 2023-10-04T15:29:34Z

In my case the error TS2307: Cannot find module astro:content showed in a blank Astro project. I had to run npm run dev and afterwards my WebStorm 2023.2.2 was able to find the type definitions for Astro. 🚀

pranav-solvative · 2023-10-06T12:28:37Z

npm run astro check

yes for me also...thank you :)

withastro/astro#5711

SotaNoniwa · 2023-12-09T08:55:37Z

Runing npx astro sync then close VSCode and restart it again resolved mine.

Keoooo · 2023-12-22T01:14:50Z

@SotaNoniwa good fix 🚀

IsTheMartin · 2024-02-10T04:15:02Z

~~Hi all, I'm facing this issue in Astro v4.3.2, is there a workaround or solution for that issue?~~

~~I've followed all your comments mentioned above a none of them have helped to me :(~~

Nvm, I've found the reason:
don't put content/blog folder inside pages/
It should be src/content/blog

rdthree · 2024-10-30T03:15:55Z

I have the same error, driving me up the wall, tried all of the above, oddly my site builds just fine.

https://github.com/rdthree/astro-rd3-sketchbook/blob/master/src/content/config.ts

piotrkulpinski · 2024-12-17T15:06:27Z

Adding the following line to tsconfig.json fixed those issues for me:

"include": [".astro/types.d.ts", "**/*"],

kozdmr · 2024-12-18T12:58:52Z

Why do we have to do all this nonsense? Moreover, the problem is not fixed! It is a disaster to produce patch solutions without knowing what the problem is.

WillDelish · 2024-12-28T20:54:54Z

Fyi to anyone who stumbles here from google search'n, I had to change this in my tsconfig file to get typescript happy:

"extends": "astro/tsconfigs/base", instead of "extends": "astro/tsconfigs/strict", + restart typescript server in VS code. This made a few astro imports work just fine, a relic from migrating to Astro v5 it seems.

bholmesdev · 2025-01-06T15:18:27Z

@WillDelish hm, relaxing typescript settings shouldn't be a requirement for using astro: modules. Think you can reproduce this in a GitHub issue?

bholmesdev self-assigned this Jan 6, 2023

bholmesdev added content-collections - P3: minor bug An edge case that only affects very specific usage (priority) labels Jan 6, 2023

bholmesdev mentioned this issue Jan 10, 2023

[Content collections] Improve content config handling #5824

Merged

bholmesdev closed this as completed in #5824 Jan 11, 2023

bholmesdev reopened this May 15, 2023

bholmesdev closed this as completed May 23, 2023

AnnaBurd added a commit to AnnaBurd/web-real-estate that referenced this issue Aug 23, 2023

build: 🚨 fix issue of astro not able to find module (ref: withastro/a…

f260143

…stro#5711)

tino-brst added a commit to tino-brst/tabs-site that referenced this issue Oct 20, 2023

fix missing modules

23867dc

withastro/astro#5711

Gumichocopengin8 mentioned this issue Nov 26, 2023

feat: i18n setup and some Japanese translation biomejs/biome#887

Merged

eko24ive mentioned this issue Jan 11, 2024

⚠️ Issue while following tutorial page "Tutorial - Extend with Content Collections" withastro/docs#6271

Closed

bsidhom mentioned this issue Nov 15, 2024

defineCollection and other declarations missing from generated types for "astro:content" module #12439

Closed

1 task

brezzy1337 mentioned this issue Jan 1, 2025

Content Collection documentation needs to updated. withastro/docs#10569

Closed

Cannot find module 'astro:content' #5711

Cannot find module 'astro:content' #5711

Comments

azan-n commented Jan 1, 2023 • edited Loading

What version of astro are you using?

Are you using an SSR adapter? If so, which one?

What package manager are you using?

What operating system are you using?

Describe the Bug

Steps to reproduce

Link to Minimal Reproducible Example

Participation

bholmesdev commented Jan 1, 2023

azan-n commented Jan 2, 2023 • edited Loading

bholmesdev commented Jan 2, 2023

bholmesdev commented Jan 2, 2023

azan-n commented Jan 3, 2023

r-sp commented Jan 6, 2023 • edited Loading

bholmesdev commented Jan 6, 2023

azan-n commented Jan 14, 2023 • edited Loading

bholmesdev commented Jan 14, 2023

natguy commented Jan 24, 2023 • edited Loading

bholmesdev commented Jan 24, 2023

ilievskif commented Jan 30, 2023

bholmesdev commented Jan 30, 2023

MerlinMason commented Apr 3, 2023

bholmesdev commented Apr 5, 2023

MerlinMason commented Apr 6, 2023

bholmesdev commented Apr 7, 2023

MerlinMason commented Apr 18, 2023

johny commented May 10, 2023

bholmesdev commented May 17, 2023

bholmesdev commented May 17, 2023 • edited Loading

bholmesdev commented May 23, 2023

lloydjatkinson commented Jun 23, 2023

bluwy commented Jun 23, 2023

RayyanNafees commented Jul 22, 2023

tsevdos commented Sep 8, 2023 • edited Loading

number44 commented Sep 19, 2023 • edited Loading

arvi commented Sep 30, 2023

AndresdoSantos commented Oct 1, 2023 • edited Loading

bennycode commented Oct 4, 2023

pranav-solvative commented Oct 6, 2023

SotaNoniwa commented Dec 9, 2023

Keoooo commented Dec 22, 2023

IsTheMartin commented Feb 10, 2024 • edited Loading

rdthree commented Oct 30, 2024

piotrkulpinski commented Dec 17, 2024

kozdmr commented Dec 18, 2024

WillDelish commented Dec 28, 2024 • edited Loading

bholmesdev commented Jan 6, 2025

azan-n commented Jan 1, 2023 •

edited

Loading

What version of `astro` are you using?

azan-n commented Jan 2, 2023 •

edited

Loading

r-sp commented Jan 6, 2023 •

edited

Loading

azan-n commented Jan 14, 2023 •

edited

Loading

natguy commented Jan 24, 2023 •

edited

Loading

bholmesdev commented May 17, 2023 •

edited

Loading

tsevdos commented Sep 8, 2023 •

edited

Loading

number44 commented Sep 19, 2023 •

edited

Loading

AndresdoSantos commented Oct 1, 2023 •

edited

Loading

IsTheMartin commented Feb 10, 2024 •

edited

Loading

WillDelish commented Dec 28, 2024 •

edited

Loading