@ywal123456/jskim 0.1.0

package/scripts/commands/dev-command.js

@@ -0,0 +1,164 @@
+'use strict';
+
+const { loadConfig } = require('../lib/load-config');
+const { resolveProject } = require('../lib/resolve-project');
+const { createProjectWatcher } = require('../lib/create-project-watcher');
+const { createStaticServer } = require('../lib/create-static-server');
+const { createLiveReload } = require('../lib/create-live-reload');
+const { registerShutdown } = require('./register-shutdown');
+const { toDisplayPath } = require('./path-display');
+const { formatListenError } = require('./serve-errors');
+
+/**
+ * dev コマンドを実行します。
+ * @param {object} options
+ * @param {string|undefined} options.projectName
+ * @param {string} [options.workspaceRoot]
+ * @param {string} [options.usageLine]
+ * @returns {Promise<void>}
+ */
+async function runDevCommand(options = {}) {
+  const workspaceRoot = options.workspaceRoot || process.cwd();
+  const usageLine =
+    options.usageLine || 'npm run dev -- <project-name>';
+
+  const { config } = loadConfig(workspaceRoot);
+  const project = resolveProject({
+    config,
+    workspaceRoot,
+    projectName: options.projectName,
+    commandName: 'dev',
+    usageLine,
+  });
+
+  const host = project.serve.host.trim();
+  const port = project.serve.port;
+  const liveReloadEnabled = project.dev.liveReload;
+  const outputDisplay = toDisplayPath(project.outputDir, workspaceRoot);
+
+  const liveReload = createLiveReload({
+    projectName: project.name,
+    enabled: liveReloadEnabled,
+  });
+
+  const staticServer = createStaticServer({
+    rootDir: project.outputDir,
+    host,
+    port,
+    projectName: project.name,
+    handleInternalRequest: (req, res, meta) =>
+      liveReload.handleRequest(req, res, meta),
+    transformHtml: liveReloadEnabled
+      ? (html) => liveReload.injectHtml(html)
+      : undefined,
+  });
+
+  const projectWatcher = createProjectWatcher(project, {
+    runInitialBuild: true,
+    logChanges: true,
+  });
+
+  // 成功した再ビルドのあとだけ reload（初回はクライアント未接続のため不要）
+  projectWatcher.on('build:success', ({ initial }) => {
+    if (!initial && liveReloadEnabled) {
+      liveReload.broadcastReload();
+    }
+  });
+
+  let stopping = false;
+  let watcherStarted = false;
+
+  async function shutdown() {
+    if (stopping) {
+      return;
+    }
+    stopping = true;
+
+    try {
+      if (watcherStarted) {
+        await projectWatcher.close();
+      }
+    } catch {
+      // 終了時エラーは無視
+    }
+
+    try {
+      liveReload.close();
+    } catch {
+      // 終了時エラーは無視
+    }
+
+    try {
+      await staticServer.stop();
+    } catch {
+      // 終了時エラーは無視
+    }
+
+    console.log('[JSKim] 開発サーバーを停止しました。');
+    process.exit(0);
+  }
+
+  async function failStartup(err) {
+    const message = err && err.message ? err.message : String(err);
+    console.error(message);
+
+    try {
+      if (watcherStarted) {
+        await projectWatcher.close();
+      }
+    } catch {
+      // ignore
+    }
+
+    try {
+      liveReload.close();
+    } catch {
+      // ignore
+    }
+
+    try {
+      await staticServer.stop();
+    } catch {
+      // ignore
+    }
+
+    // cleanup 完了後に終了する。
+    // IPC 接続があると exitCode だけではプロセスが残るため明示終了する。
+    process.exit(1);
+  }
+
+  registerShutdown(shutdown);
+
+  // 初回 build → server → watcher
+  await projectWatcher.start({ watchFiles: false });
+  watcherStarted = true;
+
+  try {
+    await staticServer.start();
+  } catch (err) {
+    await failStartup(
+      formatListenError(err, {
+        projectName: project.name,
+        host,
+        port,
+        kind: '開発',
+      })
+    );
+    return;
+  }
+
+  await projectWatcher.startWatching();
+
+  console.log('[JSKim] 開発サーバーを起動しました。');
+  console.log(`プロジェクト: ${project.name}`);
+  console.log(`ルート: ${outputDisplay}`);
+  console.log(`URL: ${staticServer.url}`);
+  console.log(
+    `ライブリロード: ${liveReloadEnabled ? '有効' : '無効'}`
+  );
+  console.log('終了するには Ctrl+C を押してください。');
+}
+
+module.exports = {
+  runDevCommand,
+};

package/scripts/commands/help-text.js

