counterfact 0.41.1 → 0.42.1

package/bin/counterfact.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+/* eslint-disable complexity */
 
 import { readFile } from "node:fs/promises";
 import nodePath from "node:path";
@@ -43,11 +44,66 @@ function padTagLine(tagLine) {
   return `${padding}${tagLine}`;
 }
 
+// eslint-disable-next-line max-statements
+function createWatchMessage(config) {
+  let watchMessage = "";
+
+  switch (true) {
+    case config.watch.routes && config.watch.types: {
+      watchMessage = "Watching for changes";
+
+      break;
+    }
+    case config.watch.routes: {
+      watchMessage = "Watching routes for changes";
+
+      break;
+    }
+    case config.watch.types: {
+      watchMessage = "Watching types for changes";
+
+      break;
+    }
+
+    default: {
+      watchMessage = undefined;
+    }
+  }
+
+  if (!watchMessage) {
+    switch (true) {
+      case config.generate.routes && config.generate.types: {
+        watchMessage = "Generating routes and types";
+
+        break;
+      }
+      case config.generate.routes: {
+        watchMessage = "Generating routes";
+
+        break;
+      }
+      case config.generate.types: {
+        watchMessage = "Generating types";
+
+        break;
+      }
+
+      default: {
+        watchMessage = undefined;
+      }
+    }
+  }
+
+  return watchMessage;
+}
+
 // eslint-disable-next-line max-statements
 async function main(source, destination) {
   debug("executing the main function");
 
   const options = program.opts();
+  // eslint-disable-next-line sonar/process-argv
+  const args = process.argv;
 
   const destinationPath = nodePath
     .join(process.cwd(), destination)
@@ -55,6 +111,14 @@ async function main(source, destination) {
 
   const basePath = nodePath.resolve(destinationPath).replaceAll("\\", "/");
 
+  // If no options are provided, default to all options
+  if (!args.some((argument) => argument.startsWith("-"))) {
+    options.repl = true;
+    options.serve = true;
+    options.watch = true;
+    options.generate = true;
+  }
+
   debug("options: %o", options);
   debug("source: %s", source);
   debug("destination: %s", destination);
@@ -69,12 +133,34 @@ async function main(source, destination) {
 
   const config = {
     basePath,
+
+    generate: {
+      routes:
+        options.generate ||
+        options.generateRoutes ||
+        options.watch ||
+        options.watchRoutes,
+
+      types:
+        options.generate ||
+        options.generateTypes ||
+        options.watch ||
+        options.watchTypes,
+    },
+
     includeSwaggerUi: true,
     openApiPath: source,
     port: options.port,
     proxyEnabled: Boolean(options.proxyUrl),
     proxyUrl: options.proxyUrl,
     routePrefix: options.prefix,
+    startRepl: options.repl,
+    startServer: options.serve,
+
+    watch: {
+      routes: options.watch || options.watchRoutes,
+      types: options.watch || options.watchTypes,
+    },
   };
 
   debug("loading counterfact (%o)", config);
@@ -83,6 +169,8 @@ async function main(source, destination) {
 
   debug("loaded counterfact", config);
 
+  const watchMessage = createWatchMessage(config);
+
   const introduction = [
     "____ ____ _  _ _ _ ___ ____ ____ ____ ____ ____ ___",
     "|___ [__] |__| |\\|  |  |=== |--< |--- |--| |___  | ",
@@ -97,7 +185,9 @@ async function main(source, destination) {
     "🎉 VERSION 1.0 IS COMING! LEARN MORE:",
     "   https://github.com/pmcelhaney/counterfact/issues/823",
     "",
-    "Starting REPL, type .help for more info",
+    watchMessage,
+    config.startServer ? "Starting server" : undefined,
+    config.startRepl ? "Starting REPL, type .help for more info" : undefined,
   ];
 
   process.stdout.write(
@@ -107,9 +197,7 @@ async function main(source, destination) {
   process.stdout.write("\n\n");
 
   debug("starting server");
-
-  await start();
-
+  await start(config);
   debug("started server");
 
   if (openBrowser) {
@@ -130,9 +218,17 @@ program
     "_",
   )
   .argument("[destination]", "path to generated code", ".")
-  .option("--port <number>", "server port number", DEFAULT_PORT)
+  .option("-p, --port <number>", "server port number", DEFAULT_PORT)
   .option("--swagger", "include swagger-ui")
-  .option("--open", "open a browser")
+  .option("-o, --open", "open a browser")
+  .option("-g, --generate", "generate all code for both routes and types")
+  .option("--generate-types", "generate types")
+  .option("--generate-routes", "generate routes")
+  .option("-w, --watch", "generate + watch all code for changes")
+  .option("--watch-types", "generate + watch types for changes")
+  .option("--watch-routes", "generate + watch routes for changes")
+  .option("-s, --serve", "start the server")
+  .option("-r, --repl", "start the REPL")
   .option("--proxy-url <string>", "proxy URL")
   .option(
     "--prefix <string>",

package/dist/server/app.js

@@ -3,8 +3,8 @@ import nodePath from "node:path";
 import { createHttpTerminator } from "http-terminator";
 import yaml from "js-yaml";
 import $RefParser from "json-schema-ref-parser";
+import { CodeGenerator } from "../typescript-generator/code-generator.js";
 import { readFile } from "../util/read-file.js";
-import { CodeGenerator } from "./code-generator.js";
 import { ContextRegistry } from "./context-registry.js";
 import { createKoaApp } from "./create-koa-app.js";
 import { Dispatcher } from "./dispatcher.js";
@@ -34,22 +34,27 @@ export async function counterfact(config) {
     await rm(compiledPathsDirectory, { force: true, recursive: true });
     const registry = new Registry();
     const contextRegistry = new ContextRegistry();
-    const codeGenerator = new CodeGenerator(config.openApiPath, config.basePath);
+    const codeGenerator = new CodeGenerator(config.openApiPath, config.basePath, config.generate);
     const dispatcher = new Dispatcher(registry, contextRegistry, await loadOpenApiDocument(config.openApiPath));
     const transpiler = new Transpiler(nodePath.join(modulesPath, "paths").replaceAll("\\", "/"), compiledPathsDirectory, "commonjs");
     const moduleLoader = new ModuleLoader(compiledPathsDirectory, registry, contextRegistry);
     const middleware = koaMiddleware(dispatcher, config);
     const koaApp = createKoaApp(registry, middleware, config);
     // eslint-disable-next-line max-statements
-    async function start(options = {}) {
-        const http = options.http ?? true;
-        await codeGenerator.watch();
-        await transpiler.watch();
-        await moduleLoader.load();
-        await moduleLoader.watch();
+    async function start(options) {
+        const { generate, startRepl: shouldStartRepl, startServer, watch, } = options;
+        if (generate.routes || generate.types) {
+            await codeGenerator.generate();
+        }
+        if (watch.routes || watch.types) {
+            await codeGenerator.watch();
+        }
         // eslint-disable-next-line @typescript-eslint/init-declarations
         let httpTerminator;
-        if (http) {
+        if (startServer) {
+            await transpiler.watch();
+            await moduleLoader.load();
+            await moduleLoader.watch();
             const server = koaApp.listen({
                 port: config.port,
             });
@@ -57,7 +62,7 @@ export async function counterfact(config) {
                 server,
             });
         }
-        const replServer = startRepl(contextRegistry, config);
+        const replServer = shouldStartRepl && startRepl(contextRegistry, config);
         return {
             replServer,
             async stop() {

package/dist/server/convert-js-extensions-to-cjs.js

@@ -17,7 +17,9 @@ export function convertFileExtensionsToCjs(code) {
                 typeof node.arguments[0].value === "string" &&
                 node.arguments[0].value.startsWith(".")) {
                 // Change the module string from "foo.js" to "foo.cjs"
-                node.arguments[0].value = node.arguments[0].value.replace(/\.js$/u, ".cjs");
+                node.arguments[0].value = node.arguments[0].value.replace(
+                // eslint-disable-next-line prefer-named-capture-group, regexp/no-unused-capturing-group, regexp/prefer-named-capture-group
+                /(\.js|\.ts)?$/u, ".cjs");
             }
             // Continue traversing the AST
             this.traverse(path);

package/dist/{server → typescript-generator}/code-generator.js

@@ -1,24 +1,29 @@
 import { watch } from "chokidar";
-import { generate } from "../typescript-generator/generate.js";
+import { CHOKIDAR_OPTIONS } from "../server/constants.js";
 import { waitForEvent } from "../util/wait-for-event.js";
-import { CHOKIDAR_OPTIONS } from "./constants.js";
+import { generate } from "./generate.js";
 export class CodeGenerator extends EventTarget {
     openapiPath;
     destination;
+    generateOptions;
     watcher;
-    constructor(openApiPath, destination) {
+    constructor(openApiPath, destination, generateOptions) {
         super();
         this.openapiPath = openApiPath;
         this.destination = destination;
+        this.generateOptions = generateOptions;
+    }
+    async generate() {
+        await generate(this.openapiPath, this.destination, this.generateOptions);
     }
     async watch() {
-        await generate(this.openapiPath, this.destination);
         if (this.openapiPath.startsWith("http")) {
             return;
         }
         this.watcher = watch(this.openapiPath, CHOKIDAR_OPTIONS).on("change", () => {
-            // eslint-disable-next-line promise/prefer-await-to-then
-            void generate(this.openapiPath, this.destination).then(() => {
+            void generate(this.openapiPath, this.destination, this.generateOptions)
+                // eslint-disable-next-line promise/prefer-await-to-then
+                .then(() => {
                 this.dispatchEvent(new Event("generate"));
                 return true;
             }, () => {

package/dist/typescript-generator/generate.js

@@ -7,15 +7,9 @@ import { OperationCoder } from "./operation-coder.js";
 import { Repository } from "./repository.js";
 import { Specification } from "./specification.js";
 const debug = createDebug("counterfact:typescript-generator:generate");
-// eslint-disable-next-line max-statements
 async function buildCacheDirectory(destination) {
     const gitignorePath = nodePath.join(destination, ".gitignore");
     const cacheReadmePath = nodePath.join(destination, ".cache", "README.md");
-    debug("removing the cache directory");
-    await fs.rm(nodePath.join(destination, ".cache"), {
-        force: true,
-        recursive: true,
-    });
     debug("ensuring the directory containing .gitgnore exists");
     await ensureDirectoryExists(gitignorePath);
     debug("creating the .gitignore file if it doesn't already exist");
@@ -35,8 +29,8 @@ async function getPathsFromSpecification(specification) {
         return new Set();
     }
 }
-// eslint-disable-next-line max-statements
-export async function generate(source, destination, repository = new Repository()) {
+// eslint-disable-next-line max-statements, max-params
+export async function generate(source, destination, generateOptions, repository = new Repository()) {
     debug("generating code from %s to %s", source, destination);
     debug("initializing the .cache directory");
     await buildCacheDirectory(destination);
@@ -58,6 +52,6 @@ export async function generate(source, destination, repository = new Repository(
         });
     });
     debug("telling the repository to write the files to %s", destination);
-    await repository.writeFiles(destination);
+    await repository.writeFiles(destination, generateOptions);
     debug("finished writing the files");
 }

package/dist/typescript-generator/repository.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-statements */
 import { existsSync } from "node:fs";
 import fs from "node:fs/promises";
 import nodePath, { dirname } from "node:path";
@@ -41,7 +42,7 @@ export class Repository {
         await ensureDirectoryExists(destination);
         return fs.copyFile(sourcePath, destinationPath);
     }
-    async writeFiles(destination) {
+    async writeFiles(destination, { routes, types }) {
         debug("waiting for %i or more scripts to finish before writing files", this.scripts.size);
         await this.finished();
         debug("all %i scripts are finished", this.scripts.size);
@@ -49,7 +50,9 @@ export class Repository {
             const contents = await script.contents();
             const fullPath = nodePath.join(destination, path).replaceAll("\\", "/");
             await ensureDirectoryExists(fullPath);
-            if (path.startsWith("paths") &&
+            const shouldWriteRoutes = routes && path.startsWith("paths");
+            const shouldWriteTypes = types && !path.startsWith("paths");
+            if (shouldWriteRoutes &&
                 (await fs
                     .stat(fullPath)
                     .then((stat) => stat.isFile())
@@ -57,13 +60,17 @@ export class Repository {
                 debug(`not overwriting ${fullPath}\n`);
                 return;
             }
-            debug("about to write", fullPath);
-            await fs.writeFile(fullPath, contents.replaceAll(CONTEXT_FILE_TOKEN, this.findContextPath(destination, path)));
-            debug("did write", fullPath);
+            if (shouldWriteRoutes || shouldWriteTypes) {
+                debug("about to write", fullPath);
+                await fs.writeFile(fullPath, contents.replaceAll(CONTEXT_FILE_TOKEN, this.findContextPath(destination, path)));
+                debug("did write", fullPath);
+            }
         });
         await Promise.all(writeFiles);
         await this.copyCoreFiles(destination);
-        await this.createDefaultContextFile(destination);
+        if (routes) {
+            await this.createDefaultContextFile(destination);
+        }
     }
     async createDefaultContextFile(destination) {
         const contextFilePath = nodePath.join(destination, "paths", "_.context.ts");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "counterfact",
-  "version": "0.41.1",
+  "version": "0.42.1",
   "description": "a library for building a fake REST API for testing",
   "type": "module",
   "main": "./src/server/counterfact.js",
@@ -48,7 +48,7 @@
     "@stryker-mutator/core": "8.2.6",
     "@stryker-mutator/jest-runner": "8.2.6",
     "@stryker-mutator/typescript-checker": "8.2.6",
-    "@swc/core": "1.5.0",
+    "@swc/core": "1.5.5",
     "@swc/jest": "0.2.36",
     "@testing-library/dom": "10.1.0",
     "@types/jest": "29.5.12",
@@ -63,7 +63,7 @@
     "eslint-formatter-github-annotations": "0.1.0",
     "eslint-import-resolver-typescript": "3.6.1",
     "eslint-plugin-etc": "2.0.3",
-    "eslint-plugin-file-progress": "1.3.0",
+    "eslint-plugin-file-progress": "1.4.0",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-jest": "28.5.0",
     "eslint-plugin-jest-dom": "5.4.0",
@@ -73,7 +73,7 @@
     "jest": "29.7.0",
     "node-mocks-http": "1.14.1",
     "nodemon": "3.1.0",
-    "rimraf": "5.0.5",
+    "rimraf": "5.0.7",
     "stryker-cli": "1.0.2",
     "supertest": "7.0.0",
     "using-temporary-files": "2.2.1"
@@ -102,7 +102,7 @@
     "patch-package": "8.0.0",
     "precinct": "12.1.1",
     "prettier": "3.2.5",
-    "recast": "0.23.6",
+    "recast": "0.23.7",
     "typescript": "5.4.5"
   }
 }