@forsakringskassan/vite-lib-config 5.6.1 → 5.7.1

package/README.md

@@ -14,6 +14,8 @@ Use `fk-write-config` to write boilerplate configuration files to the repository
 
     fk-write-config
 
+API Extractor is optiona and must be enabled with `--with-api-extractor`.
+
 By default it assumes `vitest` is used as test runner, use `--with-jest` or `--with-vitest` to explicitly set a test runner.
 
 ### Bundled dependencies

package/api-extractor/api-extractor.json

@@ -0,0 +1,41 @@
+{
+    "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+    "mainEntryPointFilePath": "<projectFolder>/temp/types/index.d.ts",
+    "bundledPackages": [],
+    "apiReport": {
+        "enabled": true
+    },
+    "docModel": {
+        "enabled": false
+    },
+    "dtsRollup": {
+        "enabled": true,
+        "untrimmedFilePath": "",
+        "publicTrimmedFilePath": "<projectFolder>/dist/types/index.d.ts"
+    },
+    "tsdocMetadata": {
+        "enabled": false
+    },
+    "newlineKind": "lf",
+    "messages": {
+        "compilerMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+            }
+        },
+        "extractorMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+            },
+            "ae-internal-missing-underscore": {
+                "logLevel": "none",
+                "addToApiReportFile": false
+            }
+        },
+        "tsdocMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+            }
+        }
+    }
+}

package/dist/vite.config.cjs

@@ -11349,9 +11349,18 @@ function defineConfig(config = {}) {
     return fkDefineConfig(mode, config);
   });
 }