@@ -0,0 +1,46 @@
+'use strict';
+
+/**
+ * CLI ヘルプ文言を返します。
+ * @returns {string}
+ */
+function getHelpText() {
+  return [
+    'JSKim - Nunjucksを使用した静的HTMLビルド環境',
+    '',
+    '使用方法:',
+    '  jskim <command> <project>',
+    '',
+    'コマンド:',
+    '  build <project>  静的ファイルをビルドします。',
+    '  watch <project>  ファイルの変更を監視して再ビルドします。',
+    '  serve <project>  ビルド済みのファイルを配信します。',
+    '  dev <project>    ビルド・監視・サーバー・ライブリロードを起動します。',
+    '',
+    'オプション:',
+    '  -h, --help       ヘルプを表示します。',
+    '  -v, --version    バージョンを表示します。',
+  ].join('\n');
+}
+
+/**
+ * 不明なコマンド時の案内を返します。
+ * @param {string} command
+ * @returns {string}
+ */
+function getUnknownCommandText(command) {
+  return [
+    `[JSKim] 不明なコマンドです: ${command}`,
+    '',
+    '使用できるコマンド:',
+    '  build <project>',
+    '  watch <project>',
+    '  serve <project>',
+    '  dev <project>',
+  ].join('\n');
+}
+
+module.exports = {
+  getHelpText,
+  getUnknownCommandText,
+};

package/scripts/commands/path-display.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const path = require('node:path');
+
+/**
+ * ワークスペース相対の表示用パスへ変換します。
+ * @param {string} abs
+ * @param {string} workspaceRoot
+ * @returns {string}
+ */
+function toDisplayPath(abs, workspaceRoot) {
+  const rel = path.relative(workspaceRoot, abs);
+  if (!rel || rel.startsWith('..') || path.isAbsolute(rel)) {
+    return abs.split(path.sep).join('/');
+  }
+  return rel.split(path.sep).join('/');
+}
+
+module.exports = {
+  toDisplayPath,
+};

package/scripts/commands/register-shutdown.js

@@ -0,0 +1,32 @@
+'use strict';
+
+/**
+ * CLI の SIGINT/SIGTERM と内部検証用 IPC を登録します。
+ * @param {() => void|Promise<void>} shutdown
+ */
+function registerShutdown(shutdown) {
+  process.on('SIGINT', () => {
+    shutdown();
+  });
+  process.on('SIGTERM', () => {
+    shutdown();
+  });
+
+  if (process.platform === 'win32' && process.stdin.isTTY) {
+    const readline = require('node:readline');
+    readline.createInterface({ input: process.stdin }).on('SIGINT', () => {
+      shutdown();
+    });
+  }
+
+  // 内部検証用 IPC（公開機能ではない。一般利用は Ctrl+C）
+  process.on('message', (msg) => {
+    if (msg === 'jskim:stop') {
+      shutdown();
+    }
+  });
+}
+
+module.exports = {
+  registerShutdown,
+};

package/scripts/commands/serve-command.js

@@ -0,0 +1,88 @@
+'use strict';
+
+const { loadConfig } = require('../lib/load-config');
+const { resolveProject } = require('../lib/resolve-project');
+const { createStaticServer } = require('../lib/create-static-server');
+const { registerShutdown } = require('./register-shutdown');
+const { toDisplayPath } = require('./path-display');
+const { assertOutputDirReady, formatListenError } = require('./serve-errors');
+
+/**
+ * serve コマンドを実行します。
+ * @param {object} options
+ * @param {string|undefined} options.projectName
+ * @param {string} [options.workspaceRoot]
+ * @param {string} [options.usageLine]
+ * @param {string} [options.buildHint]
+ * @returns {Promise<void>}
+ */
+async function runServeCommand(options = {}) {
+  const workspaceRoot = options.workspaceRoot || process.cwd();
+  const usageLine =
+    options.usageLine || 'npm run serve -- <project-name>';
+
+  const { config } = loadConfig(workspaceRoot);
+  const project = resolveProject({
+    config,
+    workspaceRoot,
+    projectName: options.projectName,
+    commandName: 'serve',
+    usageLine,
+  });
+
+  const buildHint =
+    options.buildHint || `npm run build -- ${project.name}`;
+  assertOutputDirReady(project, { buildHint });
+
+  const host = project.serve.host.trim();
+  const port = project.serve.port;
+  const outputDisplay = toDisplayPath(project.outputDir, workspaceRoot);
+
+  const staticServer = createStaticServer({
+    rootDir: project.outputDir,
+    host,
+    port,
+    projectName: project.name,
+  });
+
+  try {
+    await staticServer.start();
+  } catch (err) {
+    throw formatListenError(err, {
+      projectName: project.name,
+      host,
+      port,
+      kind: '静的',
+    });
+  }
+
+  console.log('[JSKim] 静的サーバーを起動しました。');
+  console.log(`プロジェクト: ${project.name}`);
+  console.log(`ルート: ${outputDisplay}`);
+  console.log(`URL: ${staticServer.url}`);
+  console.log('終了するには Ctrl+C を押してください。');
+
+  let stopping = false;
+
+  async function shutdown() {
+    if (stopping) {
+      return;
+    }
+    stopping = true;
+
+    try {
+      await staticServer.stop();
+    } catch {
+      // 終了時の close エラーは無視
+    }
+
+    console.log('[JSKim] 静的サーバーを停止しました。');
+    process.exit(0);
+  }
+
+  registerShutdown(shutdown);
+}
+
+module.exports = {
+  runServeCommand,
+};

