@eik/cli 3.1.9 → 3.1.10

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.1.10](https://github.com/eik-lib/cli/compare/v3.1.9...v3.1.10) (2024-10-18)
+
+
+### Bug Fixes
+
+* output config file name when passed --config ([c078fca](https://github.com/eik-lib/cli/commit/c078fca2bf512f904edf5cb4f9af717f977a3ae9))
+* support --config for file paths ([07a8924](https://github.com/eik-lib/cli/commit/07a892439e3ff22b69d16c8e3ee93a3dd0332eba))
+
 ## [3.1.9](https://github.com/eik-lib/cli/compare/v3.1.8...v3.1.9) (2024-10-14)
 
 

package/classes/version.js

@@ -20,6 +20,7 @@ import { typeSlug } from "../utils/index.js";
  * @property {string[]} [map]
  * @property {string} [out="./.eik"]
  * @property {string | Record<string, string>} files
+ * @property {string} [configFile="eik.json"]
  */
 
 export default class Version {
@@ -37,6 +38,7 @@ export default class Version {
 		map = [],
 		out = "./.eik",
 		files,
+		configFile = "eik.json",
 	}) {
 		const config = new EikConfig(
 			{
@@ -54,6 +56,7 @@ export default class Version {
 
 		this.log = abslog(logger);
 		this.config = config;
+		this.configFile = configFile;
 		this.path = isAbsolute(config.out) ? config.out : join(cwd, config.out);
 		this.level = level;
 	}
@@ -64,7 +67,7 @@ export default class Version {
 	 */
 	async run() {
 		const { name, server, type, version, cwd, out, files, map } = this.config;
-		const { log, level, path } = this;
+		const { log, level, path, configFile } = this;
 		log.debug("Validating input");
 
 		log.debug(`  ==> config object`);
@@ -116,7 +119,7 @@ export default class Version {
 		let localHash;
 		try {
 			makeDirectorySync(path);
-			const eikPathDest = join(path, "eik.json");
+			const eikPathDest = join(path, configFile);
 			const eikJSON = {
 				name,
 				server,

package/commands/publish.js

@@ -47,6 +47,7 @@ export const handler = commandHandler(
 			out,
 			files,
 			type,
+			configFile,
 		} = argv;
 
 		if (type === "map") {
@@ -76,7 +77,7 @@ export const handler = commandHandler(
 		if (!publish) {
 			throw new EikCliError(
 				errors.ERR_VERSION_EXISTS,
-				"Version in eik.json has not changed since last publish, publishing is not necessary",
+				`Version in ${configFile} has not changed since last publish, publishing is not necessary`,
 			);
 		}
 

package/commands/version.js

@@ -34,7 +34,18 @@ export const builder = (yargs) => {
 export const handler = commandHandler(
 	{ command, options: ["server"] },
 	async (argv, log) => {
-		const { level, dryRun, cwd, name, version, server, map, out, files } = argv;
+		const {
+			level,
+			dryRun,
+			cwd,
+			name,
+			version,
+			server,
+			map,
+			out,
+			files,
+			configFile,
+		} = argv;
 
 		const options = {
 			logger: log,
@@ -46,6 +57,7 @@ export const handler = commandHandler(
 			map,
 			out,
 			files,
+			configFile,
 		};
 
 		const newVersion = await new VersionPackage(options).run();
@@ -55,26 +67,30 @@ export const handler = commandHandler(
 				`Dry Run: new version needed, determined new version to be ${newVersion}`,
 			);
 		} else {
-			log.debug(`Writing new version ${newVersion} to eik.json`);
+			log.debug(`Writing new version ${newVersion} to ${configFile}`);
 			// @ts-expect-error
-			await json.writeEik({ version: newVersion }, { cwd });
+			await json.writeEik(
+				{ version: newVersion },
+				{ cwd, filename: configFile },
+			);
 
-			log.debug(`Committing eik.json to local git repository`);
+			log.debug(`Committing ${configFile} to local git repository`);
 			try {
-				execSync(`git add ${join(cwd, "eik.json")}`);
-				log.debug(`  ==> stage: ${join(cwd, "eik.json")}`);
+				execSync(`git add ${configFile}`, { cwd });
+				log.debug(`  ==> stage: ${join(cwd, configFile)}`);
 			} catch (err) {
 				throw new EikCliError(
 					errors.ERR_NOT_GIT,
-					'Failed to stage file "eik.json". Is this directory (or any parent directories) a git repository?',
+					`Failed to stage file "${configFile}". Is this directory (or any parent directories) a git repository?`,
 					err,
 				);
 			}
 
 			try {
 				execSync(
-					`git commit -m "build(assets): version eik.json to v${newVersion} [skip ci]"`,
+					`git commit -m "build(assets): version ${configFile} to v${newVersion} [skip ci]"`,
 					{
+						cwd,
 						env: {
 							GIT_AUTHOR_NAME: "Eik Cli",
 							GIT_AUTHOR_EMAIL: "eik@eik.dev",
@@ -86,11 +102,11 @@ export const handler = commandHandler(
 				);
 				log.debug(`  ==> commit`);
 
-				log.info(`New version ${newVersion} written back to eik.json`);
+				log.info(`New version ${newVersion} written back to ${configFile}`);
 			} catch (err) {
 				throw new EikCliError(
 					errors.ERR_GIT_COMMIT,
-					'Failed to commit changes to file "eik.json".',
+					`Failed to commit changes to file "${configFile}".`,
 					err,
 				);
 			}

package/index.js

@@ -56,7 +56,7 @@ For a more detailed description of commands and options, see the reference docum
 	.options({
 		config: {
 			alias: "c",
-			describe: "Path to Eik configuration file (eik.json or package.json)",
+			describe: "Path to Eik configuration file",
 		},
 		cwd: {
 			describe: "Path to a different working directory than the current",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eik/cli",
-  "version": "3.1.9",
+  "version": "3.1.10",
   "description": "CLI tool for publishing assets to an Eik server",
   "main": "./classes/index.js",
   "types": "./types/classes/index.d.ts",
@@ -21,10 +21,10 @@
   ],
   "scripts": {
     "clean": "rimraf .tap node_modules types",
-    "test": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage",
-    "test:integration": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/integration/**/*.test.mjs",
-    "test:unit": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/*.test.mjs",
-    "test:tasks": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 0 --disable-coverage test/tasks/*.test.mjs",
+    "test": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 60 --disable-coverage",
+    "test:integration": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 60 --disable-coverage test/integration/**/*.test.mjs",
+    "test:unit": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 60 --disable-coverage test/*.test.mjs",
+    "test:tasks": "cross-env HTTP_PORT=0 LOG_LEVEL=fatal tap --timeout 60 --disable-coverage test/tasks/*.test.mjs",
     "lint": "eslint .",
     "lint:fix": "eslint --fix .",
     "format:check": "prettier -c .",

package/types/classes/version.d.ts

@@ -10,14 +10,16 @@
  * @property {string[]} [map]
  * @property {string} [out="./.eik"]
  * @property {string | Record<string, string>} files
+ * @property {string} [configFile="eik.json"]
  */
 export default class Version {
     /**
      * @param {VersionOptions} options
      */
-    constructor({ logger, server, type, name, version, level, cwd, map, out, files, }: VersionOptions);
+    constructor({ logger, server, type, name, version, level, cwd, map, out, files, configFile, }: VersionOptions);
     log: abslog.ValidLogger;
     config: EikConfig;
+    configFile: string;
     path: string;
     level: semver.ReleaseType;
     /**
@@ -37,6 +39,7 @@ export type VersionOptions = {
     map?: string[];
     out?: string;
     files: string | Record<string, string>;
+    configFile?: string;
 };
 import abslog from "abslog";
 import { EikConfig } from "@eik/common";

package/types/utils/defaults.d.ts

@@ -4,12 +4,14 @@
  * @template [T=Record<string, unknown>]
  * @param {any} argv
  * @param {{ command: string; options?: string[] }} opts
- * @returns {import('@eik/common').EikConfig & typeof defaults & T}
+ * @returns {import('@eik/common').EikConfig & typeof defaults & { configFile: string } & T}
  */
 export function getArgsOrDefaults<T = Record<string, unknown>>(argv: any, opts: {
     command: string;
     options?: string[];
-}): import("@eik/common").EikConfig & typeof defaults & T;
+}): import("@eik/common").EikConfig & typeof defaults & {
+    configFile: string;
+} & T;
 declare const defaults: {
     name: string;
     type: string;

package/utils/defaults.js

@@ -19,7 +19,7 @@ const defaults = {
  * @template [T=Record<string, unknown>]
  * @param {any} argv
  * @param {{ command: string; options?: string[] }} opts
- * @returns {import('@eik/common').EikConfig & typeof defaults & T}
+ * @returns {import('@eik/common').EikConfig & typeof defaults & { configFile: string } & T}
  */
 export function getArgsOrDefaults(argv, opts) {
 	let { cwd, config: configPath } = argv;
@@ -27,7 +27,9 @@ export function getArgsOrDefaults(argv, opts) {
 		cwd = process.cwd();
 	}
 
-	let config = {};
+	let config = {
+		configFile: "eik.json",
+	};
 	if (!opts.command.startsWith("init")) {
 		let path = cwd;
 		if (configPath) {
@@ -41,8 +43,10 @@ export function getArgsOrDefaults(argv, opts) {
 				eikConfig = helpers.configStore.findInDirectory(path);
 			} else {
 				eikConfig = helpers.configStore.loadFromPath(path);
+				config.configFile = configPath;
 			}
 			config = {
+				...config,
 				name: eikConfig.name,
 				version: eikConfig.version,
 				type: eikConfig.type,