@astrojs/compiler 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @astrojs/compiler
 
+## 0.5.0
+
+### Minor Changes
+
+- 901faef: Passes projectRoot to createAstro
+
 ## 0.4.0
 
 ### Minor Changes

package/README.md

@@ -1,5 +1,30 @@
-# @astrojs/compiler
+# Astro Compiler
 
-Experimental WASM compiler for Astro.
+Astro’s [Go](https://golang.org/) + WASM compiler.
 
-This barely works, so probably don't use this package!
+⚠️ Currently in beta!
+
+## Install
+
+```
+npm install @astrojs/compiler
+```
+
+## Usage
+
+_Note: API will change before 1.0! Use at your own discretion._
+
+```js
+import { transform } from '@astrojs/compiler';
+
+const result = await transform(source, {
+  site: 'https://mysite.dev',
+  sourcefile: '/Users/astro/Code/project/src/pages/index.astro',
+  sourcemap: 'both',
+  internalURL: 'astro/internal',
+});
+```
+
+## Contributing
+
+[CONTRIBUTING.md](./CONTRIBUTING.md)

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@astrojs/compiler",
   "type": "module",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "scripts": {
     "build": "tsc -p ."
   },
   "main": "./node/index.js",
   "types": "./shared/types.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/withastro/compiler.git"
+  },
   "exports": {
     ".": {
       "browser": "./browser/index.js",

package/shared/types.d.ts

@@ -8,6 +8,7 @@ export interface TransformOptions {
     sourcefile?: string;
     sourcemap?: boolean | 'inline' | 'external' | 'both';
     as?: 'document' | 'fragment';
+    projectRoot?: string;
     preprocessStyle?: (content: string, attrs: Record<string, string>) => Promise<PreprocessorResult>;
 }
 export interface TransformResult {