package/scripts/commands/serve-errors.js

@@ -0,0 +1,82 @@
+'use strict';
+
+const fs = require('node:fs');
+
+/**
+ * serve / dev 開始前に outputDir の存在を確認します。
+ * @param {object} project
+ * @param {object} [options]
+ * @param {string} [options.buildHint]
+ */
+function assertOutputDirReady(project, options = {}) {
+  const { name, outputDir, outputDirConfig } = project;
+  const buildHint = options.buildHint || `npm run build -- ${name}`;
+
+  if (!outputDir || String(outputDir).trim() === '') {
+    throw new Error(
+      `[JSKim] ビルド出力が見つかりません。\n` +
+        `プロジェクト: ${name}\n` +
+        `出力先: ${outputDirConfig || '(未設定)'}\n\n` +
+        `先にビルドを実行してください:\n` +
+        buildHint
+    );
+  }
+
+  if (!fs.existsSync(outputDir)) {
+    throw new Error(
+      `[JSKim] ビルド出力が見つかりません。\n` +
+        `プロジェクト: ${name}\n` +
+        `出力先: ${outputDirConfig}\n\n` +
+        `先にビルドを実行してください:\n` +
+        buildHint
+    );
+  }
+
+  if (!fs.statSync(outputDir).isDirectory()) {
+    throw new Error(
+      `[JSKim] ビルド出力が見つかりません。\n` +
+        `プロジェクト: ${name}\n` +
+        `出力先: ${outputDirConfig}\n` +
+        `原因: outputDir はディレクトリではありません。\n\n` +
+        `先にビルドを実行してください:\n` +
+        buildHint
+    );
+  }
+}
+
+function formatListenError(err, { projectName, host, port, kind = '静的' }) {
+  const code = err && err.code;
+
+  if (code === 'EADDRINUSE') {
+    return new Error(
+      `[JSKim] ポート ${port} はすでに使用されています。\n` +
+        `プロジェクト: ${projectName}\n` +
+        `ホスト: ${host}\n\n` +
+        `jskim.config.js の serve.port を変更してください。`
+    );
+  }
+
+  if (code === 'EACCES') {
+    return new Error(
+      `[JSKim] ポート ${port} へのバインド権限がありません。\n` +
+        `プロジェクト: ${projectName}\n` +
+        `ホスト: ${host}\n\n` +
+        `別の serve.port を指定するか、権限を確認してください。`
+    );
+  }
+
+  const message = err && err.message ? err.message : String(err);
+  const label = kind === '開発' ? '開発サーバー' : '静的サーバー';
+  return new Error(
+    `[JSKim] ${label}の起動に失敗しました。\n` +
+      `プロジェクト: ${projectName}\n` +
+      `ホスト: ${host}\n` +
+      `ポート: ${port}\n` +
+      `原因: ${message}`
+  );
+}
+
+module.exports = {
+  assertOutputDirReady,
+  formatListenError,
+};

package/scripts/commands/watch-command.js

@@ -0,0 +1,71 @@
+'use strict';
+
+const { loadConfig } = require('../lib/load-config');
+const { resolveProject } = require('../lib/resolve-project');
+const { createProjectWatcher } = require('../lib/create-project-watcher');
+const { registerShutdown } = require('./register-shutdown');
+
+/**
+ * watch コマンドを実行します。
+ * @param {object} options
+ * @param {string|undefined} options.projectName
+ * @param {string} [options.workspaceRoot]
+ * @param {string} [options.usageLine]
+ * @returns {Promise<void>}
+ */
+async function runWatchCommand(options = {}) {
+  const workspaceRoot = options.workspaceRoot || process.cwd();
+  const usageLine =
+    options.usageLine || 'npm run watch -- <project-name>';
+
+  const { config } = loadConfig(workspaceRoot);
+  const project = resolveProject({
+    config,
+    workspaceRoot,
+    projectName: options.projectName,
+    commandName: 'watch',
+    usageLine,
+  });
+
+  const projectWatcher = createProjectWatcher(project, {
+    runInitialBuild: true,
+    logChanges: true,
+  });
+
+  projectWatcher.on('ready', ({ displayPaths, debounceMs }) => {
+    console.log(`[JSKim] プロジェクトを監視しています: ${project.name}`);
+    console.log('パス:');
+    for (const display of displayPaths) {
+      console.log(`- ${display}`);
+    }
+    console.log('');
+    console.log(`Debounce: ${debounceMs}ms`);
+    console.log('終了するには Ctrl+C を押してください。');
+  });
+
+  await projectWatcher.start();
+
+  let stopping = false;
+
+  async function shutdown() {
+    if (stopping) {
+      return;
+    }
+    stopping = true;
+
+    try {
+      await projectWatcher.close();
+    } catch {
+      // 終了時エラーは無視
+    }
+
+    console.log('[JSKim] ウォッチを停止しました。');
+    process.exit(0);
+  }
+
+  registerShutdown(shutdown);
+}
+
+module.exports = {
+  runWatchCommand,
+};

