@taqueria/plugin-ligo 0.27.2-alpha → 0.27.2-rc

package/README.md

@@ -4,7 +4,7 @@ The LIGO plugin provides tasks to work with LIGO smart contracts such as compili
 
 ## Requirements
 
-- Taqueria v0.24.2 or later
+- Taqueria v0.26.0 or later
 - Node.js v16.17.1 or later
 - Docker v20.10.12 or later
 
@@ -55,6 +55,16 @@ Lastly, `taq compile hello.mligo` will compile `hello.mligo` and emit `hello.tz`
 
 The `--json` flag will make the task emit JSON-encoded Michelson instead of pure Michelson `.tz`
 
+## The `taq compile-all` Task
+
+Basic usage is:
+
+```shell
+taq compile-all
+```
+
+It works just like the `compile` task but it compiles all main contracts, a.k.a contracts with a `main` function.
+
 ## The `taq test` Task
 
 Basic usage is:

package/_readme.eta

@@ -6,7 +6,7 @@ The LIGO plugin provides tasks to work with LIGO smart contracts such as compili
 
 ## Requirements
 
-- Taqueria v0.24.2 or later
+- Taqueria v0.26.0 or later
 - Node.js v16.17.1 or later
 - Docker v20.10.12 or later
 
@@ -60,6 +60,16 @@ Lastly, `taq compile hello.mligo` will compile `hello.mligo` and emit `hello.tz`
 
 The `--json` flag will make the task emit JSON-encoded Michelson instead of pure Michelson `.tz`
 
+## The `taq compile-all` Task
+
+Basic usage is:
+
+```shell
+taq compile-all
+```
+
+It works just like the `compile` task but it compiles all main contracts, a.k.a contracts with a `main` function.
+
 ## The `taq test` Task
 
 Basic usage is:

package/common.ts

@@ -11,23 +11,30 @@ export interface CompileOpts extends ProxyTaskArgs.t {
 	json: boolean;
 }
 
+export interface CompileAllOpts extends ProxyTaskArgs.t {
+	json: boolean;
+}
+
 export interface TestOpts extends RequestArgs.t {
 	task?: string;
 	sourceFile?: string;
 }
 
-export type IntersectionOpts = LigoOpts & CompileOpts & TestOpts;
+export type IntersectionOpts = LigoOpts & CompileOpts & CompileAllOpts & TestOpts;
 
-type UnionOpts = LigoOpts | CompileOpts | TestOpts;
+type UnionOpts = LigoOpts | CompileOpts | CompileAllOpts | TestOpts;
 
 // Should point to the latest stable version, so it needs to be updated as part of our release process.
-const LIGO_DEFAULT_IMAGE = 'ligolang/ligo:0.54.1';
+const LIGO_DEFAULT_IMAGE = 'ligolang/ligo:0.57.0';
 
 const LIGO_IMAGE_ENV_VAR = 'TAQ_LIGO_IMAGE';
 
 export const getLigoDockerImage = (): string => getDockerImage(LIGO_DEFAULT_IMAGE, LIGO_IMAGE_ENV_VAR);
 
