feat(pk-cli): setup workspace project, implement command fetch

Author: patricktree

packages/pk-cli/.eslintrc.cjs

@@ -0,0 +1,15 @@
+const baseEslintConfig = require('@pkerschbaum/config-eslint/eslint-ecma.cjs');
+
+module.exports = {
+  ...baseEslintConfig,
+  parserOptions: {
+    ...baseEslintConfig.parserOptions,
+    tsconfigRootDir: __dirname,
+  },
+  ignorePatterns: [...(baseEslintConfig.ignorePatterns || []), '**/bin/pk-cli.js'],
+  rules: {
+    ...baseEslintConfig.rules,
+    /* allow for this package to use console logs - is a CLI application */
+    'no-console': 'off',
+  },
+};

packages/pk-cli/bin/pk-cli.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+try {
+  await import('../dist/cli.js');
+} catch (err) {
+  if (
+    err.code === 'ERR_MODULE_NOT_FOUND' &&
+    err.message.includes('Cannot find package') &&
+    err.message.includes('dist/cli.js')
+  ) {
+    throw new Error(
+      `Could not find JS code to execute! Build this workspace project to fix this.`,
+      { cause: err },
+    );
+  }
+  throw err;
+}

packages/pk-cli/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@pkerschbaum/pk-cli",
+  "private": true,
+  "type": "module",
+  "exports": {
+    ".": null,
+    "./*": null
+  },
+  "bin": {
+    "pk": "./bin/pk-cli.js"
+  },
+  "files": [
+    "dist/**",
+    "!dist/**/*.d.ts.map"
+  ],
+  "scripts": {
+    "build": "pnpm run internal:compile",
+    "dev": "pnpm run build --watch --preserveWatchOutput",
+    "internal:compile": "tsc -p ./tsconfig.project.json",
+    "lint": "pnpm run lint:file .",
+    "lint:file": "eslint --max-warnings 0",
+    "lint:fix": "pnpm run lint --fix",
+    "nuke": "pnpm run nuke:artifacts && del-cli node_modules",
+    "nuke:artifacts": "del-cli dist \"*.tsbuildinfo\""
+  },
+  "dependencies": {
+    "@commander-js/extra-typings": "^14.0.0",
+    "@pkerschbaum/commons-ecma": "workspace:*",
+    "@pkerschbaum/commons-node": "workspace:*",
+    "@pkerschbaum/runtime-extensions-node": "workspace:*",
+    "commander": "^14.0.0",
+    "tiny-invariant": "^1.3.3"
+  },
+  "devDependencies": {
+    "@types/node": "^20"
+  }
+}

packages/pk-cli/src/cli.ts

@@ -0,0 +1,65 @@
+import '@pkerschbaum/runtime-extensions-node';
+
+import * as commander from '@commander-js/extra-typings';
+import fs from 'node:fs';
+import stream from 'node:stream';
+
+import { fetchCommand } from '#pkg/commands/fetch.js';
+import type { CommandResult } from '#pkg/types.js';
+
+const outputTypes = ['console', 'file'] as const;
+type OutputType = (typeof outputTypes)[number];
+
+const runCommand = new commander.Command('fetch')
+  .addOption(
+    new commander.Option('--output <output-type>')
+      .choices(outputTypes)
+      .makeOptionMandatory()
+      .default('console'),
+  )
+  .addOption(new commander.Option('--include-body'))
+  .addArgument(new commander.Argument('<url>'))
+  .action(async (url, options) => {
+    const commandResult = await fetchCommand({ url, includeBody: options.includeBody });
+    await outputTypeToPrintFn[options.output](commandResult);
+  });
+
+const program = new commander.Command().addCommand(runCommand);
+program.parse();
+
+const outputTypeToPrintFn: Record<
+  OutputType,
+  (commandResults: CommandResult[]) => void | Promise<void>
+> = {
+  console: async (commandResults) => {
+    for (const result of commandResults) {
+      console.log(`\n--- Output for ${result.name} ---`);
+      try {
+        for await (const chunk of result.output) {
+          process.stdout.write(chunk);
+        }
+      } catch (error) {
+        console.error(`Error reading stream for ${result.name}:`, error);
+      }
+      process.stdout.write('\n');
+    }
+  },
+  file: async (commandResults) => {
+    const timestamp = new Date().toISOString().replace(/[-:.]/g, '');
+    for (const [index, result] of commandResults.entries()) {
+      const filePath = `./${timestamp}-${index + 1}-${result.name}.txt`;
+      const fileStream = fs.createWriteStream(filePath, { encoding: 'utf8' });
+      try {
+        await stream.promises.pipeline(result.output, fileStream);
+      } catch (error) {
+        console.error(`Error writing file ${filePath}:`, error);
+        // Clean up partially written file on error
+        try {
+          await fs.promises.unlink(filePath);
+        } catch {
+          // ignore
+        }
+      }
+    }
+  },
+};

