feat(astro): Exposes extra APIs for script and testing #12052

Fryuni · 2024-09-22T04:59:10Z

Changes

Expose the APIs required for third-party libraries properly write tests against Astro projects
Test package for ecosystem libraries roadmap#1021 (comment)

Testing

There was no change in logic. The behavior for all changed functions was already tested.

Docs

The docs on the build API should be updated
There is currently no reference documentation for the functions and types exported from astro/config, so nothing to update. The two functions newly exported would go in such a reference.

changeset-bot · 2024-09-22T04:59:15Z

🦋 Changeset detected

Latest commit: a94413b

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

github-actions

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

packages/astro/src/core/build/index.ts

packages/astro/config.d.ts

ematipico

Thank you @Fryuni for kicking off this! I am going to block this PR for now, while we agreed on a plan on how to ship this new feature on Discord.

…testing

matthewp · 2024-10-08T19:56:07Z

!preview test-apis

github-actions · 2024-10-08T19:57:55Z

Snapshots have been released for the following packages:

astro@experimental--test-apis
@astrojs/rss@experimental--test-apis
create-astro@experimental--test-apis

Publish Log

🦋  warn ===============================IMPORTANT!===============================
🦋  warn Packages will be released under the experimental--test-apis tag
🦋  warn ----------------------------------------------------------------------
🦋  info npm info astro
🦋  info npm info @astrojs/prism
🦋  info npm info @astrojs/rss
🦋  info npm info create-astro
🦋  info npm info @astrojs/db
🦋  info npm info @astrojs/alpinejs
🦋  info npm info @astrojs/lit
🦋  info npm info @astrojs/markdoc
🦋  info npm info @astrojs/mdx
🦋  info npm info @astrojs/partytown
🦋  info npm info @astrojs/preact
🦋  info npm info @astrojs/react
🦋  info npm info @astrojs/sitemap
🦋  info npm info @astrojs/solid-js
🦋  info npm info @astrojs/svelte
🦋  info npm info @astrojs/tailwind
🦋  info npm info @astrojs/vue
🦋  info npm info @astrojs/web-vitals
🦋  info npm info @astrojs/internal-helpers
🦋  info npm info @astrojs/markdown-remark
🦋  info npm info @astrojs/studio
🦋  info npm info @astrojs/telemetry
🦋  info npm info @astrojs/underscore-redirects
🦋  info npm info @astrojs/upgrade
🦋  info astro is being published because our local version (0.0.0-test-apis-20241008195645) has not been published on npm
🦋  warn @astrojs/prism is not being published because version 3.1.0 is already published on npm
🦋  info @astrojs/rss is being published because our local version (0.0.0-test-apis-20241008195645) has not been published on npm
🦋  info create-astro is being published because our local version (0.0.0-test-apis-20241008195645) has not been published on npm
🦋  warn @astrojs/db is not being published because version 0.14.2 is already published on npm
🦋  warn @astrojs/alpinejs is not being published because version 0.4.0 is already published on npm
🦋  warn @astrojs/lit is not being published because version 4.3.0 is already published on npm
🦋  warn @astrojs/markdoc is not being published because version 0.11.4 is already published on npm
🦋  warn @astrojs/mdx is not being published because version 3.1.7 is already published on npm
🦋  warn @astrojs/partytown is not being published because version 2.1.2 is already published on npm
🦋  warn @astrojs/preact is not being published because version 3.5.3 is already published on npm
🦋  warn @astrojs/react is not being published because version 3.6.2 is already published on npm
🦋  warn @astrojs/sitemap is not being published because version 3.2.0 is already published on npm
🦋  warn @astrojs/solid-js is not being published because version 4.4.2 is already published on npm
🦋  warn @astrojs/svelte is not being published because version 5.7.2 is already published on npm
🦋  warn @astrojs/tailwind is not being published because version 5.1.1 is already published on npm
🦋  warn @astrojs/vue is not being published because version 4.5.2 is already published on npm
🦋  warn @astrojs/web-vitals is not being published because version 3.0.0 is already published on npm
🦋  warn @astrojs/internal-helpers is not being published because version 0.4.1 is already published on npm
🦋  warn @astrojs/markdown-remark is not being published because version 5.2.0 is already published on npm
🦋  warn @astrojs/studio is not being published because version 0.1.1 is already published on npm
🦋  warn @astrojs/telemetry is not being published because version 3.1.0 is already published on npm
🦋  warn @astrojs/underscore-redirects is not being published because version 0.3.4 is already published on npm
🦋  warn @astrojs/upgrade is not being published because version 0.3.4 is already published on npm
🦋  info Publishing "astro" at "0.0.0-test-apis-20241008195645"
🦋  info Publishing "@astrojs/rss" at "0.0.0-test-apis-20241008195645"
🦋  info Publishing "create-astro" at "0.0.0-test-apis-20241008195645"
🦋  success packages published successfully:
🦋  [email protected]
🦋  @astrojs/[email protected]
🦋  [email protected]
🦋  Creating git tags...
🦋  New tag:  [email protected]
🦋  New tag:  @astrojs/[email protected]
🦋  New tag:  [email protected]