-export const getInputFilename = (parsedArgs: UnionOpts, sourceFile: string): string =>
+export const getInputFilenameAbsPath = (parsedArgs: UnionOpts, sourceFile: string): string =>
+	join(parsedArgs.config.projectDir, parsedArgs.config.contractsDir ?? 'contracts', sourceFile);
+
+export const getInputFilenameRelPath = (parsedArgs: UnionOpts, sourceFile: string): string =>
 	join(parsedArgs.config.contractsDir ?? 'contracts', sourceFile);
 
 export const emitExternalError = (err: unknown, sourceFile: string): void => {

package/compile-all.ts

@@ -0,0 +1,29 @@
+import { sendErr, sendJsonRes } from '@taqueria/node-sdk';
+import glob from 'fast-glob';
+import { readFile } from 'fs/promises';
+import { join } from 'path';
+import { CompileAllOpts as Opts, CompileOpts, getInputFilenameAbsPath } from './common';
+import { compileContractWithStorageAndParameter, TableRow } from './compile';
+
+const isMainContract = (parsedArgs: Opts, contactFilename: string): Promise<boolean> =>
+	readFile(getInputFilenameAbsPath(parsedArgs, contactFilename), 'utf8')
+		.then(data => /(const|let|function)\s+main/.test(data));
+
+const compileAll = async (parsedArgs: Opts): Promise<void> => {
+	let p: Promise<TableRow[]>[] = [];
+
+	const contractFilenames = await glob(
+		['**/*.ligo', '**/*.religo', '**/*.mligo', '**/*.jsligo'],
+		{ cwd: join(parsedArgs.config.projectDir, parsedArgs.config.contractsDir ?? 'contracts'), absolute: false },
+	);
+
+	for (const filename of contractFilenames) {
+		if (await isMainContract(parsedArgs, filename)) {
+			p.push(compileContractWithStorageAndParameter(parsedArgs as CompileOpts, filename));
+		}
+	}
+
+	return Promise.all(p).then(tables => tables.flat()).then(sendJsonRes).catch(err => sendErr(err, false));
+};
+
+export default compileAll;

package/compile.ts

@@ -1,11 +1,17 @@
-import { execCmd, getArch, getArtifactsDir, sendAsyncErr, sendJsonRes, sendWarn } from '@taqueria/node-sdk';
+import { execCmd, getArch, getArtifactsDir, sendAsyncErr, sendErr, sendJsonRes, sendWarn } from '@taqueria/node-sdk';
 import { access, readFile, writeFile } from 'fs/promises';
 import { basename, extname, join } from 'path';
-import { CompileOpts as Opts, emitExternalError, getInputFilename, getLigoDockerImage } from './common';
+import {
+	CompileOpts as Opts,
+	emitExternalError,
+	getInputFilenameAbsPath,
+	getInputFilenameRelPath,
+	getLigoDockerImage,
+} from './common';
 
-type TableRow = { contract: string; artifact: string };
+export type TableRow = { contract: string; artifact: string };
 
-type ExprKind = 'storage' | 'default_storage' | 'parameter';
+export type ExprKind = 'storage' | 'default_storage' | 'parameter';
 
 const COMPILE_ERR_MSG: string = 'Not compiled';
 
@@ -67,7 +73,7 @@ const getCompileContractCmd = (parsedArgs: Opts, sourceFile: string): string =>
 	if (!projectDir) throw `No project directory provided`;
 	const baseCmd =
 		`DOCKER_DEFAULT_PLATFORM=linux/amd64 docker run --rm -v \"${projectDir}\":/project -w /project -u $(id -u):$(id -g) ${getLigoDockerImage()} compile contract`;
-	const inputFile = getInputFilename(parsedArgs, sourceFile);
+	const inputFile = getInputFilenameRelPath(parsedArgs, sourceFile);
 	const outputFile = `-o ${getOutputContractFilename(parsedArgs, sourceFile)}`;
 	const flags = isOutputFormatJSON(parsedArgs) ? ' --michelson-format json ' : '';
 	const cmd = `${baseCmd} ${inputFile} ${outputFile} ${flags}`;
@@ -80,7 +86,7 @@ const getCompileExprCmd = (parsedArgs: Opts, sourceFile: string, exprKind: ExprK
 	const compilerType = isStorageKind(exprKind) ? 'storage' : 'parameter';
 	const baseCmd =
 		`DOCKER_DEFAULT_PLATFORM=linux/amd64 docker run --rm -v \"${projectDir}\":/project -w /project -u $(id -u):$(id -g) ${getLigoDockerImage()} compile ${compilerType}`;
-	const inputFile = getInputFilename(parsedArgs, sourceFile);
+	const inputFile = getInputFilenameRelPath(parsedArgs, sourceFile);
 	const outputFile = `-o ${getOutputExprFilename(parsedArgs, sourceFile, exprKind, exprName)}`;
 	const flags = isOutputFormatJSON(parsedArgs) ? ' --michelson-format json ' : '';
 	const cmd = `${baseCmd} ${inputFile} ${exprName} ${outputFile} ${flags}`;
@@ -127,7 +133,7 @@ const compileExpr = (parsedArgs: Opts, sourceFile: string, exprKind: ExprKind) =
 			});
 
 const getExprNames = (parsedArgs: Opts, sourceFile: string): Promise<string[]> =>
