@nxtensions/astro

Nx plugin adding first-class support for Astro.

Features

• Nx preset to create a workspace with an Astro application.
• Generators for scaffolding Astro applications and libraries.
• Generators for scaffolding Astro components.
• Cypress tests for Astro applications.
• Executors to run builds, start the Astro development server, start a local static file server to preview built applications, and run diagnostic checks against projects.
• Nx project graph plugin to visualize Astro project dependencies.

Create a new Nx workspace with an Astro application

To create a new Nx workspace with an Astro application you can run:

npx create-nx-workspace@latest --preset=@nxtensions/astro

And follow the instructions.

Note: By default, the above command will use npm as the package manager. You can provide the --pm flag with a value of yarn or pnpm if you prefer using one of those instead.

Add the plugin to an existing Nx workspace

In an existing Nx workspace, install the @nxtensions/astro package in the workspace by running:

# npm
npm install -D @nxtensions/astro

# yarn
yarn add -D @nxtensions/astro

# pnpm
pnpm install -D @nxtensions/astro

Updating the package

To update the package version and run any migrations included in it, use the nx migrate command:

nx migrate @nxtensions/astro@latest

Then follow the intructions provided when the above command finishes running.

For more information on the nx migrate command see https://nx.dev/nx/migrate.

Generate an application

To generate an Astro application run:

nx generate @nxtensions/astro:app my-app

Generate a library

To generate an Astro library run:

nx generate @nxtensions/astro:lib my-lib

Generate a component

To generate an Astro component run:

nx generate @nxtensions/astro:component my-component

Build

To build an Astro application run:

nx build my-app

Form more information on building an Astro application see https://docs.astro.build/en/reference/cli-reference/#astro-build.

Development server

To run an Astro application in development mode run:

nx dev my-app

For more information on the Astro development server see https://docs.astro.build/en/reference/cli-reference/#astro-dev.

Preview

To start a local static file server to serve a previously built Astro application run:

nx preview my-app

For more information on the local static file server for Astro applications see https://docs.astro.build/en/reference/cli-reference/#astro-preview.

Check

To run diagnostic checks (such as type-checking) against a project run:

nx check my-app

For more information see https://docs.astro.build/en/reference/cli-reference/#astro-check.

Sync

Note: This is available for Astro versions equal or greater than 1.8.0.

To generate TypeScript types for all Astro modules for a project, run:

nx sync my-app

For more information see https://docs.astro.build/en/reference/cli-reference/#astro-sync.

Project graph

To visualize the workspace graph of dependencies run:

nx graph

Further reference

• Nx
• Astro