@astropub/assist

Astro Assist

Astro Assist is a library of tools to help you develop with Astro.

Usage

Install Astro Assist to your project.

npm install @astropub/assist

Add Astro Assist to your Astro configuration.

// astro.config.js
import assist from '@astropub/assist'

/** @type {import('astro').AstroUserConfig} */
const config = {
  vite: {
    plugins: [
      assist()
    ]
  }
}

export default config

Enjoy!

Features

addAsset

The addAsset method lets you add an asset to the project. The asset will be available in develoment and automatically bundle during build.

Example:

---
// src/pages/kitten.astro
import * as assist from '@astropub/assist'

const kitten = assist.addAsset(Astro.resolve('kitten.jpg'))
---
<img src={kitten} alt="kitten" />

Example in a Component:

---
// src/components/Image.astro
import * as assist from '@astropub/assist'

const src = assist.addAsset(Astro.resolve(Astro.props.src))
---
<img {...Astro.props} {src} />

process

The process method lets you modify an asset that is added to the project. The modified asset will be cached to avoid any repetitive expensive processing.

The process method provides the asset source as a Buffer and the asset details as an Object and returns a new Buffer.

Example:

// astro.config.js
import assist from '@astropub/assist'

/** @type {import('astro').AstroUserConfig} */
const config = {
  vite: {
    plugins: [
      assist({
        async process(buffer, asset) {
          return await doSomethingWith(buffer)
        }
      })
    ]
  }
}

export default config

Example in a Component:

---
import * as assist from '@astropub/assist'

const src = assist.addAsset(Astro.resolve(Astro.props.src), {
  async process(buffer, asset) {
    return await doSomethingWithTheImage(buffer)
  }
})
---
<img {...Astro.props} {src} />