-	readFile(getInputFilename(parsedArgs, sourceFile), 'utf8')
+	readFile(getInputFilenameAbsPath(parsedArgs, sourceFile), 'utf8')
 		.then(data => data.match(/(?<=\n\s*(let|const)\s+)[a-zA-Z0-9_]+/g) ?? []);
 
 const compileExprs = (parsedArgs: Opts, sourceFile: string, exprKind: ExprKind): Promise<TableRow[]> =>
@@ -154,7 +160,7 @@ const compileExprs = (parsedArgs: Opts, sourceFile: string, exprKind: ExprKind):
 // TODO: Just for backwards compatibility. Can be deleted in the future.
 const tryLegacyStorageNamingConvention = (parsedArgs: Opts, sourceFile: string) => {
 	const storageListFile = `${removeExt(sourceFile)}.storages${extractExt(sourceFile)}`;
-	const storageListFilename = getInputFilename(parsedArgs, storageListFile);
+	const storageListFilename = getInputFilenameAbsPath(parsedArgs, storageListFile);
 	return access(storageListFilename).then(() => {
 		sendWarn(
 			`Warning: The naming convention of "<CONTRACT>.storages.<EXTENSION>" is deprecated and renamed to "<CONTRACT>.storageList.<EXTENSION>". Please adjust your storage file names accordingly\n`,
@@ -166,7 +172,7 @@ const tryLegacyStorageNamingConvention = (parsedArgs: Opts, sourceFile: string)
 // TODO: Just for backwards compatibility. Can be deleted in the future.
 const tryLegacyParameterNamingConvention = (parsedArgs: Opts, sourceFile: string) => {
 	const parameterListFile = `${removeExt(sourceFile)}.parameters${extractExt(sourceFile)}`;
-	const parameterListFilename = getInputFilename(parsedArgs, parameterListFile);
+	const parameterListFilename = getInputFilenameAbsPath(parsedArgs, parameterListFile);
 	return access(parameterListFilename).then(() => {
 		sendWarn(
 			`Warning: The naming convention of "<CONTRACT>.parameters.<EXTENSION>" is deprecated and renamed to "<CONTRACT>.parameterList.<EXTENSION>". Please adjust your parameter file names accordingly\n`,
@@ -206,13 +212,16 @@ const initContentForParameter = (sourceFile: string): string => {
 	return linkToContract + instruction + syntax;
 };
 
-const compileContractWithStorageAndParameter = async (parsedArgs: Opts, sourceFile: string): Promise<TableRow[]> => {
+export const compileContractWithStorageAndParameter = async (
+	parsedArgs: Opts,
+	sourceFile: string,
+): Promise<TableRow[]> => {
 	const contractCompileResult = await compileContract(parsedArgs, sourceFile);
 	if (contractCompileResult.artifact === COMPILE_ERR_MSG) return [contractCompileResult];
 
 	const storageListFile = `${removeExt(sourceFile)}.storageList${extractExt(sourceFile)}`;
-	const storageListFilename = getInputFilename(parsedArgs, storageListFile);
-	const storageCompileResult = await access(storageListFilename)
+	const storageListFilename = getInputFilenameAbsPath(parsedArgs, storageListFile);
+	const storageCompileResult = await (access(storageListFilename)
 		.then(() => compileExprs(parsedArgs, storageListFile, 'storage'))
 		.catch(() => tryLegacyStorageNamingConvention(parsedArgs, sourceFile))
 		.catch(() => {
@@ -220,11 +229,11 @@ const compileContractWithStorageAndParameter = async (parsedArgs: Opts, sourceFi
 				`Note: storage file associated with "${sourceFile}" can't be found, so "${storageListFile}" has been created for you. Use this file to define all initial storage values for this contract\n`,
 			);
 			writeFile(storageListFilename, initContentForStorage(sourceFile), 'utf8');
-		});
+		}));
 
 	const parameterListFile = `${removeExt(sourceFile)}.parameterList${extractExt(sourceFile)}`;
-	const parameterListFilename = getInputFilename(parsedArgs, parameterListFile);
-	const parameterCompileResult = await access(parameterListFilename)
+	const parameterListFilename = getInputFilenameAbsPath(parsedArgs, parameterListFile);
+	const parameterCompileResult = await (access(parameterListFilename)
 		.then(() => compileExprs(parsedArgs, parameterListFile, 'parameter'))
 		.catch(() => tryLegacyParameterNamingConvention(parsedArgs, sourceFile))
 		.catch(() => {
@@ -232,7 +241,7 @@ const compileContractWithStorageAndParameter = async (parsedArgs: Opts, sourceFi
 				`Note: parameter file associated with "${sourceFile}" can't be found, so "${parameterListFile}" has been created for you. Use this file to define all parameter values for this contract\n`,
 			);
 			writeFile(parameterListFilename, initContentForParameter(sourceFile), 'utf8');
-		});
+		}));
 
 	let compileResults: TableRow[] = [contractCompileResult];
 	if (storageCompileResult) compileResults = compileResults.concat(storageCompileResult);
@@ -283,7 +292,11 @@ const compile = (parsedArgs: Opts): Promise<void> => {
 			`${sourceFile} doesn't have a valid LIGO extension ('.ligo', '.religo', '.mligo' or '.jsligo')`,
 		);
 	}
-	return p.then(sendJsonRes).catch(err => sendAsyncErr(err, false));
+	return p.then(sendJsonRes).catch(err => sendErr(err, false));
 };
 
 export default compile;
+export const ___TEST___ = {
+	getContractNameForExpr,
+	getOutputExprFilename,
+};

package/createContract.ts

@@ -1,4 +1,4 @@
-import { experimental, sendAsyncErr } from '@taqueria/node-sdk';
+import { sendAsyncErr } from '@taqueria/node-sdk';
 import { RequestArgs } from '@taqueria/node-sdk';
 import { writeFile } from 'fs/promises';
 import { jsligo_template, mligo_template, pascaligo_template, religo_template } from './ligo_templates';
@@ -8,10 +8,6 @@ interface Opts extends RequestArgs.t {
 	syntax?: string;
 }
 
-const registerContract = (arg: Opts, contractName: string) => {
-	experimental.registerContract(arg, contractName);
-};
-
 const getLigoTemplate = async (contractName: string, syntax: string | undefined): Promise<string> => {
 	const matchResult = contractName.match(/\.[^.]+$/);
 	const ext = matchResult ? matchResult[0].substring(1) : null;
@@ -40,8 +36,7 @@ const createContract = (args: RequestArgs.t) => {
 	const syntax = unsafeOpts.syntax;
 	const contractsDir = `${args.config.projectDir}/${args.config.contractsDir}`;
 	return getLigoTemplate(contractName, syntax)
-		.then(ligo_template => writeFile(`${contractsDir}/${contractName}`, ligo_template))
-		.then(_ => registerContract(unsafeOpts, contractName));
+		.then(ligo_template => writeFile(`${contractsDir}/${contractName}`, ligo_template));
 };
 
 export default createContract;

package/index.d.ts

@@ -0,0 +1 @@
+