-function determineEntrypoint(config, positional, mode) {
-  const isDev = mode === "development" ? true : false;
-  return isDev && positional.length > 0 && !config.fk?.entrypoint;
+function shouldUseCustomEntrypoint(options) {
+  const { config, positional, mode } = options;
+  if (mode !== "development") {
+    return false;
+  }
+  if (process.env.CYPRESS) {
+    return false;
+  }
+  if (positional.length === 0) {
+    return false;
+  }
+  return !config.fk?.entrypoint;
 }
 async function fkDefineConfig(mode, config = {}) {
   const argv = process.argv.slice(2);
@@ -11361,8 +11370,12 @@ async function fkDefineConfig(mode, config = {}) {
   if (mocks.length > 0) {
     defaultConfig.plugins.push((0, import_apimock_express.vitePlugin)(mocks));
   }
-  const userEntrypoint = determineEntrypoint(config, positional, mode);
-  if (userEntrypoint) {
+  const useCustomEntrypoint = shouldUseCustomEntrypoint({
+    config,
+    positional,
+    mode
+  });
+  if (useCustomEntrypoint) {
     const entrypoint = await findEntrypoint(positional[0]);
     config.fk.entrypoint = `/${entrypoint}`;
   }
@@ -11392,7 +11405,7 @@ async function fkDefineConfig(mode, config = {}) {
     "Bundled dependencies:",
     prettyList(allDependencies, (it2) => isBundled(external2, it2))
   );
-  if (userEntrypoint) {
+  if (useCustomEntrypoint) {
     console.log("Entrypoint:", config.fk.entrypoint);
   }
   console.groupEnd();

package/dist/vite.config.mjs

@@ -11343,9 +11343,18 @@ function defineConfig(config = {}) {
     return fkDefineConfig(mode, config);
   });
 }
-function determineEntrypoint(config, positional, mode) {
-  const isDev = mode === "development" ? true : false;
-  return isDev && positional.length > 0 && !config.fk?.entrypoint;
+function shouldUseCustomEntrypoint(options) {
+  const { config, positional, mode } = options;
+  if (mode !== "development") {
+    return false;
+  }
+  if (process.env.CYPRESS) {
+    return false;
+  }
+  if (positional.length === 0) {
+    return false;
+  }
+  return !config.fk?.entrypoint;
 }
 async function fkDefineConfig(mode, config = {}) {
   const argv = process.argv.slice(2);
@@ -11355,8 +11364,12 @@ async function fkDefineConfig(mode, config = {}) {
   if (mocks.length > 0) {
     defaultConfig.plugins.push(apimockPlugin(mocks));
   }
-  const userEntrypoint = determineEntrypoint(config, positional, mode);
-  if (userEntrypoint) {
+  const useCustomEntrypoint = shouldUseCustomEntrypoint({
+    config,
+    positional,
+    mode
+  });
+  if (useCustomEntrypoint) {
     const entrypoint = await findEntrypoint(positional[0]);
     config.fk.entrypoint = `/${entrypoint}`;
   }
@@ -11386,7 +11399,7 @@ async function fkDefineConfig(mode, config = {}) {
     "Bundled dependencies:",
     prettyList(allDependencies, (it2) => isBundled(external2, it2))
   );
-  if (userEntrypoint) {
+  if (useCustomEntrypoint) {
     console.log("Entrypoint:", config.fk.entrypoint);
   }
   console.groupEnd();

package/dist/write-config.mjs

@@ -485,7 +485,6 @@ var init_find_up = __esm({
 });
 
 // src/write-config.ts
-import { existsSync } from "node:fs";
 import fs3 from "node:fs/promises";
 import path3 from "node:path";
 import { styleText } from "node:util";
@@ -601,11 +600,6 @@ function detectTestRunner(flags) {
   }
   return "vitest";
 }
-function detectApiExtractor(cwd) {
-  const haveBaseConfig = existsSync(path3.join(cwd, "api-extractor.json"));
-  const haveLibConfig = existsSync(path3.join(cwd, "api-extractor.lib.json"));
-  return haveBaseConfig || haveLibConfig;
-}
 async function serializeJson(data) {
   const { format, resolveConfig } = await import("prettier");
   const content = JSON.stringify(data, null, 4);
@@ -614,6 +608,77 @@ async function serializeJson(data) {
   const formatted = await format(content, { ...config, filepath });
   return formatted;
 }
+async function generateApiExtractorLib(options) {
+  if (!options.enableApiExtractor) {
+    return null;
+  }
+  const config = {
+    $schema: "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+    extends: "@forsakringskassan/vite-lib-config/api-extractor/api-extractor.json",
+    compiler: {
+      tsconfigFilePath: "<projectFolder>/tsconfig.lib.json"
+    },
+    apiReport: {
+      reportFileName: "<unscopedPackageName>.api.md",
+      reportFolder: options.apiExtractorReportFolder ? `<projectFolder>/${options.apiExtractorReportFolder}` : void 0
+    },
+    docModel: {
+      enabled: true
+    },
+    dtsRollup: {
+      publicTrimmedFilePath: "<projectFolder>/dist/types/index.d.ts"
+    }
+  };
+  return [boilerplate, await serializeJson(config)].join("\n\n");
+}
+async function generateApiExtractorCypress(options) {
+  if (!options.enableApiExtractor) {
+    return null;
+  }
+  if (!options.enablePageobjects) {
+    return null;
+  }
+  const config = {
+    $schema: "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+    extends: "@forsakringskassan/vite-lib-config/api-extractor/api-extractor.json",
+    mainEntryPointFilePath: "<projectFolder>/temp/types/cypress/index.d.ts",
+    compiler: {
+      tsconfigFilePath: "<projectFolder>/tsconfig.pageobjects.json"
+    },
+    apiReport: {
+      reportFileName: "<unscopedPackageName>-cypress.api.md",
+      reportFolder: options.apiExtractorReportFolder ? `<projectFolder>/${options.apiExtractorReportFolder}` : void 0
+    },
+    dtsRollup: {
+      publicTrimmedFilePath: "<projectFolder>/dist/types/cypress.d.ts"
+    }
+  };
+  return [boilerplate, await serializeJson(config)].join("\n\n");
+}
+async function generateApiExtractorSelectors(options) {
+  if (!options.enableApiExtractor) {
+    return null;
+  }
+  if (!options.enableSelectors) {
+    return null;
+  }
+  const config = {
+    $schema: "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+    extends: "@forsakringskassan/vite-lib-config/api-extractor/api-extractor.json",
+    mainEntryPointFilePath: "<projectFolder>/temp/types/selectors/index.d.ts",
+    compiler: {
+      tsconfigFilePath: "<projectFolder>/tsconfig.selectors.json"
+    },
+    apiReport: {
+      reportFileName: "<unscopedPackageName>-selectors.api.md",
+      reportFolder: options.apiExtractorReportFolder ? `<projectFolder>/${options.apiExtractorReportFolder}` : void 0
+    },
+    dtsRollup: {
+      publicTrimmedFilePath: "<projectFolder>/dist/types/selectors.d.ts"
+    }
+  };
+  return [boilerplate, await serializeJson(config)].join("\n\n");
+}
 async function generateTsconfig(options) {
   const { name, enablePageobjects, enableSelectors, testRunner } = options;
   const config = {
@@ -742,6 +807,18 @@ async function writeBuildScripts(cwd, options) {
   );
   await writeJsonFile(cwd, "package.json", `${updated}${trailer}`);
 }
+async function findApiExtractorReportFolder(cwd) {
+  const { findUp: findUp2 } = await Promise.resolve().then(() => (init_find_up(), find_up_exports));
+  const absolutePath = await findUp2("package-lock.json", { cwd });
+  if (!absolutePath) {
+    return null;
+  }
+  const rootDir = path3.dirname(absolutePath);
+  if (path3.resolve(cwd) === rootDir) {
+    return null;
+  }
+  return path3.relative(cwd, path3.join(rootDir, "etc")).replaceAll("\\", "/");
+}
 async function findCypressConfigPath(cwd) {
   const { findUp: findUp2 } = await Promise.resolve().then(() => (init_find_up(), find_up_exports));
   const absolutePath = await findUp2("cypress/tsconfig.json", { cwd });
@@ -750,8 +827,14 @@ async function findCypressConfigPath(cwd) {
   }
   return "cypress/tsconfig.json";
 }
-function isTSConfigFile(filename) {
-  return filename.startsWith("tsconfig.") && filename.endsWith(".json");
+function shouldPrune(filename) {
+  if (filename.startsWith("tsconfig.") && filename.endsWith(".json")) {
+    return true;
+  }
+  if (filename.startsWith("api-extractor.") && filename.endsWith(".json")) {
+    return true;
+  }
+  return false;
 }
 function flagEnabled(value) {
   return value ? styleText("green", "enabled") : styleText("red", "disabled");
@@ -762,6 +845,7 @@ async function run(cwd, argv) {
     console.log("usage: fk-write-config [OPTIONS..]");
     console.log(`
   --help                     Show this help.
+  --with-api-extractor       Use @microsoft/api-extractor.
   --with-jest                Use Jest as test runner.
   --with-vitest              Use Vitest as test runner.
 `);
@@ -775,54 +859,66 @@ async function run(cwd, argv) {
     console.error(`Skipping writing configuration.`);
     return;
   }
+  const apiExtractorReportFolder = await findApiExtractorReportFolder(cwd);
   const cypressConfigPath = await findCypressConfigPath(cwd);
   const testRunner = detectTestRunner(flags);
-  const enableApiExtractor = detectApiExtractor(cwd);
   const options = {
     name: pkg.name,
+    apiExtractorReportFolder,
     cypressConfigPath,
     testRunner,
-    enableApiExtractor,
+    enableApiExtractor: flags.has("--with-api-extractor"),
     enablePageobjects: Boolean(pkg.exports?.["./cypress"]),
     enableSelectors: Boolean(pkg.exports?.["./selectors"])
   };
   const generated = /* @__PURE__ */ new Map([
+    ["api-extractor.lib.json", generateApiExtractorLib(options)],
+    ["api-extractor.cypress.json", generateApiExtractorCypress(options)],
+    [
+      "api-extractor.selectors.json",
+      generateApiExtractorSelectors(options)
+    ],
     ["tsconfig.json", generateTsconfig(options)],
     ["tsconfig.lib.json", generateTsconfigLib(options)],
     ["tsconfig.cypress.json", generateTsconfigCypress(options)],
     ["tsconfig.selectors.json", generateTsconfigSelectors(options)],
     ["tsconfig.pageobjects.json", generateTsconfigPageobjects(options)]
   ]);
-  console.group("Writing TypeScript configuration");
+  console.group("Writing configuration files");
+  console.log("API Extractor:", flagEnabled(options.enableApiExtractor));
+  console.log("Cypress pageobjects:", flagEnabled(options.enablePageobjects));
+  console.log("Selector objects:", flagEnabled(options.enableSelectors));
   console.log("Test runner:", styleText("cyan", testRunner));
   console.log();
   const written = /* @__PURE__ */ new Set();
+  const omitted = /* @__PURE__ */ new Set();
   for (const [filename, promise] of generated) {
     const content = await promise;
     if (content) {
       await writeJsonFile(cwd, filename, content);
       written.add(filename);
+    } else {
+      omitted.add(filename);
     }
   }
   const entries = await fs3.readdir(cwd);
   for (const entry of entries) {
-    if (!isTSConfigFile(entry) || written.has(entry)) {
+    if (written.has(entry)) {
       continue;
     }
-    await fs3.unlink(path3.join(cwd, entry));
-    console.log(entry, "removed");
+    if (omitted.has(entry) || shouldPrune(entry)) {
+      await fs3.unlink(path3.join(cwd, entry));
+      console.log(entry, "removed");
+    }
   }
-  console.groupEnd();
-  console.log();
-  console.group("Writing package.json scripts");
-  console.log("API Extractor:", flagEnabled(options.enableApiExtractor));
-  console.log("Selector objects:", flagEnabled(options.enableSelectors));
-  console.log();
   await writeBuildScripts(cwd, options);
   console.groupEnd();
   console.log();
 }
 export {
+  generateApiExtractorCypress,
+  generateApiExtractorLib,
+  generateApiExtractorSelectors,
   generateTsconfig,
   generateTsconfigCypress,
   generateTsconfigLib,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/vite-lib-config",
-  "version": "5.6.1",
+  "version": "5.7.1",
   "description": "Försäkringskassan toolchain to build libraries with Vite",
   "keywords": [
     "vite"
@@ -18,6 +18,7 @@
       "types": "./dist/index.d.ts",
       "require": "./dist/index.js"
     },
+    "./api-extractor/*.json": "./api-extractor/*.json",
     "./assets/*": "./assets/*",
     "./babel": {
       "types": "./dist/babel.config.d.ts",
@@ -44,6 +45,7 @@
   },
   "files": [
     "*.d.ts",
+    "api-extractor",
     "assets",
     "bin",
     "dist",