Build Log


> [email protected] build /home/runner/work/astro/astro
> turbo run build --filter=astro --filter=create-astro --filter="@astrojs/*" --filter="@benchmark/*"

• Packages in scope: @astrojs/alpinejs, @astrojs/cloudflare, @astrojs/db, @astrojs/internal-helpers, @astrojs/lit, @astrojs/markdoc, @astrojs/markdown-remark, @astrojs/mdx, @astrojs/netlify, @astrojs/node, @astrojs/partytown, @astrojs/preact, @astrojs/prism, @astrojs/react, @astrojs/rss, @astrojs/sitemap, @astrojs/solid-js, @astrojs/studio, @astrojs/svelte, @astrojs/tailwind, @astrojs/telemetry, @astrojs/underscore-redirects, @astrojs/upgrade, @astrojs/vercel, @astrojs/vue, @astrojs/web-vitals, @benchmark/timer, astro, create-astro
• Running build in 29 packages
• Remote caching enabled
::group::@astrojs/telemetry:build
cache miss, executing 214adb7ba3481648

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/telemetry
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/internal-helpers:build
cache miss, executing 6bc5ceedab5ed77d

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/internal-helpers
> astro-scripts build "src/**/*.ts" && tsc -p tsconfig.json

::endgroup::
::group::@astrojs/prism:build
cache miss, executing 8a200e48d3ad77d3

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/astro-prism
> astro-scripts build "src/**/*.ts" && tsc -p ./tsconfig.json

::endgroup::
::group::create-astro:build
cache miss, executing 3bc781012dc99721

> [email protected] build /home/runner/work/astro/astro/packages/create-astro
> astro-scripts build "src/index.ts" --bundle && tsc

::endgroup::
::group::@astrojs/upgrade:build
cache miss, executing 0038756a9e347ad5

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/upgrade
> astro-scripts build "src/index.ts" --bundle && tsc

::endgroup::
::group::@astrojs/markdown-remark:build
cache miss, executing 7c1ae241d812f896

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/markdown/remark
> astro-scripts build "src/**/*.ts" && tsc -p tsconfig.json

::endgroup::
::group::astro:build
cache miss, executing 07680a1965407f24

> [email protected] build /home/runner/work/astro/astro/packages/astro
> pnpm run prebuild && astro-scripts build "src/**/*.{ts,js}" --copy-wasm && tsc


> [email protected] prebuild /home/runner/work/astro/astro/packages/astro
> astro-scripts prebuild --to-string "src/runtime/server/astro-island.ts" "src/runtime/client/{idle,load,media,only,visible}.ts"

::endgroup::
::group::@astrojs/studio:build
cache miss, executing c484be47b557600f

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/studio
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/underscore-redirects:build
cache miss, executing c9060bde264921a2

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/underscore-redirects
> astro-scripts build "src/**/*.ts" && tsc -p tsconfig.json

::endgroup::
::group::@astrojs/alpinejs:build
cache miss, executing e663907511e76994

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/alpinejs
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/lit:build
cache miss, executing c3071774a5f79088

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/lit
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/partytown:build
cache miss, executing 38767e3a1ee60cab

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/partytown
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@benchmark/timer:build
cache miss, executing f805e7155e366346

> @benchmark/[email protected] build /home/runner/work/astro/astro/benchmark/packages/timer
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/tailwind:build
cache miss, executing e8c351f4f19e4738

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/tailwind
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/vue:build
cache miss, executing d2a2285c81d67488

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/vue
> astro-scripts build "src/index.ts" && astro-scripts build "src/editor.cts" --force-cjs --no-clean-dist && tsc

