@clearlydev/nx-archweave 0.0.0-stage → 0.1.1

package/dist/generators/add-fsd-lite/render.js

@@ -0,0 +1,72 @@
+export function renderAddFsdLiteReport(report) {
+    const lines = [];
+    if (report.aborted) {
+        lines.push('add-fsd-lite aborted — nothing was written.');
+        const refusal = report.appRefusal;
+        if (refusal !== null) {
+            lines.push('');
+            lines.push("  FSD layers live inside the frontend app's source root (e.g. apps/web/src), and no app could be picked:");
+            if (refusal.reason === 'project-not-found') {
+                lines.push(`    --project=${refusal.project} names no project in this workspace.`);
+            }
+            else if (refusal.reason === 'ambiguous-frontend') {
+                lines.push('    more than one frontend app was found — rerun with --project=<one of them>:');
+                for (const name of refusal.candidates)
+                    lines.push(`      - ${name}`);
+            }
+            else if (refusal.reason === 'invalid-project-json') {
+                lines.push(`    a project.json could not be parsed (${refusal.detail}) — fix it, then rerun.`);
+            }
+            else {
+                lines.push('    the workspace has no frontend application — create one (e.g. nx g @nx/react:app) or pass --project.');
+            }
+        }
+        return lines.join('\n');
+    }
+    if (report.dryRun) {
+        lines.push('add-fsd-lite dry-run — no files were written.');
+        lines.push('');
+    }
+    lines.push(`FSD layers (in ${report.project}, ${report.sourceRoot}):`);
+    if (report.layerGuide !== null)
+        lines.push(report.layerGuide);
+    lines.push('');
+    const where = report.eslintPath ?? `${report.project}'s eslint.config.mjs`;
+    switch (report.eslint) {
+        case 'applied':
+            lines.push(`ESLint: archweave/fsd-boundaries (${report.enforcement}) written to ${where}`);
+            break;
+        case 'already-applied':
+            lines.push(`ESLint: archweave/fsd-boundaries already wired in ${where} — no change`);
+            break;
+        case 'degraded-unrecognized':
+            lines.push(`ESLint: ${report.eslintPath === null ? `no ESLint config found for ${report.project}` : `${where} was NOT recognized — left untouched`}.`);
+            lines.push('  Add the rule yourself (then the layer rules are actually enforced):');
+            break;
+        case 'snippet-only':
+            lines.push(`ESLint: report-only (pass --applyEslint to write the rule into ${where}).`);
+            break;
+        case 'not-applied':
+            break;
+    }
+    if (report.snippet !== null)
+        lines.push(report.snippet);
+    if (report.steiger !== null) {
+        const st = report.steiger;
+        lines.push('');
+        lines.push('steiger (official FSD linter, opt-in):');
+        lines.push(`  ${st.configPath}: ${st.config === 'created' ? 'created' : st.config === 'unchanged' ? 'unchanged' : 'kept — an existing config with other content is never replaced'}`);
+        lines.push(st.target === 'added'
+            ? `  target ${'fsd-check'}: added to ${st.targetPath}`
+            : st.target === 'present'
+                ? `  target ${'fsd-check'}: already present in ${st.targetPath}`
+                : '  target fsd-check: NOT added — no parseable project.json / package.json for the app');
+        lines.push(st.dependencies === 'added'
+            ? `  devDependencies: steiger + @feature-sliced/steiger-plugin added to package.json — run \`${st.installCommand}\``
+            : st.dependencies === 'present'
+                ? '  devDependencies: already present'
+                : '  devDependencies: NOT added — the root package.json could not be parsed');
+        lines.push(`  run it with: ${st.runCommand}  (steiger needs Node >= 22.18)`);
+    }
+    return lines.join('\n');
+}

package/dist/generators/add-github-templates/files/en/codeowners/.github/CODEOWNERS.template

@@ -0,0 +1,4 @@
+# CODEOWNERS
+# Define who is required to review changes to matching paths.
+# See https://docs.github.com/articles/about-code-owners
+* @your-team  # TODO: set real owners

package/dist/generators/add-github-templates/files/en/issue/.github/ISSUE_TEMPLATE/bug-report.yml.template

@@ -0,0 +1,28 @@
+name: Bug report
+description: Report a problem so we can reproduce and fix it.
+labels: ["bug"]
+body:
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: Steps to reproduce
+      description: List the exact steps that trigger the problem.
+      placeholder: |
+        1. ...
+        2. ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: What did you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: Actual behavior
+      description: What actually happened instead?
+    validations:
+      required: true

package/dist/generators/add-github-templates/files/en/issue/.github/ISSUE_TEMPLATE/feature-request.yml.template

