dslinter 0.1.2 → 0.1.4

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## v0.1.4
+
+[compare changes](https://github.com/jrmybtlr/DSLinter/compare/v0.1.3...v0.1.4)
+
+## Unreleased
+
+### 🩹 Fixes
+
+- Remove `@/` path aliases from published `src/` so host apps with their own `@/*` Vite alias (Laravel/Inertia, etc.) no longer resolve dslinter UI imports to the wrong tree. Consumers need only the official vite snippet (proxy, react dedupe, `optimizeDeps.exclude`).
+
+## v0.1.3
+
+[compare changes](https://github.com/jrmybtlr/DSLinter/compare/v0.1.2...v0.1.3)
+
 ## v0.1.2
 
 [compare changes](https://github.com/jrmybtlr/DSLinter/compare/v0.1.1...v0.1.2)

package/README.md

@@ -55,7 +55,19 @@ npx dslinter --report --output public/dslint-report.json
 npx dslinter --watch --output public/dslint-report.json
 ```
 
-Set `DSLINT_SERVE_PORT` to override the default scanner port (`7878`). Your Vite config should proxy `/dslint-report.json` and `/events` to that port in `serve` mode (see repo `demo/vite.config.ts`).
+Set `DSLINT_SERVE_PORT` to override the default scanner port (`7878`). Your Vite config should proxy `/dslint-report.json` and `/events` to that port in `serve` mode. Merge `templates/vite.dslinter.snippet.ts` (copied by `npx dslinter init`) or see repo `demo/vite.config.ts` for a linked-workspace example.
+
+### Consumer Vite (Laravel, Inertia, existing `@/*` aliases)
+
+Published `dslinter` source uses **relative imports only** — no `@/components/...` paths inside `node_modules/dslinter/src`. Your app's `@/*` alias (for example Laravel `@/*` → `resources/js/*`) will not hijack dslinter's internal UI imports.
+
+After `npx dslinter init --laravel`, merge only the official snippet into `vite.config.ts`:
+
+- `resolve.dedupe`: `["react", "react-dom"]`
+- `optimizeDeps.exclude`: `["dslinter"]` (source-first package; transpile from `node_modules`)
+- `server.proxy` for `/dslint-report.json` and `/events` → `DSLINT_SERVE_PORT`
+
+You do **not** need alias overrides such as `@/components` → `node_modules/dslinter/src/components`.
 
 ## Styles (Tailwind v4)
 
@@ -76,7 +88,7 @@ Set `DSLINT_SERVE_PORT` to override the default scanner port (`7878`). Your Vite
 
 If the dashboard shows **“Scan snapshot — no live preview”** for a component that appears in the catalog, the scanner found the file but Vite did not load it. Wire previews in three steps:
 
-1. **Scaffold** (optional): `npx dslinter init` → writes `src/playground/buildRegistry.ts`
+1. **Scaffold** (optional): `npx dslinter init` → `src/playground/buildRegistry.ts`; for Inertia/Laravel (`resources/js/…`) use `npx dslinter init --laravel`
 2. **Glob** must cover nested paths, e.g. `import.meta.glob("../components/**/*.{tsx,jsx}", { eager: true })`
 3. **App**: pass `playgroundEntries` and `playgroundJoinSkips` from the registry into `DashboardLayout`
 

package/bin/dslinter.mjs

@@ -12,7 +12,7 @@ import { runReportMode } from "./modes/report.mjs";
 const rawArgs = process.argv.slice(2);
 
 if (rawArgs[0] === "init") {
-  runInitMode({ targetDir: rawArgs[1] });
+  runInitMode({ argv: rawArgs.slice(1) });
   process.exit(0);
 }
 

package/bin/modes/init.mjs

@@ -5,17 +5,38 @@ import { fileURLToPath } from "node:url";
 const packageRoot = join(dirname(fileURLToPath(import.meta.url)), "../..");
 
 /**
- * @param {{ targetDir?: string }} opts
+ * @param {string} targetDir
+ * @returns {"laravel" | "default"}
+ */
+function detectInitLayout(targetDir) {
+  if (existsSync(join(targetDir, "resources", "js"))) return "laravel";
+  return "default";
+}
+
+/**
+ * @param {{ targetDir?: string; layout?: "laravel" | "default"; argv?: string[] }} opts
  */
 export function runInitMode(opts = {}) {
-  const targetDir = resolve(opts.targetDir ?? process.cwd());
-  const registryDir = join(targetDir, "src", "playground");
+  const argv = opts.argv ?? [];
+  const forceLaravel = argv.includes("--laravel") || argv.includes("--resources-js");
+  const targetDir = resolve(
+    opts.targetDir ?? argv.find((a) => !a.startsWith("-")) ?? process.cwd(),
+  );
+  const layout =
+    opts.layout ?? (forceLaravel ? "laravel" : detectInitLayout(targetDir));
+
+  const registryDir =
+    layout === "laravel"
+      ? join(targetDir, "resources", "js", "playground")
+      : join(targetDir, "src", "playground");
   const registryPath = join(registryDir, "buildRegistry.ts");
+  const templateName =
+    layout === "laravel" ? "buildRegistry.laravel.ts" : "buildRegistry.ts";
   const templatePath = join(
     packageRoot,
     "templates",
     "playground",
-    "buildRegistry.ts",
+    templateName,
   );
 
   if (existsSync(registryPath)) {
@@ -46,7 +67,9 @@ export function runInitMode(opts = {}) {
       "",
       "  import { useMemo } from 'react';",
       "  import { DashboardLayout, useWorkspaceReport } from 'dslinter';",
-      "  import { buildPlaygroundEntries } from './playground/buildRegistry';",
+      layout === "laravel"
+        ? "  import { buildPlaygroundEntries } from './playground/buildRegistry'; // adjust relative path from your entry file"
+        : "  import { buildPlaygroundEntries } from './playground/buildRegistry';",
       "",
       "  const dslinterReport = useWorkspaceReport({ reportUrl: '/dslint-report.json', watchUrl: '/events' });",
       "  const playgroundEntries = useMemo(() => buildPlaygroundEntries(dslinterReport.report), [dslinterReport.report]);",
@@ -63,9 +86,14 @@ export function runInitMode(opts = {}) {
       "dslinter init: wrote playground registry",
       `  ${registryPath}`,
       "",
+      `Layout: ${layout}`,
+      "",
       "Next:",
-      "  1. Import buildPlaygroundEntries in your App (see src/playground/README.txt)",
-      "  2. Merge vite.dslinter.snippet.ts into vite.config.ts (proxy + react dedupe)",
+      `  1. Import buildPlaygroundEntries in your App (see ${registryDir}/README.txt)`,
+      "  2. Merge vite.dslinter.snippet.ts into vite.config.ts (proxy, react dedupe, optimizeDeps.exclude)",
+      layout === "laravel"
+        ? "     No extra @ alias remapping is required — dslinter UI uses relative imports."
+        : "     No @ alias overrides needed for dslinter internal UI.",
       "  3. Run npx dslinter . from the project root",
       "",
     ].join("\n"),