Merge pull request #138 from fortephp/sage-improvements

Sage plugin improvements

Author: JohnathonKoster

readme.md

@@ -76,6 +76,39 @@ Notes:
 - Array options use repeated flags in CLI (for example: `--blade-inline-intent-elements p --blade-inline-intent-elements svg --blade-inline-intent-elements svg:*`).
 - `bladeDirectiveCaseMap` takes a JSON object string when passed via CLI, but shell quoting is easy to get wrong. Prefer setting it in `.prettierrc`.
 
+## Blade Plugins
+
+Use `bladeSyntaxPlugins` to enable framework-specific or package-specific Blade behavior.
+
+Available plugins:
+
+- `statamic`
+- `log1x/sage-directives`: for improved compatibility with [https://github.com/Log1x/sage-directives](https://github.com/Log1x/sage-directives)
+
+Example:
+
+```json
+{
+  "plugins": [
+    "prettier-plugin-blade",
+    "@prettier/plugin-php"
+  ],
+  "overrides": [
+    {
+      "files": ["*.blade.php"],
+      "options": {
+        "parser": "blade",
+        "bladePhpFormatting": "safe",
+        "bladeSyntaxPlugins": [
+            "statamic",
+            "log1x/sage-directives"
+        ]
+      }
+    }
+  ]
+}
+```
+
 ## PHP Formatting
 
 To format embedded PHP fragments inside Blade, install `@prettier/plugin-php` and include it in `plugins`:

src/index.ts

@@ -76,7 +76,7 @@ const options: Record<string, SupportOption> = {
     type: "string",
     array: true,
     default: [{ value: ["statamic"] }],
-    description: "List of Blade plugins",
+    description: "List of Blade syntax plugins, e.g. statamic or log1x/sage-directives.",
   },
   bladeDirectiveCase: {
     category: "Blade",

src/plugins/index.ts

@@ -1,2 +1,13 @@
-export { statamicPlugin, type BladeSyntaxPlugin } from "./statamic.js";
-export { resolveBladeSyntaxProfile, type BladeSyntaxProfile } from "./runtime.js";
+export { statamicPlugin } from "./statamic.js";
+export { sagePlugin, SAGE_PLUGIN_NAME } from "./sage/index.js";
+export {
+  resolveBladeSyntaxPlugins,
+  resolveBladeSyntaxProfile,
+  type BladeSyntaxProfile,
+} from "./runtime.js";
+export type {
+  BladeSyntaxPlugin,
+  DirectivePhpFormatTemplate,
+  DirectivePhpFormattingContext,
+  DirectivePhpFormattingMode,
+} from "./types.js";

src/plugins/runtime.ts

@@ -1,16 +1,20 @@
-import type { BladeSyntaxPlugin } from "./statamic.js";
+import type { TreeDirectiveDefinition } from "../tree/directive-definitions.js";
+import { SAGE_PLUGIN_NAME, sagePlugin } from "./sage/index.js";
+import type { BladeSyntaxPlugin } from "./types.js";
 import { statamicPlugin } from "./statamic.js";
 
 export interface BladeSyntaxProfile {
   lexerDirectives: string[];
-  treeDirectives: unknown[];
+  treeDirectives: TreeDirectiveDefinition[];
   verbatimStartDirectives: string[];
   verbatimEndDirectives: string[];
 }
 
 const BUILTIN_BLADE_SYNTAX_PLUGINS = new Map<string, BladeSyntaxPlugin>([
+  [SAGE_PLUGIN_NAME, sagePlugin],
   ["statamic", statamicPlugin],
 ]);
+const resolvedBladeSyntaxPluginsCache = new WeakMap<object, BladeSyntaxPlugin[]>();
 
 function isRecord(value: unknown): value is Record<string, unknown> {
   return typeof value === "object" && value !== null;
@@ -66,26 +70,11 @@ function resolveBladeSyntaxPluginEntry(value: unknown): BladeSyntaxPlugin | null
 }
 
 export function resolveBladeSyntaxProfile(options?: unknown): BladeSyntaxProfile {
-  const optionRecord = isRecord(options) ? options : {};
-  const rawPlugins = parseBladeSyntaxPluginTokens(optionRecord.bladeSyntaxPlugins);
-
-  const seenPluginNames = new Set<string>();
-  const resolvedPlugins: BladeSyntaxPlugin[] = [];
-
-  for (const entry of rawPlugins) {
-    const plugin = resolveBladeSyntaxPluginEntry(entry);
-    if (!plugin) continue;
-
-    const key = plugin.name.toLowerCase();
-    if (seenPluginNames.has(key)) continue;
-    seenPluginNames.add(key);
-    resolvedPlugins.push(plugin);
-  }
-
+  const resolvedPlugins = resolveBladeSyntaxPlugins(options);
   const lexerDirectives = new Set<string>();
   const verbatimStartDirectives = new Set<string>();
   const verbatimEndDirectives = new Set<string>();
-  const treeDirectives: unknown[] = [];
+  const treeDirectives: TreeDirectiveDefinition[] = [];
 
   for (const plugin of resolvedPlugins) {
     for (const directive of plugin.lexerDirectives) {
@@ -112,3 +101,29 @@ export function resolveBladeSyntaxProfile(options?: unknown): BladeSyntaxProfile
     verbatimEndDirectives: [...verbatimEndDirectives],
   };
 }
+
+export function resolveBladeSyntaxPlugins(options?: unknown): BladeSyntaxPlugin[] {
+  const optionRecord = isRecord(options) ? options : {};
+  const cached = resolvedBladeSyntaxPluginsCache.get(optionRecord);
+  if (cached) {
+    return cached;
+  }
+
+  const rawPlugins = parseBladeSyntaxPluginTokens(optionRecord.bladeSyntaxPlugins);
+
+  const seenPluginNames = new Set<string>();
+  const resolvedPlugins: BladeSyntaxPlugin[] = [];
+
+  for (const entry of rawPlugins) {
+    const plugin = resolveBladeSyntaxPluginEntry(entry);
+    if (!plugin) continue;
+
+    const key = plugin.name.toLowerCase();
+    if (seenPluginNames.has(key)) continue;
+    seenPluginNames.add(key);
+    resolvedPlugins.push(plugin);
+  }
+
+  resolvedBladeSyntaxPluginsCache.set(optionRecord, resolvedPlugins);
+  return resolvedPlugins;
+}

src/plugins/sage/index.ts

@@ -0,0 +1,15 @@
+import { SAGE_TREE_DIRECTIVES } from "./metadata.js";
+import { getSageDirectivePhpFormatTemplates } from "./print.js";
+import { type BladeSyntaxPlugin } from "../types.js";
+
+export const SAGE_PLUGIN_NAME = "log1x/sage-directives";
+
+export const sagePlugin: BladeSyntaxPlugin = {
+  name: SAGE_PLUGIN_NAME,
+  // The parser tokenizes directives permissively, so Sage only needs tree metadata.
+  lexerDirectives: [],
+  treeDirectives: SAGE_TREE_DIRECTIVES,
+  verbatimStartDirectives: [],
+  verbatimEndDirectives: [],
+  getDirectivePhpFormatTemplates: getSageDirectivePhpFormatTemplates,
+};