@@ -0,0 +1,17 @@
+name: Feature request
+description: Propose a new feature or improvement.
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does this solve?
+      description: Describe the problem or limitation you're running into.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: Describe the behavior or implementation you'd like to see.
+    validations:
+      required: true

package/dist/generators/add-github-templates/files/en/pr/.github/PULL_REQUEST_TEMPLATE.md.template

@@ -0,0 +1,12 @@
+## Summary
+
+<!-- What does this PR do and why? -->
+
+## Changes
+
+<!-- List the key changes. -->
+
+## Test plan
+
+- [ ] Tests pass locally
+- [ ] Manually verified the change

package/dist/generators/add-github-templates/files/ko/codeowners/.github/CODEOWNERS.template

@@ -0,0 +1,4 @@
+# CODEOWNERS
+# 아래 경로에 매치되는 변경 사항의 필수 리뷰어를 지정합니다.
+# 참고: https://docs.github.com/articles/about-code-owners
+* @your-team  # TODO: set real owners

package/dist/generators/add-github-templates/files/ko/issue/.github/ISSUE_TEMPLATE/bug-report.yml.template

@@ -0,0 +1,28 @@
+name: 버그 리포트
+description: 재현하고 수정할 수 있도록 문제를 신고합니다.
+labels: ["bug"]
+body:
+  - type: textarea
+    id: reproduction
+    attributes:
+      label: 재현 방법
+      description: 문제를 일으키는 정확한 단계를 나열하세요.
+      placeholder: |
+        1. ...
+        2. ...
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: 예상 동작
+      description: 어떤 동작을 예상했나요?
+    validations:
+      required: true
+  - type: textarea
+    id: actual
+    attributes:
+      label: 실제 동작
+      description: 실제로는 어떤 일이 일어났나요?
+    validations:
+      required: true

package/dist/generators/add-github-templates/files/ko/issue/.github/ISSUE_TEMPLATE/feature-request.yml.template

@@ -0,0 +1,17 @@
+name: 기능 요청
+description: 새로운 기능이나 개선 사항을 제안합니다.
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: 어떤 문제를 해결하나요?
+      description: 지금 겪고 있는 문제나 한계를 설명하세요.
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: 제안하는 해결 방법
+      description: 원하는 동작이나 구현 방향을 설명하세요.
+    validations:
+      required: true

package/dist/generators/add-github-templates/files/ko/pr/.github/PULL_REQUEST_TEMPLATE.md.template

@@ -0,0 +1,12 @@
+## 요약
+
+<!-- 이 PR이 무엇을, 왜 하는지 설명하세요. -->
+
+## 변경 사항
+
+<!-- 주요 변경 내용을 나열하세요. -->
+
+## 테스트 계획
+
+- [ ] 로컬에서 테스트 통과
+- [ ] 변경 사항을 수동으로 확인함

package/dist/generators/add-github-templates/generator.js

