🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
├── public/
│   └── favicon.svg
├── src/
│   ├── layouts/
│   │   └── Layout.astro
│   └── pages/
│       └── index.astro
└── package.json

To learn more about the folder structure of an Astro project, refer to Astro's guide on project structure.

🧞 Commands

All commands are run from the root of the project, from a terminal:

Command	Action
pnpm install	Installs dependencies
pnpm dev	Starts local dev server at localhost:4321
pnpm build	Build your production site to ./dist/
pnpm preview	Preview your build locally, before deploying
pnpm astro ...	Run CLI commands like astro add, astro check
pnpm lint	Run Biome linter
pnpm lint-fix	Run Biome linter and fix issues
pnpm format	Format files using Biome
pnpm check	Run Biome checks with auto-fixes

Additional Packages/Tools added (These commands have already been run)

pnpm astro add tailwind sitemap
pnpm add --save-dev --save-exact @biomejs/biome
pnpm biome init
pnpm add --save-dev lint-staged husky
pnpm exec husky init

Biome Configuration Notes

The project includes specific linting overrides for .svelte, .astro, and .vue files in biome.json. These overrides (disabling useConst and useImportType rules) are necessary due to limited Astro support as of January 1, 2025. See Biome language support for more information.

Husky Configuration Notes

A pre-commit hook has been configured in .husky/pre-commit that runs lint-staged before each commit. The script:

• Runs lint-staged to format and lint staged files using Biome
• Fails the commit if lint-staged reports any errors

echo "🚀 Running pre-commit hook..."
echo "Files to be processed:"
git diff --cached --name-only
echo "---"
pnpm lint-staged
lint_status=$?

if [ $lint_status -ne 0 ]; then
  echo "❌ Lint-staged failed! Please fix the errors and try committing again."
  exit $lint_status
fi

echo "✅ Pre-commit hook completed successfully"

This ensures that all committed code meets the project's formatting and linting standards, with clear visual feedback during the commit process.

Lint-staged Configuration Notes

Lint-staged is configured in package.json to run biome check on all staged files. The configuration uses the --no-errors-on-unmatched flag to prevent errors when processing unsupported file types, and --write to allow automatic fixes where possible.

"lint-staged": {
    "*": ["biome check --no-errors-on-unmatched --write"]
}

This ensures that all staged files are checked and formatted before each commit, with Biome gracefully handling files it doesn't support. The check command combines both formatting and linting in a single pass.

Additional Resources

Astro documentation

Biome documentation

Discord server