@kirana-style/parcel-transformer 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,19 @@
-# Temporary Holding Version
+# @kirana-style/parcel-transformer
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Kirana for Parcel (D-070): a transformer that compiles styles in scripts. The stylesheet comes from
+`@kirana-style/postcss`, where a stylesheet says `@kirana;`.
+
+```json
+// .parcelrc
+{
+  "extends": "@parcel/config-default",
+  "transformers": {
+    "*.{js,mjs,jsx,ts,tsx}": ["@kirana-style/parcel-transformer", "..."]
+  }
+}
+```
+
+```json
+// .postcssrc
+{ "plugins": { "@kirana-style/postcss": {} } }
+```

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@kirana-style/parcel-transformer",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Kirana for Parcel: a transformer that compiles styles in scripts, with the stylesheet from @kirana-style/postcss.",
+  "license": "MIT",
+  "author": "The Kirana authors",
+  "homepage": "https://kirana.style",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kirana-style/kirana.git",
+    "directory": "packages/kirana/npm/parcel-transformer"
+  },
+  "bugs": {
+    "url": "https://github.com/kirana-style/kirana/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@kirana-style/compiler": "0.1.0",
+    "@kirana-style/core": "0.1.0",
+    "@kirana-style/postcss": "0.1.0"
+  },
+  "peerDependencies": {
+    "@parcel/plugin": "^2.16.0"
+  },
+  "engines": {
+    "parcel": "^2.16.0"
+  },
+  "files": [
+    "src",
+    "bin",
+    "*.d.ts",
+    "*.css",
+    "README.md",
+    "builders.json",
+    "schemas",
+    "gatsby-node.mjs",
+    "rules",
+    "recommended.json",
+    "strict.json"
+  ]
+}

package/src/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Kirana for Parcel (D-070). Parcel runs transformers in worker processes and offers no step that
+ * sees every module, so the work is split as it is for Turbopack (D-065): this transformer rewrites
+ * styles in each script into class names, and `@kirana-style/postcss` compiles the whole project where the
+ * stylesheet says `@kirana;`. The two sessions agree because a class name is a hash of what it
+ * styles (D-037).
+ *
+ *   .parcelrc   { "extends": "@parcel/config-default",
+ *                 "transformers": { "*.{js,mjs,jsx,ts,tsx}": ["@kirana-style/parcel-transformer", "..."] } }
+ *   .postcssrc  { "plugins": { "@kirana-style/postcss": {} } }
+ */
+import { Driver } from "@kirana-style/compiler";
+import { Transformer } from "@parcel/plugin";
+/** The part of Parcel's mutable asset the transformer uses. */
+export type Asset = {
+    filePath: string;
+    getCode: () => Promise<string>;
+    setCode: (code: string) => void;
+    invalidateOnFileChange: (file: string) => void;
+};
+/** The part of Parcel's plugin logger the transformer uses. */
+export type Logger = {
+    warn: (diagnostic: {
+        message: string;
+    }) => void;
+};
+/** The session for a project root, opened once per worker. */
+export declare function driverFor(root: string): Promise<Driver>;
+/** Compiles one script asset in place; errors fail the build, warnings go to Parcel's logger. */
+export declare function transform({ asset, options, logger, }: {
+    asset: Asset;
+    options: {
+        projectRoot: string;
+    };
+    logger: Logger;
+}): Promise<Asset[]>;
+declare const _default: Transformer<unknown>;
+export default _default;

package/src/index.js

@@ -0,0 +1,49 @@
+/**
+ * Kirana for Parcel (D-070). Parcel runs transformers in worker processes and offers no step that
+ * sees every module, so the work is split as it is for Turbopack (D-065): this transformer rewrites
+ * styles in each script into class names, and `@kirana-style/postcss` compiles the whole project where the
+ * stylesheet says `@kirana;`. The two sessions agree because a class name is a hash of what it
+ * styles (D-037).
+ *
+ *   .parcelrc   { "extends": "@parcel/config-default",
+ *                 "transformers": { "*.{js,mjs,jsx,ts,tsx}": ["@kirana-style/parcel-transformer", "..."] } }
+ *   .postcssrc  { "plugins": { "@kirana-style/postcss": {} } }
+ */
+import { Driver } from "@kirana-style/compiler";
+import { createReporter, shouldCompile } from "@kirana-style/compiler/host";
+import { Transformer } from "@parcel/plugin";
+const drivers = new Map();
+/** The session for a project root, opened once per worker. */
+export function driverFor(root) {
+    let driver = drivers.get(root);
+    if (!driver) {
+        driver = Driver.create({ root });
+        drivers.set(root, driver);
+    }
+    return driver;
+}
+const reporter = createReporter();
+/** Compiles one script asset in place; errors fail the build, warnings go to Parcel's logger. */
+export async function transform({ asset, options, logger, }) {
+    const driver = await driverFor(options.projectRoot);
+    if (driver.configFile)
+        asset.invalidateOnFileChange(driver.configFile);
+    const source = await asset.getCode();
+    if (!shouldCompile(asset.filePath, source, driver.libraries))
+        return [asset];
+    const result = driver.transform(asset.filePath, source);
+    for (const dependency of result.dependencies)
+        asset.invalidateOnFileChange(dependency);
+    reporter.module({
+        warn: (message) => logger.warn({ message }),
+        error: (message) => {
+            throw new Error(message);
+        },
+    }, asset.filePath, source, result.diagnostics);
+    if (result.code !== undefined)
+        asset.setCode(result.code);
+    return [asset];
+}
+export default new Transformer({
+    transform: transform,
+});