feat: use cli-tools (#102)

* feat: use cli-tools * feat: use cli-tools * feat: support for deprecated config file name * fix: auto import
junobuild · Feb 23, 2024 · 073e7c5 · 073e7c5
1 parent 9601980
commit 073e7c5
Show file tree

Hide file tree

Showing 6 changed files with 54 additions and 232 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -31,6 +31,7 @@
     "@dfinity/identity": "^1.0.1",
     "@dfinity/principal": "^1.0.1",
     "@junobuild/admin": "^0.0.46",
+    "@junobuild/cli-tools": "^0.0.3",
     "@junobuild/config": "^0.0.2",
     "@junobuild/core-peer": "^0.0.11",
     "@junobuild/utils": "^0.0.19",

diff --git a/src/configs/juno.config.ts b/src/configs/juno.config.ts
@@ -1,84 +1,29 @@
+import {
+  junoConfigExist as junoConfigExistTools,
+  junoConfigFile as junoConfigFileTools,
+  readJunoConfig as readJunoConfigTools,
+  type ConfigFilename
+} from '@junobuild/cli-tools';
 import type {JunoConfig, JunoConfigEnv, JunoConfigFnOrObject} from '@junobuild/config';
 import {nonNullish} from '@junobuild/utils';
-import {existsSync} from 'node:fs';
-import {access, readFile, writeFile} from 'node:fs/promises';
-import {join} from 'node:path';
+import {writeFile} from 'node:fs/promises';
 import {
   TEMPLATE_INIT_PATH,
   TEMPLATE_SATELLITE_CONFIG_FILENAME
 } from '../constants/config.constants';
-import {JUNO_CONFIG_FILENAME, JUNO_JSON} from '../constants/constants';
+import {JUNO_CONFIG_FILENAME} from '../constants/constants';
 import {DEPLOY_DEFAULT_SOURCE} from '../constants/deploy.constants';
 import type {ConfigType, JunoConfigWithSatelliteId} from '../types/config';
 import {readTemplateFile} from '../utils/fs.utils';
-import {nodeRequire} from '../utils/node.utils';
+
+const JUNO_CONFIG_FILE: {filename: ConfigFilename} = {filename: JUNO_CONFIG_FILENAME};
 
 export const junoConfigExist = async (): Promise<boolean> => {
-  try {
-    const {configPath} = junoConfigFile();
-    await access(configPath);
-    return true;
-  } catch (err: unknown) {
-    if (err instanceof Error && 'code' in err && (err as NodeJS.ErrnoException).code === 'ENOENT') {
-      return false;
-    } else {
-      throw err;
-    }
-  }
+  return await junoConfigExistTools(JUNO_CONFIG_FILE);
 };
 
-export const junoConfigFile = (): {configPath: string; configType: ConfigType} => {
-  const junoTs = join(process.cwd(), `${JUNO_CONFIG_FILENAME}.ts`);
-
-  if (existsSync(junoTs)) {
-    return {
-      configPath: junoTs,
-      configType: 'ts'
-    };
-  }
-
-  const junoJs = join(process.cwd(), `${JUNO_CONFIG_FILENAME}.js`);
-
-  if (existsSync(junoJs)) {
-    return {
-      configPath: junoJs,
-      configType: 'js'
-    };
-  }
-
-  const junoMjs = join(process.cwd(), `${JUNO_CONFIG_FILENAME}.mjs`);
-
-  if (existsSync(junoMjs)) {
-    return {
-      configPath: junoMjs,
-      configType: 'js'
-    };
-  }
-
-  const junoCjs = join(process.cwd(), `${JUNO_CONFIG_FILENAME}.cjs`);
-
-  if (existsSync(junoCjs)) {
-    return {
-      configPath: junoCjs,
-      configType: 'js'
-    };
-  }
-
-  // Support for original juno.json file
-  const junoJsonDeprecated = join(process.cwd(), JUNO_JSON);
-
-  if (existsSync(junoJsonDeprecated)) {
-    return {
-      configPath: junoJsonDeprecated,
-      configType: 'json'
-    };
-  }
-
-  return {
-    configPath: join(process.cwd(), `${JUNO_CONFIG_FILENAME}.json`),
-    configType: 'json'
-  };
-};
+export const junoConfigFile = (): {configPath: string; configType: ConfigType} =>
+  junoConfigFileTools(JUNO_CONFIG_FILE);
 
 export const writeJunoConfig = async ({
   config,
@@ -117,23 +62,11 @@ export const writeJunoConfig = async ({
 };
 
 export const readJunoConfig = async (env: JunoConfigEnv): Promise<JunoConfig> => {
-  const {configPath, configType} = junoConfigFile();
-
   const config = (userConfig: JunoConfigFnOrObject): JunoConfig =>
     typeof userConfig === 'function' ? userConfig(env) : userConfig;
 
-  switch (configType) {
-    case 'ts': {
-      const {default: userConfig} = nodeRequire<JunoConfigFnOrObject>(configPath);
-      return config(userConfig);
-    }
-    case 'js': {
-      const {default: userConfig} = await import(configPath);
-      return config(userConfig as JunoConfigFnOrObject);
-    }
-    default: {
-      const buffer = await readFile(configPath);
-      return JSON.parse(buffer.toString('utf-8'));
-    }
-  }
+  return await readJunoConfigTools({
+    ...JUNO_CONFIG_FILE,
+    config
+  });
 };
diff --git a/src/configs/juno.dev.config.ts b/src/configs/juno.dev.config.ts
@@ -1,72 +1,16 @@
-import {existsSync} from 'node:fs';
-import {access} from 'node:fs/promises';
-import {join} from 'node:path';
-import {JUNO_DEV_CONFIG_FILENAME, JUNO_DEV_JSON} from '../constants/constants';
+import type {ConfigFilename} from '@junobuild/cli-tools';
+import {
+  junoConfigExist as junoConfigExistTools,
+  junoConfigFile as junoConfigFileTools
+} from '@junobuild/cli-tools';
+import {JUNO_DEV_CONFIG_FILENAME} from '../constants/constants';
 import type {ConfigType} from '../types/config';
 
+const JUNO_DEV_CONFIG_FILE: {filename: ConfigFilename} = {filename: JUNO_DEV_CONFIG_FILENAME};
+
 export const junoDevConfigExist = async (): Promise<boolean> => {
-  try {
-    const {configPath} = junoDevConfigFile();
-    await access(configPath);
-    return true;
-  } catch (err: unknown) {
-    if (err instanceof Error && 'code' in err && (err as NodeJS.ErrnoException).code === 'ENOENT') {
-      return false;
-    } else {
-      throw err;
-    }
-  }
+  return await junoConfigExistTools(JUNO_DEV_CONFIG_FILE);
 };
 
-export const junoDevConfigFile = (): {configPath: string; configType: ConfigType} => {
-  const junoTs = join(process.cwd(), `${JUNO_DEV_CONFIG_FILENAME}.ts`);
-
-  if (existsSync(junoTs)) {
-    return {
-      configPath: junoTs,
-      configType: 'ts'
-    };
-  }
-
-  const junoJs = join(process.cwd(), `${JUNO_DEV_CONFIG_FILENAME}.js`);
-
-  if (existsSync(junoJs)) {
-    return {
-      configPath: junoJs,
-      configType: 'js'
-    };
-  }
-
-  const junoMjs = join(process.cwd(), `${JUNO_DEV_CONFIG_FILENAME}.mjs`);
-
-  if (existsSync(junoMjs)) {
-    return {
-      configPath: junoMjs,
-      configType: 'js'
-    };
-  }
-
-  const junoCjs = join(process.cwd(), `${JUNO_DEV_CONFIG_FILENAME}.cjs`);
-
-  if (existsSync(junoCjs)) {
-    return {
-      configPath: junoCjs,
-      configType: 'js'
-    };
-  }
-
-  // Support for original juno.json file
-  const junoJsonDeprecated = join(process.cwd(), JUNO_DEV_JSON);
-
-  if (existsSync(junoJsonDeprecated)) {
-    return {
-      configPath: junoJsonDeprecated,
-      configType: 'json'
-    };
-  }
-
-  return {
-    configPath: join(process.cwd(), `${JUNO_DEV_CONFIG_FILENAME}.json`),
-    configType: 'json'
-  };
-};
+export const junoDevConfigFile = (): {configPath: string; configType: ConfigType} =>
+  junoConfigFileTools(JUNO_DEV_CONFIG_FILE);
diff --git a/src/constants/constants.ts b/src/constants/constants.ts
@@ -3,14 +3,6 @@ export const CLI_PROJECT_NAME = process.env.CLI_PROJECT_NAME;
 export const REDIRECT_URL = 'http://localhost:{port}';
 export const JUNO_CONFIG_FILENAME = 'juno.config'; // .json | .js | .mjs | .cjs | .ts
 export const JUNO_DEV_CONFIG_FILENAME = 'juno.dev.config'; // .json | .js | .mjs | .cjs | .ts
-/**
- * @deprecated juno.json is deprecated but still supported. We are now using juno.config.xxx
- */
-export const JUNO_JSON = 'juno.json';
-/**
- * @deprecated juno.dev.json is deprecated but still supported. We are now using juno.dev.config.xxx
- */
-export const JUNO_DEV_JSON = 'juno.dev.json';
 export const DAPP_COLLECTION = '#dapp';
 export const SATELLITE_WASM_NAME = 'satellite';
 export const MISSION_CONTROL_WASM_NAME = 'mission_control';

diff --git a/src/utils/node.utils.ts b/src/utils/node.utils.ts