package/scripts/dev.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const { runDevCommand } = require('./commands/dev-command');
+
+runDevCommand({
+  projectName: process.argv[2],
+  workspaceRoot: process.cwd(),
+  usageLine: 'npm run dev -- <project-name>',
+}).catch((err) => {
+  const message = err && err.message ? err.message : String(err);
+  console.error(message);
+  process.exitCode = 1;
+});

package/scripts/lib/build-project.js

@@ -0,0 +1,106 @@
+'use strict';
+
+const path = require('node:path');
+const { loadConfig } = require('./load-config');
+const { resolveProject } = require('./resolve-project');
+const { createNunjucksEnv } = require('./create-nunjucks-env');
+const { cleanOutput } = require('./clean-output');
+const { renderPages } = require('./render-pages');
+const { copyFiles } = require('./copy-files');
+
+/**
+ * 設定を読み込み、プロジェクトを解決してフルビルドを実行します。
+ *
+ * @param {string|undefined} projectName
+ * @param {object} [options]
+ * @param {string} [options.workspaceRoot]
+ * @param {string} [options.commandName='build']
+ * @param {string} [options.usageLine]
+ * @param {string} [options.logTitle='ビルドが完了しました']
+ * @param {boolean} [options.includeOutput=true]
+ * @param {boolean} [options.log=true]
+ * @returns {Promise<object>}
+ */
+async function buildProject(projectName, options = {}) {
+  const workspaceRoot =
+    options.workspaceRoot || process.cwd();
+  const commandName = options.commandName || 'build';
+
+  const { config } = loadConfig(workspaceRoot);
+  const project = resolveProject({
+    config,
+    workspaceRoot,
+    projectName,
+    commandName,
+    usageLine: options.usageLine,
+  });
+
+  return runBuild(project, options);
+}
+
+/**
+ * 解決済みプロジェクトに対して clean → render → copy を実行します。
+ *
+ * @param {object} project
+ * @param {object} [options]
+ * @returns {Promise<object>}
+ */
+async function runBuild(project, options = {}) {
+  const logTitle = options.logTitle || 'ビルドが完了しました';
+  const includeOutput = options.includeOutput !== false;
+  const shouldLog = options.log !== false;
+
+  if (project.build.clean) {
+    await cleanOutput({
+      outputDir: project.outputDir,
+      sourceDir: project.sourceDir,
+      workspaceRoot: project.workspaceRoot,
+      projectName: project.name,
+    });
+  }
+
+  const env = createNunjucksEnv({
+    sourceDir: project.sourceDir,
+    templates: project.templates,
+  });
+
+  const { renderedCount } = await renderPages({ env, project });
+  const { copiedCount } = await copyFiles({ project });
+
+  const outputDisplay = path
+    .relative(project.workspaceRoot, project.outputDir)
+    .split(path.sep)
+    .join('/');
+
+  const result = {
+    project,
+    renderedCount,
+    copiedCount,
+    outputDisplay: outputDisplay || project.outputDir,
+  };
+
+  if (shouldLog) {
+    printBuildResult(result, { logTitle, includeOutput });
+  }
+
+  return result;
+}
+
+function printBuildResult(result, options = {}) {
+  const logTitle = options.logTitle || 'ビルドが完了しました';
+  const includeOutput = options.includeOutput !== false;
+
+  console.log(`[JSKim] ${logTitle}`);
+  console.log(`プロジェクト: ${result.project.name}`);
+  console.log(`レンダリングしたページ数: ${result.renderedCount}`);
+  console.log(`コピーしたファイル数: ${result.copiedCount}`);
+  if (includeOutput) {
+    console.log(`出力先: ${result.outputDisplay}`);
+  }
+}
+
+module.exports = {
+  buildProject,
+  runBuild,
+  printBuildResult,
+};