feat: injectTypes #11551

florian-lefebvre · 2024-07-25T10:18:22Z

Changes

Adds injectTypes utility to astro:config:done
Refactors how typegen works internally so it's also used by core
Update astro:db to use this new API
Refactors .astro structure
- It's backward compatible
- Now, a .astro/types.d.ts file is generated with references to any injected type + astro/client
- Core types are moved to .astro/astro
- Integration types are written to /.astro/integrations/<normalized_integration_name>/<normalized_filename>.d.ts
- src/env.d.ts only needs a reference to the newly generated .astro/types.d.ts. Goal in the future is to remove the need for this file by generating a tsconfig.json file
Uses settings.dotAstroDir when possible

Testing

Updates sync tests
All tests should pass
Added unit tests for types path normalization

Docs

withastro/docs#9012

Additional info

RFC: Set a clear `.astro` directory structure roadmap#887
First disastrous attempt: feat: injectDts and codegenDir #9952
addDts from AIK (source)

changeset-bot · 2024-07-25T10:18:27Z

🦋 Changeset detected

Latest commit: c4235c3

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

…into feat/inject-types

packages/astro/src/core/sync/write-files.ts

packages/astro/src/content/types-generator.ts

.changeset/mean-horses-kiss.md

Princesseuh · 2024-08-12T13:15:25Z

.changeset/mean-horses-kiss.md