::endgroup::
::group::@astrojs/mdx:build
cache miss, executing 0ce1a75b0637839e

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/mdx
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/markdoc:build
cache miss, executing 8bd0750d843b0dfa

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/markdoc
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/rss:build
cache miss, executing f4d542e84b5fbb16

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/astro-rss
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/sitemap:build
cache miss, executing 4c2a10aa8d9d9795

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/sitemap
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/react:build
cache miss, executing 538ea99483193d37

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/react
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/svelte:build
cache miss, executing 82102e98fa5b19cc

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/svelte
> astro-scripts build "src/index.ts" && astro-scripts build "src/editor.cts" --force-cjs --no-clean-dist && tsc

::endgroup::
::group::@astrojs/solid-js:build
cache miss, executing 4a3e5e8638105b63

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/solid
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/preact:build
cache miss, executing 7e11742635b60788

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/preact
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::
::group::@astrojs/db:build
cache miss, executing 321eca678fc2d736

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/db
> astro-scripts build "src/**/*.ts" && tsc && pnpm types:virtual


> @astrojs/[email protected] types:virtual /home/runner/work/astro/astro/packages/db
> tsc -p ./tsconfig.virtual.json

::endgroup::
::group::@astrojs/web-vitals:build
cache miss, executing c2b6947ef33dfc15

> @astrojs/[email protected] build /home/runner/work/astro/astro/packages/integrations/web-vitals
> astro-scripts build "src/**/*.ts" && tsc

::endgroup::

 Tasks:    25 successful, 25 total
Cached:    0 cached, 25 total
  Time:    51.141s

.changeset/bright-eels-cross.md

ematipico

After the meeting we had, I am good now. Happy to merge it!

Co-authored-by: Matt Kane <[email protected]>

sarah11918 · 2024-11-12T16:24:30Z

There is currently no reference documentation for the functions and types exported from astro/config

Should there be? 😅

ematipico · 2024-11-19T14:00:37Z

@Fryuni what's the status of the PR? Considering this is a minor and we are exposing new APIs, I believe we should document them. Happy to help if needed.

codspeed-hq · 2025-02-14T01:25:01Z

CodSpeed Performance Report

Merging #12052 will not alter performance

_{Comparing feat/expose-apis-for-testing (a94413b) with main (4a43c4b)}

Summary

✅ 6 untouched benchmarks

Fryuni · 2025-02-14T18:16:05Z

Coming back to this PR (finally). I opened Fryuni/inox-tools#203 updating the astro-tests package to use these newly exported functions. Everything is working perfectly, both testing with Vitest and with Playwright.

Previously we talked about testing it out on the adapters repo, but since they are now part of this repo I don't think that would be necessary.

sarah11918 · 2025-02-23T23:10:24Z

Just reminding @Fryuni to loop me in re: what might be required for docs! Just because something wasn't documented before doesn't mean it shouldn't have been... 😄

sarah11918

Just quick changeset comments!

.changeset/slimy-cougars-worry.md

.changeset/bright-eels-cross.md

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

.changeset/slimy-cougars-worry.md

.changeset/bright-eels-cross.md

sarah11918

Approving for docs, with some nits below and additional "commentary" for your consideration @Fryuni ! I trust you to take it from here! 🫡

Also noting, to remind myself as much as anyone, I did not see any new error messages added to accompany this feature.

Concerns addressed

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

github-actions

This PR is blocked because it contains a minor changeset. A reviewer will merge this at the next release if approved.

Merge day

feat(astro): Exposes extra APIs for script and testing

3a73ea9

Fryuni added the pkg: astro Related to the core `astro` package (scope) label Sep 22, 2024

Fryuni requested review from matthewp and ematipico September 22, 2024 04:59

Fryuni self-assigned this Sep 22, 2024

github-actions bot added the semver: minor Change triggers a `minor` release label Sep 22, 2024

github-actions bot previously requested changes Sep 22, 2024

View reviewed changes

Fryuni requested a review from alexanderniebuhr September 22, 2024 05:02

Fix type lint issue

6da3161

matthewp approved these changes Sep 22, 2024

View reviewed changes

florian-lefebvre approved these changes Sep 28, 2024

View reviewed changes

bluwy previously requested changes Sep 29, 2024

View reviewed changes

packages/astro/src/core/build/index.ts Show resolved Hide resolved

packages/astro/config.d.ts Outdated Show resolved Hide resolved

packages/astro/config.d.ts Outdated Show resolved Hide resolved

ematipico requested changes Oct 1, 2024

View reviewed changes

Merge remote-tracking branch 'origin/main' into feat/expose-apis-for-…

b842f99

…testing

github-actions bot added the pr preview This PR has a preview release label Oct 8, 2024

