Improved CLI

.github/workflows/tact.yml

@@ -57,14 +57,14 @@ jobs:
       - name: Compare Tact version from CLI flag `--version` against package.json
         if: runner.os != 'Windows'
         run: |
-          if [ "$(./bin/tact --version)" != "$(jq -r '.version' < package.json)" ];
+          if [ "$(./bin/tact.mjs --version)" != "$(jq -r '.version' < package.json)" ];
           then false
           fi
 
       - name: Tact CLI non-zero exit code
         if: runner.os != 'Windows'
         run: |
-          ! ./bin/tact --config test/tact-cli/tact.config.json
+          ! ./bin/tact.mjs --config test/tact-cli/tact.config.json
 
       - name: Link Tact compiler
         run: |

CHANGELOG.md

@@ -21,6 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The `isEmpty` extension function for the `Map` type: PR [#266](https://github.com/tact-lang/tact/pull/266)
 - The `pow2` power function with base 2: PR [#267](https://github.com/tact-lang/tact/pull/267)
 - The `try` and `try-catch` statements: PR [#212](https://github.com/tact-lang/tact/pull/212)
+- The `--func` and `--check` flags: PR [#287](https://github.com/tact-lang/tact/pull/287)
 - The `del` method for the `Map` type: PR [#95](https://github.com/tact-lang/tact/pull/95)
 
 ### Changed

bin/tact.mjs

@@ -0,0 +1,50 @@
+#!/usr/bin/env node
+
+import * as main from "../dist/node.js";
+import meow from "meow";
+
+const cli = meow(
+  `
+Usage
+  $ tact --config <config_path>
+
+Options
+  --project <project_name>, -r <project_name>  
+  --version                                    Prints the current tact version
+  --func                                       Outputs the intermediate FunC code.
+  --check                                      Performs type checking and stops.
+  --help                                       Displays this text
+
+Examples
+  $ tact --version
+  1.2.0
+`,
+  {
+    importMeta: import.meta,
+    flags: {
+      config: { shortFlags: "c", type: "string", isRequired: true },
+      project: { shortFlag: "p", type: "string", isMultiple: true },
+      version: { shortflag: "v", type: "boolean" },
+      check: { shortflag: "c", type: "boolean" },
+      func: { shortFlag: "f", type: "boolean" },
+    },
+  },
+);
+
+if (cli.flags.version) {
+  cli.showVersion();
+}
+
+if (cli.flags.check && cli.flags.func) {
+  console.log("--func and --check are mutually exclusive");
+  process.exit(30);
+}
+
+const success = await main.run({
+  configPath: cli.flags.config,
+  projectNames: cli.flags.project ?? [],
+  checkOnly: cli.flags.check,
+  func: cli.flags.func,
+});
+
+process.exit(success ? 0 : 30);

package.json

@@ -29,17 +29,17 @@
   ],
   "main": "./dist/main.js",
   "bin": {
-    "tact": "./bin/tact"
+    "tact": "./bin/tact.mjs"
   },
   "dependencies": {
     "@ipld/dag-pb": "2.1.18",
     "@tact-lang/opcode": "^0.0.14",
     "@ton/core": "0.56.3",
     "@ton/crypto": "^3.2.0",
-    "arg": "^5.0.2",
     "blockstore-core": "1.0.5",
     "change-case": "^4.1.2",
     "ipfs-unixfs-importer": "9.0.10",
+    "meow": "^13.2.0",
     "mkdirp": "^2.1.3",
     "multiformats": "^13.1.0",
     "ohm-js": "^17.1.0",

src/node.ts

@@ -8,6 +8,8 @@ import { consoleLogger } from "./logger";
 export async function run(args: {
     configPath: string;
     projectNames?: string[];
+    checkOnly?: boolean;
+    func?: boolean;
 }) {
     // Load config
     const resolvedPath = path.resolve(args.configPath);
@@ -28,7 +30,7 @@ export async function run(args: {
     // Resolve projects
     let projects = config.projects;
     if (args.projectNames && args.projectNames.length > 0) {
-        // Check that all proejct names are valid
+        // Check that all project names are valid
         for (const pp of args.projectNames) {
             if (!projects.find((v) => v.name === pp)) {
                 console.warn("Unable to find project " + pp);
@@ -58,6 +60,8 @@ export async function run(args: {
             project,
             stdlib,
             logger: consoleLogger,
+            checkOnly: args.checkOnly,
+            func: args.func,
         });
         success = success && built;
     }

src/pipeline/build.ts

@@ -26,6 +26,8 @@ export async function build(args: {
     project: VirtualFileSystem;
     stdlib: string | VirtualFileSystem;
     logger?: TactLogger | null | undefined;
+    checkOnly?: boolean;
+    func?: boolean;
 }) {
     const { config, project } = args;
     const stdlib =
@@ -68,6 +70,11 @@ export async function build(args: {
         return false;
     }
 
+    if (args.checkOnly) {
+        logger.log("✔️ Type checking succeeded.");
+        return true;
+    }
+
     // Compile contracts
     let ok = true;
     const built: {
@@ -127,6 +134,10 @@ export async function build(args: {
             continue;
         }
 
+        if (args.func) {
+            continue;
+        }
+
         // Compiling contract to TVM
         logger.log("   > " + contract + ": func compiler");
         let codeBoc: Buffer;
@@ -198,6 +209,11 @@ export async function build(args: {
         return false;
     }
 
+    if (args.func) {
+        logger.log("✔️ FunC code generation succeeded.");
+        return true;
+    }
+
     // Package
     logger.log("   > Packaging");
     const contracts = getContracts(ctx);

yarn.lock

@@ -1313,7 +1313,7 @@ arg@^4.1.0:
   resolved "https://registry.yarnpkg.com/arg/-/arg-4.1.3.tgz#269fc7ad5b8e42cb63c896d5666017261c144089"
   integrity sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==
 
-arg@^5.0.1, arg@^5.0.2:
+arg@^5.0.1:
   version "5.0.2"
   resolved "https://registry.yarnpkg.com/arg/-/arg-5.0.2.tgz#c81433cc427c92c4dcf4865142dbca6f15acd59c"
   integrity sha512-PYjyFOLKQ9y57JvQ6QLo8dAgNqswh8M1RMJYdQduT6xbWSgK36P/Z/v+p888pM69jMMfS8Xd8F6I1kQ/I9HUGg==
@@ -4105,6 +4105,11 @@ makeerror@1.0.12:
   dependencies:
     tmpl "1.0.5"
 
+meow@^13.2.0:
+  version "13.2.0"
+  resolved "https://registry.yarnpkg.com/meow/-/meow-13.2.0.tgz#6b7d63f913f984063b3cc261b6e8800c4cd3474f"
+  integrity sha512-pxQJQzB6djGPXh08dacEloMFopsOqGVRKFPYvPOt9XDZ1HasbgDZA74CJGreSU4G3Ak7EFJGoiH2auq+yXISgA==
+
 merge-options@^3.0.4:
   version "3.0.4"
   resolved "https://registry.yarnpkg.com/merge-options/-/merge-options-3.0.4.tgz#84709c2aa2a4b24c1981f66c179fe5565cc6dbb7"