+Under the hood, it will create a file at `/.astro/integrations/<normalized_integration_name>/<normalized_filename>.d.ts` and create references to it. `injectTypes()` returns a URL to the normalized path.
+
+```js
+const path = injectTypes({


What's the point of it returning the path?

See what we're doing in core for content sync (ie. overriding the dts file with content updates)? I can imagine some people wanting to do this in integrations. Since we normalize the filename, people can't easily construct the path themselves so we give it to them

packages/astro/src/core/errors/errors-data.ts

packages/astro/src/integrations/hooks.ts

packages/astro/src/core/dev/restart.ts

.changeset/mean-horses-kiss.md

sarah11918

Assuming we're happy with how the docs PR looks, we can pull that in here for the changeset! (Adjust to taste.)

.changeset/mean-horses-kiss.md

Co-authored-by: Sarah Rainsberger <[email protected]>

.changeset/mean-horses-kiss.md

Co-authored-by: Sarah Rainsberger <[email protected]>

* Empty commit * Changeset * feat: add Content Layer loader (#11334) * wip * wip * wip * Update demo * Add meta * wip * Add file loader * Add schema validation * Remove log * Changeset * Format * Lockfile * Fix type * Handle loading for data store JSON * Use rollup util to import JSON * Fix types * Format * Add tests * Changes from review * fix: sync content layer in dev (#11365) * wip * wip * wip * Update demo * Add meta * wip * Add file loader * Add schema validation * Remove log * Changeset * Format * Lockfile * Fix type * Handle loading for data store JSON * Use rollup util to import JSON * Fix types * Format * Add tests * Changes from review * Sync content layer in dev * feat: add typegen for loaders (#11358) * fix: watch for content layer changes (#11371) * fix: watch for content layer changes * Add test * feat: adds simple loader (#11386) * wip * Add simple loader * Fix type guard * Tighten loader schema * Add loader function to type * Reinstall vitest * feat: add glob loader (#11398) * feat: add glob loader * Enable watching and fix paths * Store the full entry object, not just data * Add generateId support * Fix test * Rename loaders to sync * Refacctor imports * Use getEntry * Format * Fix import * Remove type from output * Windows path * Add test for absolute path * Update lockfile * Debugging windows * Allow file URL for base dir * Reset time limit * feat: add markdown rendering to content layer (#11440) * feat: add glob loader * Enable watching and fix paths * Store the full entry object, not just data * Add generateId support * Fix test * Rename loaders to sync * Refacctor imports * Use getEntry * Format * Fix import * Remove type from output * Windows path * Add test for absolute path * Update lockfile * Debugging windows * Allow file URL for base dir * Reset time limit * wip: add markdown rendering to content layer * use cached entries * CLean up types * Instrument more of the build * Add digest helper * Add comments * Make image extraction work * feat: image support for content layer (#11469) * wip * wip * Add image to benchmark * Stub assets if missing * Resolve assets in data * Ignore virtual module * Format * rm log * Handle images when using cached data * Fix CCC * Add a comment * Changes from review * Format * Use relative paths for asset files * Pass all md props to getImage * Ensure dotastro dir exists * Fix tests * Changes from review * Don't use temp array in getcollection * Add error handling * Format * Handle paths that are already relative * Dedupe sync runs * Fix syncing in dev * Changes from review * Windows paths ftw * feat(content-layer): support references in content layer (#11494) * Support references in content layer * Fix utf8 rendering * Warn for invalid entries * Fix test * lol windows paths * Remove assertion * chore: fix content layer types (#11527) * Add experimental_content type * Fix import * Make data store methods generic * fix loader types * Lockfile * Clean content layer with `--force` (#11541) * Clearn content layer with `--force` * Add tests * Document --force flag * Fixes to content layer render types (#11558) * Lockfile * feat: use devalue to serialize content layer data (#11562) * feat: use devalue to serialize content layer data * Fix import * Use devalue stringify * Unused import * Propagate error messages correctly * Support --force flag in sync and dev (#11581) * Support --force flag in sync and dev * Fix test * Separate render function and merge content layer types (#11579) * Separate render function and merge content layer types * Changes from review * fix: clear content layer cache if config has changed (#11591) * fix: clear content layer cache if config has changed * Add test * Watch config * Change from review * fix: skip glob files in content dir (#11622) * fix: skip glob files in content dir * Changes from review * Log pattern * Refactor content layer into shared instance (#11625) * Refactor content layer into shared instance * Clean up when testing * Handle cleanup * fix: support filters in content layer getCollection (#11631) * Throw when using deprecated getEntryByX functions with content layer (#11637) * Updates to content layer types and jsdocs (#11643) * Add hot key to reload content layer (#11626) * Add hot key to reload content layer * Fix filename * Remove cli message * Update example * Change key to "s" * feat: handle simple mdx rendering (#11633) * feat: handle simple mdx rendering * cleanup * feedback * fix regression * remove log * flip condition * update tests * log collections to understand the error * let's try this alternative * try parallel test to understand the issue * chore: use a new fixture to fix tests * rebase and docs * fix regressions * remove old code * address feedback * rename param * log error * rebase * chore: try a different cache dir to solve the error test * fix invalidation of the module when there's no store available * address suggestion * run formatter * update lock file * Lint * Add experimental content layer flag (#11652) * Add experimental content layer flag * Syntax and format * Aside * Format * Reset content config between runs * Update fixture * Update terminology * Lint * wut * Normalize render function return value (#11663) * Add markdoc support to content layer (#11664) * Add markdoc support to content layer * Switch test to cheerio * Update benchmarks * update lock file * Update content layer flag docs (#11682) * Update content layer flag docs * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <[email protected]> * More markdoc * Typo * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <[email protected]> * Update --------- Co-authored-by: Sarah Rainsberger <[email protected]> * Add changeset for content layer experimental release (#11644) * Add changeset for content layer experimental release * Update changeset * Update .changeset/smooth-chicken-wash.md Co-authored-by: Sarah Rainsberger <[email protected]> --------- Co-authored-by: Sarah Rainsberger <[email protected]> * feat: injectTypes (#11551) * feat: make inline config 1st arg * fix: run config done in sync * feat: start working on injectTypes * feat: write files * feat: adapt core features * feat: migrate db to injectTypes * feat: special db handling * feat: update settings instead of workarounds * fix: create dotAstroDir * feat: refactor sync tests * fix: path * fix: paths * chore: add comments * feat: overwrite content file if exists * chore: remove unused db env related code * feat: use dotAstroDir for settings * chore: simplify astro env sync * feat: use dotAstroDir for preferences * feat: handle db in integration api * chore: reorganize * feat: format * feat: add test * Discard changes to examples/basics/astro.config.mjs * Discard changes to examples/basics/package.json * Discard changes to pnpm-lock.yaml * chore: remove test files * feat: update examples dts * fix: dts * chore: changesets * fix: indentation * Apply suggestions from code review Co-authored-by: Chris Swithinbank <[email protected]> * Apply suggestions from code review Co-authored-by: Chris Swithinbank <[email protected]> * chore: format * Update packages/astro/src/integrations/hooks.ts * Update .changeset/mean-horses-kiss.md * feat: remove formatting * feat: handle fs errors * feat: remove astro:db special path handling * feat: add fs error * Update packages/astro/src/content/types-generator.ts * Update .changeset/mean-horses-kiss.md * Update errors-data.ts * Update .changeset/mean-horses-kiss.md Co-authored-by: Sarah Rainsberger <[email protected]> * Update .changeset/mean-horses-kiss.md Co-authored-by: Sarah Rainsberger <[email protected]> --------- Co-authored-by: Chris Swithinbank <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Erika <[email protected]> * Add file generation and flag for content intellisense (#11639) * feat: add type to infer input type of collection * refactor: * feat: generate json schema for content too * feat: generate a manifest of all the collections * refactor: unnecessary type * fix: only add content collections to manifest * chore: changeset * fix: generate file URLs * fix: flag it properly * fix: save in lower case * docs: add jsdoc to experimental option * nit: move function out * fix: match vscode flag name * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <[email protected]> * Update packages/astro/src/@types/astro.ts Co-authored-by: Sarah Rainsberger <[email protected]> * Update serious-pumas-run.md * test: add tests * Add content layer support * Apply suggestions from code review * fix: test * Update .changeset/serious-pumas-run.md Co-authored-by: Sarah Rainsberger <[email protected]> * Apply suggestions from code review * Remove check for json --------- Co-authored-by: Matt Kane <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]> * nit: use same filesystem error as injectTypes * fix: code component was missing support for meta string (#11605) * fix: code component was missing support for meta string Fixed #11604 * Create odd-buttons-pay.md * <Code>: add reference link for meta prop * Apply suggestions from code review Co-authored-by: Sarah Rainsberger <[email protected]> * Update .changeset/odd-buttons-pay.md * Update .changeset/odd-buttons-pay.md Co-authored-by: Sarah Rainsberger <[email protected]> --------- Co-authored-by: Erika <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Emanuele Stoppa <[email protected]> * Deprecates exporting prerender with dynamic values (#11657) * wip * done i think * Add changeset * Use hook instead * Reorder hooks [skip ci] * Update .changeset/eleven-pens-glow.md Co-authored-by: Sarah Rainsberger <[email protected]> * Fix run * Fix link * Add link Co-authored-by: Sarah Rainsberger <[email protected]> * More accurate migration [skip ci] --------- Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]> * Use node parseArgs instead of yargs-parser and arg (#11645) * wip * done * Add changeset * Format * Update * Fix houston * Fix test * Fix test * [ci] format * resolve conflict --------- Co-authored-by: Emanuele Stoppa <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Florian Lefebvre <[email protected]> Co-authored-by: Chris Swithinbank <[email protected]> Co-authored-by: Erika <[email protected]> Co-authored-by: Julien Cayzac <[email protected]> Co-authored-by: Bjorn Lu <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]> Co-authored-by: Bjorn Lu <[email protected]>

feat: make inline config 1st arg

e074704

github-actions bot added the pkg: astro Related to the core `astro` package (scope) label Jul 25, 2024

florian-lefebvre added 2 commits July 25, 2024 12:19

fix: run config done in sync

e28c8ed

feat: start working on injectTypes

8a5c2a2

github-actions bot added the pr: docs A PR that includes documentation for review label Jul 25, 2024

florian-lefebvre added 2 commits July 25, 2024 14:45

feat: write files

4fb6bbe

feat: adapt core features

9f2ccea

github-actions bot added the pkg: example Related to an example package (scope) label Jul 25, 2024

florian-lefebvre added 21 commits July 25, 2024 15:22

feat: migrate db to injectTypes

b2c14e9

feat: special db handling

04b828c

feat: update settings instead of workarounds

dc53d1a

fix: create dotAstroDir

adeeaa2

feat: refactor sync tests

bf1686b

Merge branch 'main' into feat/inject-types

c770927

fix: path

9fe686e

Merge branch 'feat/inject-types' of https://github.com/withastro/astro …

ef75b5a

…into feat/inject-types

fix: paths

f3f02f7

chore: add comments

c08bff9

feat: overwrite content file if exists

fe62fe5

chore: remove unused db env related code

4b89dbc

feat: use dotAstroDir for settings

d7df994

chore: simplify astro env sync

6a85ce6

feat: use dotAstroDir for preferences

ea1bde4

feat: handle db in integration api

badc2a5

chore: reorganize

2bee83d

feat: format

fe82d08

feat: add test

c474594

Discard changes to examples/basics/astro.config.mjs

8d8a32e

Discard changes to examples/basics/package.json

157238a

florian-lefebvre added 2 commits August 9, 2024 12:04

feat: remove formatting

6602653

feat: handle fs errors

e53f9ab

florian-lefebvre commented Aug 9, 2024

View reviewed changes

packages/astro/src/core/sync/write-files.ts Outdated Show resolved Hide resolved

feat: remove astro:db special path handling

934406a

ematipico approved these changes Aug 12, 2024

View reviewed changes

florian-lefebvre added 2 commits August 12, 2024 14:32

Merge branch 'main' into feat/inject-types

c2a3dd2

feat: add fs error

f512569

Princesseuh reviewed Aug 12, 2024

View reviewed changes

packages/astro/src/content/types-generator.ts Show resolved Hide resolved

florian-lefebvre mentioned this pull request Aug 12, 2024

feat(next): make astro:env stable #11679

Merged

Princesseuh reviewed Aug 12, 2024

View reviewed changes

.changeset/mean-horses-kiss.md Show resolved Hide resolved

Princesseuh reviewed Aug 12, 2024

View reviewed changes

packages/astro/src/core/errors/errors-data.ts Outdated Show resolved Hide resolved

Update packages/astro/src/content/types-generator.ts

ca93448

Princesseuh reviewed Aug 12, 2024

View reviewed changes

packages/astro/src/integrations/hooks.ts Show resolved Hide resolved

matthewp approved these changes Aug 12, 2024

View reviewed changes

florian-lefebvre changed the base branch from main to content-layer August 12, 2024 14:46

Merge branch 'content-layer' into feat/inject-types

62fb454

bluwy approved these changes Aug 13, 2024

View reviewed changes

packages/astro/src/core/dev/restart.ts Show resolved Hide resolved

florian-lefebvre commented Aug 13, 2024

View reviewed changes

.changeset/mean-horses-kiss.md Outdated Show resolved Hide resolved

florian-lefebvre added 2 commits August 13, 2024 13:44

Update .changeset/mean-horses-kiss.md

24089e2

Update errors-data.ts

7f702b0

sarah11918 reviewed Aug 13, 2024

View reviewed changes

.changeset/mean-horses-kiss.md Outdated Show resolved Hide resolved

Update .changeset/mean-horses-kiss.md

27426b5

Co-authored-by: Sarah Rainsberger <[email protected]>

sarah11918 reviewed Aug 13, 2024

View reviewed changes

.changeset/mean-horses-kiss.md Outdated Show resolved Hide resolved

florian-lefebvre and others added 2 commits August 13, 2024 16:03

Update .changeset/mean-horses-kiss.md

8f38a9d

Co-authored-by: Sarah Rainsberger <[email protected]>

Merge branch 'content-layer' into feat/inject-types

c4235c3

Princesseuh merged commit e40043f into content-layer Aug 14, 2024
5 checks passed

Princesseuh deleted the feat/inject-types branch August 14, 2024 10:05

florian-lefebvre mentioned this pull request Aug 14, 2024

chore: optimize check #11704

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: injectTypes #11551

feat: injectTypes #11551

florian-lefebvre commented Jul 25, 2024 •

edited

Loading

changeset-bot bot commented Jul 25, 2024 •

edited

Loading

Princesseuh Aug 12, 2024

florian-lefebvre Aug 12, 2024

sarah11918 left a comment

feat: injectTypes #11551

feat: injectTypes #11551

Conversation

florian-lefebvre commented Jul 25, 2024 • edited Loading

Changes

Testing

Docs

Additional info

changeset-bot bot commented Jul 25, 2024 • edited Loading

🦋 Changeset detected

Princesseuh Aug 12, 2024

Choose a reason for hiding this comment

florian-lefebvre Aug 12, 2024

Choose a reason for hiding this comment

sarah11918 left a comment

Choose a reason for hiding this comment

florian-lefebvre commented Jul 25, 2024 •

edited

Loading

changeset-bot bot commented Jul 25, 2024 •

edited

Loading