@@ -0,0 +1,125 @@
+// src/generators/add-github-templates/generator.ts
+import { join } from "node:path";
+
+// src/generators/shared/dry-run.ts
+function resolveDryRun(options) {
+  return process.env["NX_DRY_RUN"] === "true" || (options.dryRun ?? false);
+}
+
+// src/generators/shared/toolkit-config-file.ts
+var TOOLKIT_CONFIG_PATH = "toolkit.config.json";
+function readToolkitConfigFile(tree) {
+  const raw = tree.read(TOOLKIT_CONFIG_PATH, "utf-8");
+  if (raw === null) return { raw: null, parsed: null };
+  try {
+    const parsed = JSON.parse(raw);
+    return {
+      raw,
+      parsed: typeof parsed === "object" && parsed !== null && !Array.isArray(parsed) ? parsed : null
+    };
+  } catch {
+    return { raw, parsed: null };
+  }
+}
+function readToolkitConfig(tree) {
+  return readToolkitConfigFile(tree).parsed;
+}
+function resolveLocaleOption(option, config) {
+  if (option) return option;
+  const locale = config?.["locale"];
+  return locale === "ko" || locale === "en" ? locale : "en";
+}
+
+// src/generators/shared/template-files.ts
+import { existsSync } from "node:fs";
+import { fileURLToPath } from "node:url";
+import { generateFiles } from "@nx/devkit";
+import { createTree } from "@nx/devkit/testing";
+function generatorFilesDir(generator, fromUrl) {
+  for (const relative of [`../${generator}/files`, `./generators/${generator}/files`]) {
+    const dir = fileURLToPath(new URL(relative, fromUrl));
+    if (existsSync(dir)) return dir;
+  }
+  throw new Error(`The "${generator}" generator's template files are missing next to ${fileURLToPath(fromUrl)}`);
+}
+function renderTemplateFiles(srcFolder, target, substitutions) {
+  const scratch = createTree();
+  const seeded = new Set(scratch.listChanges().map((change) => change.path));
+  generateFiles(scratch, srcFolder, target, substitutions);
+  return scratch.listChanges().flatMap(
+    (change) => change.type === "CREATE" && change.content !== null && !seeded.has(change.path) ? [{ filePath: change.path, content: change.content.toString("utf-8") }] : []
+  ).sort((a, b) => a.filePath.localeCompare(b.filePath));
+}
+
+// src/generators/add-github-templates/render.ts
+var ACTION_LINES = {
+  created: "created",
+  unchanged: "unchanged (already matches the generated version)",
+  skipped: "left as-is (a different file already exists there \u2014 never overwritten)"
+};
+function renderAddGithubTemplatesReport(report) {
+  const lines = [];
+  if (report.files.length === 0) {
+    lines.push("add-github-templates: nothing selected (issue/pr/codeowners all false) \u2014 no files to install.");
+    return lines.join("\n");
+  }
+  if (report.dryRun) {
+    lines.push("add-github-templates dry-run \u2014 no files were written.");
+    lines.push("");
+    for (const file of report.files) {
+      lines.push(`${file.filePath}:`);
+      lines.push(file.content);
+      lines.push("");
+    }
+    lines.push("Effective decision:");
+  }
+  for (const file of report.files) {
+    lines.push(`  ${file.filePath}: ${ACTION_LINES[file.action]}`);
+  }
+  return lines.join("\n");
+}
+
+// src/generators/add-github-templates/generator.ts
+var BUG_REPORT_PATH = ".github/ISSUE_TEMPLATE/bug-report.yml";
+var FEATURE_REQUEST_PATH = ".github/ISSUE_TEMPLATE/feature-request.yml";
+var PULL_REQUEST_TEMPLATE_PATH = ".github/PULL_REQUEST_TEMPLATE.md";
+var CODEOWNERS_PATH = ".github/CODEOWNERS";
+function composeGithubTemplates(groups, locale) {
+  const files = generatorFilesDir("add-github-templates", import.meta.url);
+  return ["issue", "pr", "codeowners"].filter((group) => groups[group]).flatMap((group) => renderTemplateFiles(join(files, locale, group), ".", {}));
+}
+function runAddGithubTemplates(tree, options) {
+  const locale = resolveLocaleOption(options.locale, readToolkitConfig(tree));
+  const plan = composeGithubTemplates(
+    { issue: options.issue ?? false, pr: options.pr ?? true, codeowners: options.codeowners ?? false },
+    locale
+  );
+  const dryRun = options.dryRun ?? false;
+  const files = plan.map(({ filePath, content }) => {
+    const existing = tree.read(filePath, "utf-8");
+    let action;
+    if (existing === null) {
+      action = "created";
+      if (!dryRun) tree.write(filePath, content);
+    } else if (existing === content) {
+      action = "unchanged";
+    } else {
+      action = "skipped";
+    }
+    return { filePath, action, content };
+  });
+  return { dryRun, files };
+}
+async function addGithubTemplatesGenerator(tree, options) {
+  console.log(renderAddGithubTemplatesReport(runAddGithubTemplates(tree, { ...options, dryRun: resolveDryRun(options) })));
+}
+var generator_default = addGithubTemplatesGenerator;
+export {
+  BUG_REPORT_PATH,
+  CODEOWNERS_PATH,
+  FEATURE_REQUEST_PATH,
+  PULL_REQUEST_TEMPLATE_PATH,
+  addGithubTemplatesGenerator,
+  generator_default as default,
+  runAddGithubTemplates
+};

package/dist/generators/add-github-templates/render.js

@@ -0,0 +1,26 @@
+const ACTION_LINES = {
+    created: 'created',
+    unchanged: 'unchanged (already matches the generated version)',
+    skipped: 'left as-is (a different file already exists there — never overwritten)',
+};
+export function renderAddGithubTemplatesReport(report) {
+    const lines = [];
+    if (report.files.length === 0) {
+        lines.push('add-github-templates: nothing selected (issue/pr/codeowners all false) — no files to install.');
+        return lines.join('\n');
+    }
+    if (report.dryRun) {
+        lines.push('add-github-templates dry-run — no files were written.');
+        lines.push('');
+        for (const file of report.files) {
+            lines.push(`${file.filePath}:`);
+            lines.push(file.content);
+            lines.push('');
+        }
+        lines.push('Effective decision:');
+    }
+    for (const file of report.files) {
+        lines.push(`  ${file.filePath}: ${ACTION_LINES[file.action]}`);
+    }
+    return lines.join('\n');
+}