fix: harkfile resolution

Author: sparebytes

bootstrap-hark.js

@@ -1,10 +1,9 @@
 // process.env["HARK_HARD_CORE_TRACE"] = "1";
 require("@babel/register")({
   babelrc: true,
-  extensions: [".js", ".jsx", ".csj", ".mjs", ".ts", ".tsx"],
+  extensions: [".csj", ".es", ".es6", ".js", ".jsx", ".mjs", ".ts", ".tsx"],
   rootMode: "root",
 });
-
 const { cliStartExit } = require("@hark/cli");
 cliStartExit(process.argv.slice(2), {
   context: {

example/bootstrap-hark-example.js

@@ -1,7 +1,7 @@
 // process.env["HARK_HARD_CORE_TRACE"] = "1";
 require("@babel/register")({
   babelrc: true,
-  extensions: [".js", ".jsx", ".csj", ".mjs", ".ts", ".tsx"],
+  extensions: [".csj",".es",".es6",".js",".jsx",".mjs",".ts",".tsx"],
   rootMode: "upward",
   only: [
     function(filepath) {

harkfile.ts

@@ -267,7 +267,7 @@ export class MyPackage extends MyProject {
 
     // babelTranspileSelf
     this.registerTask("babelTranspileSelf", (gc) =>
-      transpile({ watchMode: gc.watchMode, srcDir: `${path}/src`, outDir: `${path}/dist`, comments: true }),
+      transpile({ watchMode: gc.watchMode, srcDir: `${path}/src`, outDir: `${path}/dist/lib`, comments: true }),
     );
 
     // tsconfigData
@@ -277,7 +277,7 @@ export class MyPackage extends MyProject {
         compilerOptions: {
           baseUrl: ".",
           rootDir: "src",
-          outDir: "dist",
+          outDir: "dist/lib",
           isolatedModules: true,
           skipLibCheck: true,
           sourceMap: false,
@@ -286,7 +286,7 @@ export class MyPackage extends MyProject {
           composite: true,
         },
         include: ["src"],
-        exclude: ["**/*.test.tsx?"],
+        exclude: ["**/*.test.ts", "**/*.test.tsx"],
       }),
     );
 
@@ -390,8 +390,8 @@ export const copyPackageJson = ({
       jsonParse(),
       packageJsonClean({
         overwrite: (json) => ({
-          main: "index.js",
-          types: "index.d.ts",
+          main: "./lib/index.js",
+          types: "./lib/index.d.ts",
           ...(gitRepositoryUrl
             ? {
                 repository: {

packages/cli/bin/hark.js

@@ -1,2 +1,9 @@
 #!/usr/bin/env node
-require("../_cli.js");
+"use strict";
+
+// Prefer the local installation of Hark
+if (require("import-local")(__filename)) {
+  // Using local install of Hark
+} else {
+  require("../lib/_cli.js");
+}

packages/cli/package.json

@@ -14,7 +14,8 @@
     "@hark/reporter-verbose": "^0.9.1",
     "@hark/task-group": "^0.9.1",
     "chalk": "3.0.0",
-    "clipanion": "^2.1.6"
+    "clipanion": "^2.1.6",
+    "import-local": "~3.0.2"
   },
   "peerDependencies": {
     "@babel/register": "*",

packages/cli/src/_cli.ts

@@ -4,8 +4,10 @@ const HARK_REGISTER_BABEL = process.env["HARK_REGISTER_BABEL"];
 
 cliStartExit(process.argv.slice(2), {
   registerBabelOptions:
-    HARK_REGISTER_BABEL == null || (HARK_REGISTER_BABEL as any) === true || /^yes|true|1|on$/i.test(HARK_REGISTER_BABEL)
+    HARK_REGISTER_BABEL == null || (HARK_REGISTER_BABEL as any) === true || /^(yes|true|1|on|)$/i.test(HARK_REGISTER_BABEL)
       ? {}
+      : /^\{[\s\S\n]*\}$/i.test(HARK_REGISTER_BABEL)
+      ? JSON.parse(HARK_REGISTER_BABEL)
       : null,
   context: {
     stdin: process.stdin,

packages/cli/src/cli-start.ts

@@ -1,33 +1,56 @@
 import { BaseContext } from "clipanion/lib/advanced";
+import { promises as fsp } from "fs";
 import * as _path from "path";
 import { cliInit } from "./cli-init";
 import { HarkCliStartOptions, HarkfileFunction } from "./models";
-import { existsSync, promises as fsp } from "fs";
 
 export async function cliStart<T>(args: string[], options?: HarkCliStartOptions<T>) {
-  const harkfilePath = _path.resolve(options?.harkfilePath || "./harkfile");
   const cliVars = await cliInit(options);
-  const extensions = [".js", ".jsx", ".csj", ".mjs", ".ts", ".tsx"];
+  const extensions: string[] = options?.registerBabelOptions ?? [
+    //
+    ".ts",
+    ".tsx",
+    ".mjs",
+    ".es",
+    ".es6",
+    ".csj",
+    ".js",
+    ".jsx",
+  ];
+  if (extensions.length === 0) {
+    throw new Error("No extensions given");
+  }
   if (options?.registerBabelOptions != null) {
-    require("@babel/register")({
+    let babelRegister;
+    try {
+      babelRegister = require("@babel/register");
+    } catch (ex) {
+      console.error(
+        "\n\n@hark/cli: PeerDependency for @babel/register not met. Please set HARK_REGISTER_BABEL=0 if this is intended.\n\n",
+      );
+      throw ex;
+    }
+    babelRegister({
       babelrc: true,
       extensions,
       rootMode: "root",
       ...options?.registerBabelOptions,
     });
   }
-  let harkFileFn: HarkfileFunction<any, any>;
 
-  if (await fileExists(harkfilePath, [...extensions, ""])) {
-    try {
-      harkFileFn = (await import(harkfilePath)).default;
-    } catch (ex) {
-      console.error(`\nError while loading harkfile at "${harkfilePath}".\n`);
-      throw ex;
-    }
-  } else {
-    console.error(`\nNo harkfile detected at "${harkfilePath}".\n`);
-    harkFileFn = () => undefined;
+  const harkfilePath = _path.resolve(options?.harkfilePath || "./harkfile");
+  const possibleHarkfiles = [harkfilePath, harkfilePath + _path.sep + "index"].flatMap((p) => extensions.map((e) => p + e));
+  const foundHarkfile = await findFirstExistingFile(possibleHarkfiles);
+  if (foundHarkfile == null) {
+    throw new Error(`\nNo harkfile detected at any of these paths:\n- ` + possibleHarkfiles.join("- \n"));
+  }
+
+  let harkFileFn: HarkfileFunction<any, any>;
+  try {
+    harkFileFn = (await import(foundHarkfile)).default;
+  } catch (ex) {
+    console.error(`\nError while loading harkfile at "${harkfilePath}".\n`);
+    throw ex;
   }
 
   let harkfileContext: any;
@@ -52,12 +75,12 @@ export async function cliStartExit<T>(args: string[], options?: HarkCliStartOpti
   process.exit(code);
 }
 
-async function fileExists(filepath: string, extensions: string[] = [""]) {
-  for (const extension of extensions) {
+async function findFirstExistingFile(filepaths: string[]): Promise<string | undefined> {
+  for (const filepath of filepaths) {
     try {
-      await fsp.access(`${filepath}${extension}`);
-      return true;
+      await fsp.access(filepath);
+      return filepath;
     } catch {}
   }
-  return false;
+  return undefined;
 }

release/package.json

@@ -3,7 +3,8 @@
   "name": "hark-root-monorepo-release",
   "version": "0.0.0",
   "scripts": {
-    "hark": "hark"
+    "hark": "hark",
+    "hark-parent": "node ../bootstrap-hark.js"
   },
   "dependencies": {
     "@babel/core": "^7.8.6",

yarn.lock

@@ -4596,7 +4596,7 @@ import-local@^2.0.0:
     pkg-dir "^3.0.0"
     resolve-cwd "^2.0.0"
 
-import-local@^3.0.2:
+import-local@^3.0.2, import-local@~3.0.2:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/import-local/-/import-local-3.0.2.tgz#a8cfd0431d1de4a2199703d003e3e62364fa6db6"
   integrity sha512-vjL3+w0oulAVZ0hBHnxa/Nm5TAurf9YLQJDhqRZyqb+VKGOB6LU8t9H1Nr5CIo16vh9XfJTOoHwU0B71S557gA==