perf!: config and console in one flow to avoid unnecessary charges

Author: Novout

README.md

@@ -73,7 +73,43 @@ generi.init().then(async () => {
 })
 ```
 
-### generi.json
+### Config
+
+#### v1 (generi.json)
+
+```json
+{
+	"silent": false,
+	"commits": "none",
+	"tag": true,
+	"version": true,
+	"push": false,
+	"publish": false,
+	"release": false,
+	"exclude": [" typo"],
+	"prerelease": "beta",
+	"packagePath": "package.json",
+	"lernaPath": "lerna.json"
+}
+```
+
+#### v2 (generi.config.ts)
+
+```ts
+export default {
+  silent: false,
+	commits: "none",
+	tag: true,
+	version: true,
+	push: false,
+	publish: false,
+	release: false,
+	exclude: [" typo"],
+	prerelease: "beta",
+	packagePath: "package.json",
+	lernaPath: "lerna.json"
+};
+```
 
 ##### `silent` Default: `false`
 

generi.config.ts

@@ -0,0 +1,13 @@
+export default {
+  silent: false,
+	commits: "none",
+	tag: true,
+	version: true,
+	push: false,
+	publish: false,
+	release: false,
+	exclude: [" typo"],
+	prerelease: "beta",
+	packagePath: "package.json",
+	lernaPath: "lerna.json"
+};

generi.json

@@ -49,6 +49,7 @@
   },
   "dependencies": {
     "bumpp": "^10.3.1",
+    "c12": "^3.3.1",
     "consola": "^3.4.2",
     "destr": "^2.0.5",
     "execa": "^5.1.1",

package.json

@@ -1,8 +1,6 @@
-import { success } from './console';
 import { commits, isTagCommit, setCommit, getTagCommit } from './git';
-import { Commit, GeneriEmoticon } from './types';
+import { Commit, GeneriEmoticon, GeneriOptions, Root } from './types';
 import { setChangelog } from './utils';
-import { getGeneriConfig } from './generi';
 import conventional from './defines/conventional-commits.json';
 
 const getEmoji = (str: string): string => {
@@ -38,11 +36,10 @@ const setSubHeader = (commit: Commit) => {
 	return '\n### ' + v + '\n\n';
 };
 
-const setBasic = (commit: Commit) => {
-	const generi = getGeneriConfig();
+const setBasic = (commit: Commit, config: GeneriOptions) => {
 	let result: string[] | string;
 
-	if (generi.commits === 'conventional-commits') {
+	if (config.commits === 'conventional-commits') {
 		result = commit.summary
 			.split(/:(.+)/)
 			.filter((part) => part)
@@ -51,11 +48,11 @@ const setBasic = (commit: Commit) => {
 		result = commit.summary;
 	}
 
-	const sha = generi?.repository
-		? ` - [[${commit.sha}](${generi.repository}/commit/${commit.sha})]`
+	const sha = config?.repository
+		? ` - [[${commit.sha}](${config.repository}/commit/${commit.sha})]`
 		: '';
 
-	if (generi.commits === 'conventional-commits') {
+	if (config.commits === 'conventional-commits') {
 		if (!result[0] || !result[1]) return '';
 
 		return (
@@ -87,8 +84,7 @@ export const setActuallyTag = (tag: string) => {
 	});
 };
 
-export const createChangelog = (tag: string) => {
-	const config = getGeneriConfig();
+export const createChangelog = (tag: string, { config, console }: Root) => {
 	const exclude = config?.exclude ?? [' typo'];
 
 	let changelog = getChangelogHeader();
@@ -105,12 +101,12 @@ export const createChangelog = (tag: string) => {
 		if (!isConventionalCommit(commit) && config.commits === 'conventional-commits')
 			return;
 
-		changelog += setBasic(commit);
+		changelog += setBasic(commit, config);
 	});
 
 	setChangelog(changelog);
 
-	setCommit(config.tag ? tag : 'chore(generi): generate changelog.md');
+	setCommit(config.tag ? tag : 'chore(generi): generate changelog.md', true, console);
 
-	success('Generate CHANGELOG.md');
+	console.success('Generate CHANGELOG.md');
 };

pnpm-lock.yaml

@@ -1,51 +1,54 @@
-import { getHeader, error } from '../console';
+import * as log from './log';
 import { isGit, setVersion, setTag, initGit, setCommit, existsTag } from '../git';
 import { createChangelog } from '../changelog';
-import { setGeneriConfig, getGeneriConfig, pkgConfig, lernaConfig } from '../generi';
-import * as log from './log';
-import generiDefault from '../defines/generi-default.json';
-import { getVersion, isChangesForCommit } from '../utils';
+import { getGeneri } from '../generi';
+import { exists, getVersion, isChangesForCommit } from '../utils';
 
 export const setup = () => {
-	const git = isGit();
-	let version = getVersion();
+	getGeneri().then(({ config, console }) => {
+		const git = isGit();
+		let version = getVersion(config);
 
-	getHeader('generi init');
+		console.header('generi init');
 
-	if (getGeneriConfig()) error('<generi.json> exists!');
+		if (exists('./generi.json'))
+			console.warning(
+				'generi.json file is not supported in v2. New format in documentation.'
+			);
 
-	if (!git) initGit();
+		if (!exists('./generi.config.ts') || !exists('./generi.config.js'))
+			console.warning('generi.config was not found, default config loaded.');
 
-	isChangesForCommit(git);
+		if (!git) initGit(console);
 
-	// @ts-expect-error
-	setGeneriConfig(generiDefault);
+		isChangesForCommit(git, console);
 
-	if (!existsTag()) {
-		if (version) setTag(version);
-		else {
-			version = 'v0.1.0';
-			setVersion(version, 'patch');
+		if (!existsTag()) {
+			if (version) setTag(version, console);
+			else {
+				version = 'v0.1.0';
+				setVersion(version, { config, console }, 'patch');
+			}
 		}
-	}
 
-	if (git) {
-		setCommit('chore: generate generi.json');
+		if (git) {
+			setCommit('chore: generate generi.json', true, console);
 
-		log.setup('patch', { header: true, git: { prerelease: undefined } });
+			log.setup('patch', { header: true, git: { prerelease: undefined } });
 
-		return;
-	}
+			return;
+		}
 
-	if (!version) {
-		error(`${pkgConfig} or ${lernaConfig} it was not found.`);
+		if (!version) {
+			console.error(`${config.packagePath} or ${config.lernaPath} it was not found.`);
 
-		return;
-	}
+			return;
+		}
 
-	setVersion(version, 'minor');
+		setVersion(version, { config, console }, 'minor');
 
-	createChangelog(version);
+		createChangelog(version, { config, console });
 
-	setTag(version);
+		setTag(version, console);
+	});
 };

src/changelog.ts

@@ -1,97 +1,98 @@
 import { createChangelog } from '../changelog';
-import { GitNewTag, LogOptions } from '../types';
+import type { GeneriConsole, GitNewTag, GitPrerelease, LogOptions } from '../types';
 import { lastTag, setVersion, setTag, newCommits, isValidTag, pushCommits } from '../git';
-import { success, error, getHeader } from '../console';
-import {
-	existsConfig,
-	getFile,
-	getLernaRoot,
-	getPackageRoot,
-	isPrerelease,
-} from '../utils';
-import { getGeneriConfig } from '../generi';
+import { exists, existsConfig, getFile, getFileRoot, isPrerelease } from '../utils';
+import { getGeneri } from '../generi';
 import { publish } from '../npm';
 import { nextTag } from '../tag';
 import { release } from '../release';
 import { destr } from 'destr';
 
-const validateLog = (tag: GitNewTag) => {
+const validateLog = (tag: GitNewTag, console: GeneriConsole) => {
 	const commits = newCommits();
 
 	if (!existsConfig()) {
-		error('Generi not exists! Use <generi init> command instead.');
-		return false;
+		console.error('Generi not exists! Use <generi init> command instead.');
 	}
 
 	if (commits.length < 1) {
-		error('There are no valid commits to create a new release.');
-		return false;
+		console.error('There are no valid commits to create a new release.');
 	}
 
 	if (!isValidTag(tag)) {
-		error('Invalid Tag. Use patch|prepatch|minor|preminor|major|premajor');
-		return false;
+		console.error('Invalid Tag. Use patch|prepatch|minor|preminor|major|premajor');
 	}
 
 	return true;
 };
 
 export const setup = (tag: GitNewTag, options: LogOptions) => {
-	const config = getGeneriConfig();
+	getGeneri().then(({ config, console }) => {
+		if (!tag) {
+			console.error('Insert valid git tag.');
 
-	if (!tag) {
-		error('Insert valid git tag.');
+			return;
+		}
 
-		return;
-	}
+		if (options.header) console.header(`generi log ${tag}`);
 
-	if (options.header) getHeader(`generi log ${tag}`);
+		if (!validateLog(tag, console)) return;
 
-	if (!validateLog(tag)) return;
+		if (exists('./generi.json'))
+			console.warning(
+				'generi.json file is not supported in v2. New format in documentation.'
+			);
 
-	const lerna = getFile(getLernaRoot());
-	const pkg = getFile(getPackageRoot());
+		if (!exists('./generi.config.ts') || !exists('./generi.config.js'))
+			console.warning('generi.config was not found, default config loaded.');
 
-	if (!lerna && !pkg) {
-		error(
-			'No configuration file was found. If you use a different path for <lerna.json> or <package.json>, look in the documentation on our github for the packagePath or lernaPath option.'
-		);
-	}
+		const lerna = getFile(getFileRoot(config.lernaPath));
+		const pkg = getFile(getFileRoot(config.packagePath));
 
-	let target = lerna ? lerna : pkg;
+		if (!lerna && !pkg) {
+			console.error(
+				'No configuration file was found. If you use a different path for <lerna.json> or <package.json>, look in the documentation on our github for the packagePath or lernaPath option.'
+			);
+		}
 
-	const version = destr<Record<string, any>>(target)?.version;
-	if (!version) error('version in lerna.json or package.json not found!');
-	const last = 'v' + version;
+		let target = lerna ? lerna : pkg;
 
-	const prerelease = isPrerelease(tag)
-		? (options?.git?.prerelease ?? config.prerelease ?? 'beta')
-		: undefined;
+		const version = destr<Record<string, any>>(target)?.version;
+		if (!version) console.error('version in lerna.json or package.json not found!');
+		const last = 'v' + version;
 
-	const next = nextTag({
-		last,
-		tag,
-		prerelease,
-	});
+		const prerelease = isPrerelease(tag)
+			? ((options?.git?.prerelease ?? config.prerelease ?? 'beta') as GitPrerelease)
+			: undefined;
 
-	if (!next) {
-		error('Unable to create a required tag!');
-		return;
-	}
+		const next = nextTag(
+			{
+				last,
+				tag,
+				prerelease,
+			},
+			console
+		);
 
-	if (config.version) {
-		success(`${last} to ${next} (${tag.toUpperCase()})`);
+		if (!next) {
+			console.error('Unable to create a required tag!');
+			return;
+		}
 
-		setVersion(next, tag, prerelease);
-	}
+		if (config.version) {
+			console.success(`${last} to ${next} (${tag.toUpperCase()})`);
 
-	createChangelog(!config.version ? lastTag() : next);
+			setVersion(next, { console, config }, tag, prerelease);
+		}
 
-	if (config.tag && (!options.init || !lerna)) setTag(next);
+		createChangelog(!config.version ? lastTag() : next, { config, console });
 
-	pushCommits();
+		if (config.tag && (!options.init || !lerna)) setTag(next, console);
 
-	if (config?.release) release(next, true);
+		pushCommits({ config, console });
 
-	if (config?.publish) publish(next, lerna, next);
+		if (config?.release) release(next, true, console);
+
+		if (config?.publish) publish(next, console, lerna, next);
+	});
 };