@taqueria/plugin-contract-types 0.3.0 → 0.4.0-rc2

package/src/cli-process.ts

@@ -8,111 +8,118 @@ import { typeAliasesFileContent } from './type-aliases-file-content';
 import { typeUtilsFileContent } from './type-utils-file-content';
 
 const fs = {
-    mkdir: promisify(fsRaw.mkdir),
-    copyFile: promisify(fsRaw.copyFile),
-    readdir: promisify(fsRaw.readdir),
-    readFile: promisify(fsRaw.readFile),
-    writeFile: promisify(fsRaw.writeFile),
-    stat: promisify(fsRaw.stat),
-    exists: fsRaw.existsSync,
+	mkdir: promisify(fsRaw.mkdir),
+	copyFile: promisify(fsRaw.copyFile),
+	readdir: promisify(fsRaw.readdir),
+	readFile: promisify(fsRaw.readFile),
+	writeFile: promisify(fsRaw.writeFile),
+	stat: promisify(fsRaw.stat),
+	exists: fsRaw.existsSync,
 };
 
 const getAllFiles = async (rootPath: string, filter: (fullPath: string) => boolean): Promise<string[]> => {
-    const allFiles = [] as string[];
+	const allFiles = [] as string[];
 
-    const getAllFilesRecursive = async (dirPath: string) => {
-        let files = await fs.readdir(dirPath, { withFileTypes: true });
+	const getAllFilesRecursive = async (dirPath: string) => {
+		let files = await fs.readdir(dirPath, { withFileTypes: true });
 
-        for (const f of files) {
-            const subPath = path.resolve(dirPath, f.name);
+		for (const f of files) {
+			const subPath = path.resolve(dirPath, f.name);
 
-            if (f.isDirectory()) {
-                await getAllFilesRecursive(subPath);
-                continue;
-            }
+			if (f.isDirectory()) {
+				await getAllFilesRecursive(subPath);
+				continue;
+			}
 
-            if (!filter(subPath)) {
-                continue;
-            }
+			if (!filter(subPath)) {
+				continue;
+			}
 
-            allFiles.push(subPath);
-        }
-    }
+			allFiles.push(subPath);
+		}
+	};
 
-    await getAllFilesRecursive(rootPath);
-    return allFiles;
-}
+	await getAllFilesRecursive(rootPath);
+	return allFiles;
+};
 
 export const generateContractTypesProcessContractFiles = async ({
-    inputTzContractDirectory,
-    inputFiles,
-    outputTypescriptDirectory,
-    format,
-    typeAliasMode,
+	inputTzContractDirectory,
+	inputFiles,
+	outputTypescriptDirectory,
+	format,
+	typeAliasMode,
 }: {
-    inputTzContractDirectory: string;
-    inputFiles?: string[];
-    outputTypescriptDirectory: string;
-    format: 'tz' | 'json',
-    typeAliasMode: 'local' | 'file' | 'library' | 'simple',
+	inputTzContractDirectory: string;
+	inputFiles?: string[];
+	outputTypescriptDirectory: string;
+	format: 'tz' | 'json';
+	typeAliasMode: 'local' | 'file' | 'library' | 'simple';
 }): Promise<void> => {
-
-    console.log(`Generating Types: ${path.resolve(inputTzContractDirectory)} => ${path.resolve(outputTypescriptDirectory)}`);
-
-    const ext = '.' + format;
-    const filesAll = await getAllFiles(inputTzContractDirectory, x => x.endsWith(ext));
-    const files = inputFiles ? filesAll.filter(f => inputFiles.some(inputFile => f.endsWith(inputFile))) : filesAll;
-
-    console.log(`Contracts Found: ${[``, ...files].join(`\n\t- `)}`);
-
-    const typeAliasImportPath = `@taquito/contract-type-generator`;
-
-    const typeAliasData: TypeAliasData = typeAliasMode === 'local' ? { mode: typeAliasMode, fileContent: typeAliasesFileContent }
-        : typeAliasMode === 'file' ? { mode: typeAliasMode, importPath: `./type-aliases` }
-            : typeAliasMode === 'library' ? { mode: typeAliasMode, importPath: typeAliasImportPath }
-                : { mode: 'simple' };
-
-    if (typeAliasMode === 'file') {
-        // Copy the type alias file
-        await fs.mkdir(outputTypescriptDirectory, { recursive: true });
-        await fs.writeFile(path.join(outputTypescriptDirectory, './type-aliases.ts'), typeAliasesFileContent);
-    }
-
-     // Copy the type utils file
-     const typeUtilsData: TypeUtilsData = { importPath: `./type-utils` };
-     await fs.mkdir(outputTypescriptDirectory, { recursive: true });
-     await fs.writeFile(path.join(outputTypescriptDirectory, './type-utils.ts'), typeUtilsFileContent);
-
-    for (const fullPath of files) {
-        const fileRelativePath = fullPath.replace(path.resolve(inputTzContractDirectory), '');
-        const fileName = fileRelativePath.replace(ext, '');
-        const inputFilePath = path.join(inputTzContractDirectory, fileRelativePath);
-        const typesOutputFilePath = path.join(outputTypescriptDirectory, fileRelativePath.replace(ext, `.types.ts`));
-        const codeContentOutputFilePath = path.join(outputTypescriptDirectory, fileRelativePath.replace(ext, `.code.ts`));
-        const schemaContentOutputFilePath = path.join(outputTypescriptDirectory, fileRelativePath.replace(ext, `.schema.json`));
-        console.log(`Processing ${fileRelativePath}...`);
-
-        try {
-            const contractTypeName = normalizeContractName(fileName);
-
-            const michelsonCode = await fs.readFile(inputFilePath, { encoding: `utf8` });
-
-            const {
-                schemaOutput,
-                typescriptCodeOutput: { typesFileContent, contractCodeFileContent }
-            } = generateContractTypesFromMichelsonCode(michelsonCode, contractTypeName, format, typeAliasData, typeUtilsData);
-
-            // Write output (ensure dir exists)
-            await fs.mkdir(path.dirname(typesOutputFilePath), { recursive: true });
-            await fs.writeFile(typesOutputFilePath, typesFileContent);
-            await fs.writeFile(codeContentOutputFilePath, contractCodeFileContent);
-
-            const debugSchema = false;
-            if(debugSchema){
-                await fs.writeFile(schemaContentOutputFilePath, JSON.stringify(schemaOutput, null, 2));
-            }
-        } catch (err: unknown) {
-            console.error(`❌ Could not process ${fileRelativePath}`, { err });
-        }
-    }
-};
+	console.log(
+		`Generating Types: ${path.resolve(inputTzContractDirectory)} => ${path.resolve(outputTypescriptDirectory)}`,
+	);
+
+	const ext = '.' + format;
+	const filesAll = await getAllFiles(inputTzContractDirectory, x => x.endsWith(ext));
+	const files = inputFiles ? filesAll.filter(f => inputFiles.some(inputFile => f.endsWith(inputFile))) : filesAll;
+
+	console.log(`Contracts Found: ${[``, ...files].join(`\n\t- `)}`);
+
+	const typeAliasImportPath = `@taquito/contract-type-generator`;
+
+	const typeAliasData: TypeAliasData = typeAliasMode === 'local'
+		? { mode: typeAliasMode, fileContent: typeAliasesFileContent }
+		: typeAliasMode === 'file'
+		? { mode: typeAliasMode, importPath: `./type-aliases` }
+		: typeAliasMode === 'library'
+		? { mode: typeAliasMode, importPath: typeAliasImportPath }
+		: { mode: 'simple' };
+
+	if (typeAliasMode === 'file') {
+		// Copy the type alias file
+		await fs.mkdir(outputTypescriptDirectory, { recursive: true });
+		await fs.writeFile(path.join(outputTypescriptDirectory, './type-aliases.ts'), typeAliasesFileContent);
+	}
+
+	// Copy the type utils file
+	const typeUtilsData: TypeUtilsData = { importPath: `./type-utils` };
+	await fs.mkdir(outputTypescriptDirectory, { recursive: true });
+	await fs.writeFile(path.join(outputTypescriptDirectory, './type-utils.ts'), typeUtilsFileContent);
+
+	for (const fullPath of files) {
+		const fileRelativePath = fullPath.replace(path.resolve(inputTzContractDirectory), '');
+		const fileName = fileRelativePath.replace(ext, '');
+		const inputFilePath = path.join(inputTzContractDirectory, fileRelativePath);
+		const typesOutputFilePath = path.join(outputTypescriptDirectory, fileRelativePath.replace(ext, `.types.ts`));
+		const codeContentOutputFilePath = path.join(outputTypescriptDirectory, fileRelativePath.replace(ext, `.code.ts`));
+		const schemaContentOutputFilePath = path.join(
+			outputTypescriptDirectory,
+			fileRelativePath.replace(ext, `.schema.json`),
+		);
+		console.log(`Processing ${fileRelativePath}...`);
+
+		try {
+			const contractTypeName = normalizeContractName(fileName);
+
+			const michelsonCode = await fs.readFile(inputFilePath, { encoding: `utf8` });
+
+			const {
+				schemaOutput,
+				typescriptCodeOutput: { typesFileContent, contractCodeFileContent },
+			} = generateContractTypesFromMichelsonCode(michelsonCode, contractTypeName, format, typeAliasData, typeUtilsData);
+
+			// Write output (ensure dir exists)
+			await fs.mkdir(path.dirname(typesOutputFilePath), { recursive: true });
+			await fs.writeFile(typesOutputFilePath, typesFileContent);
+			await fs.writeFile(codeContentOutputFilePath, contractCodeFileContent);
+
+			const debugSchema = false;
+			if (debugSchema) {
+				await fs.writeFile(schemaContentOutputFilePath, JSON.stringify(schemaOutput, null, 2));
+			}
+		} catch (err: unknown) {
+			console.error(`❌ Could not process ${fileRelativePath}`, { err });
+		}
+	}
+};