ascorbic reviewed Oct 8, 2024

View reviewed changes

.changeset/bright-eels-cross.md Outdated Show resolved Hide resolved

ematipico approved these changes Oct 14, 2024

View reviewed changes

Update .changeset/bright-eels-cross.md

7cac830

Co-authored-by: Matt Kane <[email protected]>

Fryuni added 2 commits February 13, 2025 22:06

Merge branch 'main' into feat/expose-apis-for-testing

44457a0

Update type import

011ec13

Expose config merge and validation APIs

ce65be4

Fryuni added a commit to Fryuni/inox-tools that referenced this pull request Feb 14, 2025

wip(astro-tests): Use stable Astro APIs from withastro/astro#12052

b718977

Fryuni mentioned this pull request Feb 14, 2025

feat(astro-tests): Use stable Astro Config APIs Fryuni/inox-tools#203

Merged

florian-lefebvre added this to the 5.4.0 milestone Feb 21, 2025

sarah11918 reviewed Feb 23, 2025

View reviewed changes

.changeset/slimy-cougars-worry.md Outdated Show resolved Hide resolved

.changeset/bright-eels-cross.md Outdated Show resolved Hide resolved

Merge branch 'main' into feat/expose-apis-for-testing

15dd023

Fryuni mentioned this pull request Feb 25, 2025

Document new programmatic APIs and options withastro/docs#11051

Merged

Fryuni and others added 2 commits February 24, 2025 22:41

Update .changeset/slimy-cougars-worry.md

2010e26

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

Improve changeset

0cd9fc0

sarah11918 reviewed Feb 25, 2025

View reviewed changes

.changeset/slimy-cougars-worry.md Outdated Show resolved Hide resolved

sarah11918 reviewed Feb 25, 2025

View reviewed changes

.changeset/bright-eels-cross.md Outdated Show resolved Hide resolved

sarah11918 reviewed Feb 25, 2025

View reviewed changes

.changeset/bright-eels-cross.md Outdated Show resolved Hide resolved

sarah11918 approved these changes Feb 25, 2025

View reviewed changes

Apply suggestions from code review

a94413b

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

github-actions bot previously requested changes Feb 26, 2025

View reviewed changes

ematipico merged commit 5be12b2 into main Feb 26, 2025
16 checks passed

ematipico deleted the feat/expose-apis-for-testing branch February 26, 2025 11:41

astrobot-houston mentioned this pull request Feb 26, 2025

[ci] release #13318

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(astro): Exposes extra APIs for script and testing #12052

feat(astro): Exposes extra APIs for script and testing #12052

Fryuni commented Sep 22, 2024

changeset-bot bot commented Sep 22, 2024 •

edited

Loading

github-actions bot left a comment

ematipico left a comment

matthewp commented Oct 8, 2024

github-actions bot commented Oct 8, 2024

ematipico left a comment

sarah11918 commented Nov 12, 2024

ematipico commented Nov 19, 2024

codspeed-hq bot commented Feb 14, 2025 •

edited

Loading

Fryuni commented Feb 14, 2025

sarah11918 commented Feb 23, 2025

sarah11918 left a comment

sarah11918 left a comment •

edited

Loading

github-actions bot left a comment

feat(astro): Exposes extra APIs for script and testing #12052

feat(astro): Exposes extra APIs for script and testing #12052

Conversation

Fryuni commented Sep 22, 2024

Changes

Testing

Docs

changeset-bot bot commented Sep 22, 2024 • edited Loading

🦋 Changeset detected

github-actions bot left a comment

Choose a reason for hiding this comment

ematipico left a comment

Choose a reason for hiding this comment

matthewp commented Oct 8, 2024

github-actions bot commented Oct 8, 2024

ematipico left a comment

Choose a reason for hiding this comment

sarah11918 commented Nov 12, 2024

ematipico commented Nov 19, 2024

codspeed-hq bot commented Feb 14, 2025 • edited Loading

CodSpeed Performance Report

Merging #12052 will not alter performance

Summary

Fryuni commented Feb 14, 2025

sarah11918 commented Feb 23, 2025

sarah11918 left a comment

Choose a reason for hiding this comment

sarah11918 left a comment • edited Loading

Choose a reason for hiding this comment

github-actions bot left a comment

Choose a reason for hiding this comment

changeset-bot bot commented Sep 22, 2024 •

edited

Loading

codspeed-hq bot commented Feb 14, 2025 •

edited

Loading

sarah11918 left a comment •

edited

Loading