packages/pk-cli/src/commands/fetch.ts

@@ -0,0 +1,26 @@
+import { ReadableStream } from 'node:stream/web';
+
+import type { Command, CommandResult } from '#pkg/types.js';
+
+export { fetchCommand };
+
+const fetchCommand = (async (opts: { url: string; includeBody?: boolean }) => {
+  const url = new URL(opts.url);
+  const response = await fetch(url, { redirect: 'manual' });
+
+  let metaOutput = '';
+  metaOutput += `Status: ${response.status}\n`;
+  metaOutput += `Headers: \n`;
+  for (const [name, value] of response.headers) {
+    metaOutput += `  ${name}: ${value}\n`;
+  }
+
+  const metaStream = ReadableStream.from([metaOutput]);
+  const bodyStream = response.body ?? ReadableStream.from([]);
+
+  const result: CommandResult[] = [{ name: 'meta', output: metaStream }];
+  if (opts.includeBody) {
+    result.push({ name: 'body', output: bodyStream });
+  }
+  return result;
+}) satisfies Command;

packages/pk-cli/src/types.ts

@@ -0,0 +1,12 @@
+import type { ReadableStream } from 'node:stream/web';
+
+export type Command = (
+  opts: // eslint-disable-next-line @typescript-eslint/no-explicit-any -- this type is used with `satisfies`, we don't mind about this any here
+  any,
+) => Promise<CommandResult[]>;
+export type CommandResult = {
+  name: string;
+  output: ReadableStream<ChunkType> | globalThis.ReadableStream<ChunkType>;
+};
+
+type ChunkType = string | Uint8Array;

packages/pk-cli/tsconfig.project.json

@@ -0,0 +1,15 @@
+{
+  "extends": "@pkerschbaum/config-typescript/tsconfig.json",
+  "compilerOptions": {
+    /* Modules */
+    "paths": {
+      "#pkg/*": ["./src/*"]
+    },
+    "rootDir": "./src",
+    "types": ["node"],
+
+    /* Emit */
+    "outDir": "./dist"
+  },
+  "include": ["src/**/*"]
+}

packages/pk-cli/turbo.json

@@ -0,0 +1,40 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "extends": ["//"],
+  "tasks": {
+    "build": {
+      "cache": true,
+      "inputs": [
+        "../../platform/config-typescript/tsconfig.json",
+        "src/**",
+        "package.json",
+        "tsconfig.project.json"
+      ],
+      "outputs": ["dist/**", "*.tsbuildinfo"]
+    },
+    "lint": {
+      "cache": true,
+      "inputs": [
+        "../../platform/config-typescript/tsconfig.json",
+        "../../platform/config-eslint/eslint-ecma.cjs",
+        "src/**",
+        ".eslintrc.cjs",
+        "package.json",
+        "tsconfig.project.json"
+      ],
+      "outputs": []
+    },
+    "lint:fix": {
+      "cache": true,
+      "inputs": [
+        "../../platform/config-typescript/tsconfig.json",
+        "../../platform/config-eslint/eslint-ecma.cjs",
+        "src/**",
+        ".eslintrc.cjs",
+        "package.json",
+        "tsconfig.project.json"
+      ],
+      "outputs": ["src/**"]
+    }
+  }
+}

pnpm-lock.yaml

@@ -6,6 +6,7 @@
     { "path": "./packages/eslint-plugin-code-import-patterns/tsconfig.project.json" },
     { "path": "./packages/fetch-favicon/tsconfig.project.json" },
     { "path": "./packages/fetch-sitemap-locations/tsconfig.project.json" },
+    { "path": "./packages/pk-cli/tsconfig.project.json" },
     { "path": "./packages/pk-web-stack-codemods/tsconfig.project.json" },
     { "path": "./packages/pkg-consumption-test/tsconfig.project.json" },
     { "path": "./packages/pkg-management/tsconfig.project.json" },