package/src/cli.ts

@@ -1,29 +1,40 @@
 import { generateContractTypesProcessContractFiles } from './cli-process';
 
 export const run = async (): Promise<void> => {
-    const argv = process.argv;
-    const argsGenerateFile = argv.some(a => a.startsWith(`--g`)) ? argv.slice(argv.findIndex(a => a.startsWith(`--g`)) + 1) : undefined;
-    const argsUseJson = argv.some(a => a.startsWith(`--json`)) ? true : false;
-    const argsTypeAliasMode = argv.some(a => a.startsWith(`--types`)) ? argv.slice(argv.findIndex(a => a.startsWith(`--types`)) + 1) : undefined;
+	const argv = process.argv;
+	const argsGenerateFile = argv.some(a => a.startsWith(`--g`))
+		? argv.slice(argv.findIndex(a => a.startsWith(`--g`)) + 1)
+		: undefined;
+	const argsUseJson = argv.some(a => a.startsWith(`--json`)) ? true : false;
+	const argsTypeAliasMode = argv.some(a => a.startsWith(`--types`))
+		? argv.slice(argv.findIndex(a => a.startsWith(`--types`)) + 1)
+		: undefined;
 
-    console.log(`contract-type-generator\n\t${argv.join(`\n\t`)}`);
+	console.log(`contract-type-generator\n\t${argv.join(`\n\t`)}`);
 
-    if (argsGenerateFile) {
-        const [inputTzContractDirectory, outputTypescriptDirectory] = argsGenerateFile;
-        const format = argsUseJson ? 'json' : 'tz';
-        const [typeAliasModeArg] = argsTypeAliasMode ?? [];
+	if (argsGenerateFile) {
+		const [inputTzContractDirectory, outputTypescriptDirectory] = argsGenerateFile;
+		const format = argsUseJson ? 'json' : 'tz';
+		const [typeAliasModeArg] = argsTypeAliasMode ?? [];
 
-        // Library is default mode
-        const typeAliasMode =
-            typeAliasModeArg === 'local' ? 'local'
-                : typeAliasModeArg === 'file' ? 'file'
-                    : typeAliasModeArg === 'simple' ? 'simple'
-                        : 'library';
-        await generateContractTypesProcessContractFiles({ inputTzContractDirectory, outputTypescriptDirectory, format, typeAliasMode });
-        return;
-    }
+		// Library is default mode
+		const typeAliasMode = typeAliasModeArg === 'local'
+			? 'local'
+			: typeAliasModeArg === 'file'
+			? 'file'
+			: typeAliasModeArg === 'simple'
+			? 'simple'
+			: 'library';
+		await generateContractTypesProcessContractFiles({
+			inputTzContractDirectory,
+			outputTypescriptDirectory,
+			format,
+			typeAliasMode,
+		});
+		return;
+	}
 
-    console.log(`
+	console.log(`
 contract-type-generator
 
 Example usages:

package/src/generator/common.ts

@@ -1,19 +1,18 @@
-
 export class GenerateApiError implements Error {
-    name = `GenerateApiError`;
-    constructor(public message: string, readonly data: unknown) {
-        console.error(`❌ GenerateApiError: ${message}`, data);
-    }
+	name = `GenerateApiError`;
+	constructor(public message: string, readonly data: unknown) {
+		console.error(`❌ GenerateApiError: ${message}`, data);
+	}
 }
 
 export const assertExhaustive = (value: never, message: string): void => {
-    console.error(message, { value });
+	console.error(message, { value });
 };
 
 export const reduceFlatMap = <T>(out: T[], x: T[]): T[] => {
-    out.push(...x);
-    return out;
-}
+	out.push(...x);
+	return out;
+};
 
 // const reduceFlatMapTest = () => {
 //     const items = [['a'], ['b']];

package/src/generator/contract-name.ts

@@ -1,6 +1,7 @@
-export const normalizeContractName = (text: string) => text
-    .replace(/[^A-Za-z0-9]/g, '_')
-    .split("_")
-    .filter(x => x)
-    .map(x => x[0].toUpperCase() + x.substring(1))
-    .join('');
+export const normalizeContractName = (text: string) =>
+	text
+		.replace(/[^A-Za-z0-9]/g, '_')
+		.split('_')
+		.filter(x => x)
+		.map(x => x[0].toUpperCase() + x.substring(1))
+		.join('');