@haneullabs/prettier-plugin-move 0.3.3

package/out/imports-grouping.js

@@ -0,0 +1,259 @@
+"use strict";
+// Copyright (c) The Move Contributors
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printImports = printImports;
+exports.collectImports = collectImports;
+/**
+ * This module contains the logic for grouping imports in a file.
+ *
+ * @module imports-grouping
+ */
+const prettier_1 = require("prettier");
+const use_declaration_1 = require("./cst/use_declaration");
+const { join, softline, indent, line, group } = prettier_1.doc.builders;
+/**
+ * Special function to print imports if import grouping is turned on.
+ * Important note: we don't use the `print` function for imports, as they're already
+ * parsed. We just need to print them in the correct order and format.
+ *
+ * We sort and avoid duplicates in the imports. To do so, we keep track of the
+ * printed keys (including alias!), and only print the import if it hasn't been
+ * printed before.
+ */
+function printImports(imports, option) {
+    const pkgs = [...imports.keys()].sort();
+    const result = [];
+    for (const pkg of pkgs) {
+        const modules = imports.get(pkg);
+        // typescript wants this
+        if (modules == undefined) {
+            continue;
+        }
+        const keys = [...modules.keys()].sort();
+        // if grouped by module
+        if (option === 'module') {
+            for (const mod of keys) {
+                if (!modules.get(mod))
+                    continue;
+                result.push(['use ', pkg, '::', printModule(mod, modules.get(mod)), ';']);
+            }
+        }
+        else {
+            // if grouped by package
+            const modulesDoc = [];
+            for (const mod of keys) {
+                if (!modules.has(mod))
+                    continue;
+                modulesDoc.push(printModule(mod, modules.get(mod)));
+            }
+            modulesDoc.length === 1
+                ? result.push(['use ', pkg, '::', modulesDoc[0], ';'])
+                : result.push([
+                    'use ',
+                    pkg,
+                    '::',
+                    group([
+                        '{',
+                        indent(softline),
+                        indent(join([',', line], modulesDoc)),
+                        softline,
+                        '}',
+                    ]),
+                    ';',
+                ]);
+        }
+    }
+    return result;
+}
+function printModule(mod, members) {
+    const printedKeys = [];
+    // perform deduplication of imports
+    members = members.filter((m) => {
+        const key = [mod, m.name, m.alias || '-'].join('');
+        if (printedKeys.includes(key))
+            return false;
+        printedKeys.push(key);
+        return true;
+    });
+    if (members.length === 1) {
+        const member = members[0];
+        if (member.name === 'Self') {
+            const alias = member.alias ? ` as ${member.alias}` : '';
+            return `${mod}${alias}`;
+        }
+        return [mod, '::', printMember(member)];
+    }
+    const selfIdx = members.findIndex((m) => m.name === 'Self');
+    if (selfIdx !== -1) {
+        const self = members.splice(selfIdx, 1);
+        members = [...self, ...members];
+    }
+    return members.length === 0
+        ? [mod]
+        : [
+            mod,
+            '::',
+            group([
+                '{',
+                indent(softline),
+                indent(join([',', line], members.map(printMember))),
+                softline,
+                '}',
+            ]),
+        ];
+}
+/**
+ * Print a single member of a module with an optional alias.
+ */
+function printMember({ name, alias }) {
+    const a = alias ? ` as ${alias}` : '';
+    return `${name}${a}`;
+}
+/**
+ * Special function which walks the current node and collects all `use` imports.
+ * Returns a tree of all imports in this file to be used for grouping.
+ *
+ * There are 3 main types of imports:
+ * - `use_module` - `module_access` <as `alias`>;
+ * - `use_module_member` - `<module_identity>::<use_member>`;
+ * - `use_module_members` - `package::<use_member>, <use_member>, ...`
+ *
+ * @param node
+ * @returns
+ */
+function collectImports(node) {
+    const grouped = new Map();
+    const imports = node.nonFormattingChildren
+        .filter((n) => n.isGroupedImport)
+        .map((n) => n.nonFormattingChildren[0]);
+    for (let import_ of imports) {
+        switch (import_.type) {
+            // `module_access` <as `alias`>;
+            case use_declaration_1.UseDeclaration.UseModule: {
+                const moduleIdentity = import_.nonFormattingChildren[0];
+                const alias = import_.nonFormattingChildren[1];
+                const [pkg, mod] = parseModuleIdentity(moduleIdentity);
+                // we use `Self` in the tree to represent the current module
+                const rec = { name: 'Self', alias: alias?.text };
+                // if there hasn't been a registered package yet, add it
+                if (!grouped.has(pkg))
+                    grouped.set(pkg, new Map());
+                const pkgMap = grouped.get(pkg);
+                // if there hasn't been a registered module yet, add it
+                if (!pkgMap.has(mod))
+                    pkgMap.set(mod, []);
+                pkgMap.set(mod, pkgMap.get(mod));
+                pkgMap.get(mod).push(rec);
+                break;
+            }
+            // `<module_identity>::<use_member>`
+            case use_declaration_1.UseDeclaration.UseModuleMember: {
+                const moduleIdentity = import_.nonFormattingChildren[0];
+                const [pkg, mod] = parseModuleIdentity(moduleIdentity);
+                const useMember = import_.nonFormattingChildren[1];
+                const [name, alias] = parseUseMember(useMember);
+                if (!grouped.has(pkg))
+                    grouped.set(pkg, new Map());
+                const pkgMap = grouped.get(pkg);
+                if (!pkgMap.has(mod))
+                    pkgMap.set(mod, []);
+                const modMap = pkgMap.get(mod);
+                modMap.push({ name, alias });
+                break;
+            }
+            // The only tricky node in this scheme. `use_module_members` can be
+            // both for grouped by package and for grouped by module, so we have
+            // to detect which version it is and then dance off of that.
+            case use_declaration_1.UseDeclaration.UseModuleMembers: {
+                const children = import_.nonFormattingChildren;
+                const isGroupedByPackage = children[0].type === 'module_identifier';
+                if (!isGroupedByPackage && children[0].type !== use_declaration_1.UseDeclaration.ModuleIdentity) {
+                    throw new Error('Expected `module_identity` or `module_identifier`');
+                }
+                // simple scenario: the first node is `module_identity`
+                if (!isGroupedByPackage) {
+                    const moduleIdentity = children[0];
+                    const [pkg, mod] = parseModuleIdentity(moduleIdentity);
+                    const members = children.slice(1).map((n) => parseUseMember(n));
+                    if (!grouped.has(pkg))
+                        grouped.set(pkg, new Map());
+                    const pkgMap = grouped.get(pkg);
+                    if (!pkgMap.has(mod))
+                        pkgMap.set(mod, []);
+                    const modMap = pkgMap.get(mod);
+                    modMap.push(...members.map(([name, alias]) => ({ name, alias })));
+                    break;
+                }
+                // complex scenario: the first node is `module_identifier`
+                // `use_member` can be recursive in this scenario with 1 level of nesting
+                const pkg = children[0].text;
+                if (!grouped.has(pkg))
+                    grouped.set(pkg, new Map());
+                const pkgMap = grouped.get(pkg);
+                children.slice(1).forEach((node) => {
+                    if (!node)
+                        return;
+                    if (node.type !== use_declaration_1.UseDeclaration.UseMember)
+                        throw new Error('Expected `use_member` node got `' + node.type + '`');
+                    const [first, ...rest] = node.nonFormattingChildren;
+                    if (!first || first.type !== 'identifier')
+                        throw new Error('Expected `identifier` node in `use_module_members`');
+                    const mod = first.text;
+                    if (!pkgMap.has(mod))
+                        pkgMap.set(mod, []);
+                    // if there's only one member and it's the module.
+                    if (!rest.length) {
+                        pkgMap.get(mod).push({ name: 'Self', alias: undefined });
+                        return;
+                    }
+                    // ident + ident is an alias
+                    if (rest.length == 1 && rest[0]?.type === 'identifier') {
+                        if (rest[0].previousSibling?.type !== 'as') {
+                            pkgMap.get(mod).push({ name: rest[0].text, alias: undefined });
+                        }
+                        else {
+                            pkgMap.get(mod).push({ name: 'Self', alias: rest[0].text });
+                        }
+                        return;
+                    }
+                    // special case, no use member, but already expanded pair of identifiers.
+                    if (rest.length == 2 &&
+                        rest[0]?.type === 'identifier' &&
+                        rest[1]?.type === 'identifier') {
+                        if (rest[1].previousSibling?.type !== 'as') {
+                            throw new Error('Expected `as` keyword after module name');
+                        }
+                        pkgMap.get(mod).push({ name: rest[0].text, alias: rest[1].text });
+                        return;
+                    }
+                    // the rest are `use_member` nodes
+                    const members = rest.map(parseUseMember);
+                    pkgMap.get(mod).push(...members.map(([name, alias]) => ({ name, alias })));
+                });
+            }
+        }
+    }
+    return grouped;
+}
+/**
+ * Parse a `module_identity` node returning a tuple of package and module.
+ */
+function parseModuleIdentity(node) {
+    if (node.type !== use_declaration_1.UseDeclaration.ModuleIdentity) {
+        throw new Error('Expected `module_identity` node');
+    }
+    const [pkg, mod] = node.nonFormattingChildren.map((n) => n.text);
+    return [pkg, mod];
+}
+/**
+ * Parse a simple `use_member` node returning a tuple of member and alias.
+ */
+function parseUseMember(node) {
+    if (node.type !== use_declaration_1.UseDeclaration.UseMember) {
+        throw new Error('Expected `use_member` node, got `' + node.type + '`');
+    }
+    const [member, alias] = node.nonFormattingChildren.map((n) => n.text);
+    return [member, alias];
+}
+//# sourceMappingURL=imports-grouping.js.map

package/out/imports-grouping.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"imports-grouping.js","sourceRoot":"","sources":["../src/imports-grouping.ts"],"names":[],"mappings":";AAAA,sCAAsC;AACtC,sCAAsC;;AAkCtC,oCAgDC;AAgED,wCAgIC;AAhRD;;;;GAIG;AAEH,uCAAoC;AAEpC,2DAAuD;AACvD,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,cAAG,CAAC,QAAQ,CAAC;AAc7D;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,OAAuB,EAAE,MAA4B;IAC9E,MAAM,IAAI,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACxC,MAAM,MAAM,GAAG,EAAW,CAAC;IAE3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAEjC,wBAAwB;QACxB,IAAI,OAAO,IAAI,SAAS,EAAE,CAAC;YACvB,SAAS;QACb,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAExC,uBAAuB;QACvB,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YACtB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,SAAS;gBAChC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;YAC/E,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,wBAAwB;YACxB,MAAM,UAAU,GAAG,EAAW,CAAC;YAE/B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACrB,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,SAAS;gBAChC,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAC,CAAC;YACzD,CAAC;YAED,UAAU,CAAC,MAAM,KAAK,CAAC;gBACnB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAE,EAAE,GAAG,CAAC,CAAC;gBACvD,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;oBACR,MAAM;oBACN,GAAG;oBACH,IAAI;oBACJ,KAAK,CAAC;wBACF,GAAG;wBACH,MAAM,CAAC,QAAQ,CAAC;wBAChB,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;wBACrC,QAAQ;wBACR,GAAG;qBACN,CAAC;oBACF,GAAG;iBACN,CAAC,CAAC;QACb,CAAC;IACL,CAAC;IAED,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,SAAS,WAAW,CAAC,GAAW,EAAE,OAAiB;IAC/C,MAAM,WAAW,GAAa,EAAE,CAAC;IAEjC,mCAAmC;IACnC,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE;QAC3B,MAAM,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnD,IAAI,WAAW,CAAC,QAAQ,CAAC,GAAG,CAAC;YAAE,OAAO,KAAK,CAAC;QAC5C,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC;QAC3B,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACzB,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,OAAO,GAAG,GAAG,GAAG,KAAK,EAAE,CAAC;QAC5B,CAAC;QAED,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,OAAO,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;IAC5D,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;QACjB,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;QACxC,OAAO,GAAG,CAAC,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC,CAAC;IACpC,CAAC;IAED,OAAO,OAAO,CAAC,MAAM,KAAK,CAAC;QACvB,CAAC,CAAC,CAAC,GAAG,CAAC;QACP,CAAC,CAAC;YACI,GAAG;YACH,IAAI;YACJ,KAAK,CAAC;gBACF,GAAG;gBACH,MAAM,CAAC,QAAQ,CAAC;gBAChB,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;gBACnD,QAAQ;gBACR,GAAG;aACN,CAAC;SACL,CAAC;AACZ,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,EAAE,IAAI,EAAE,KAAK,EAAU;IACxC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACtC,OAAO,GAAG,IAAI,GAAG,CAAC,EAAE,CAAC;AACzB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,cAAc,CAAC,IAAU;IACrC,MAAM,OAAO,GAAmB,IAAI,GAAG,EAAE,CAAC;IAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,qBAAqB;SACrC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC;SAChC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAE,CAAC,CAAC;IAE7C,KAAK,IAAI,OAAO,IAAI,OAAO,EAAE,CAAC;QAC1B,QAAQ,OAAO,CAAC,IAAI,EAAE,CAAC;YACnB,gCAAgC;YAChC,KAAK,gCAAc,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC5B,MAAM,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAE,CAAC;gBACzD,MAAM,KAAK,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;gBAC/C,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;gBAEvD,4DAA4D;gBAC5D,MAAM,GAAG,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBAEjD,wDAAwD;gBACxD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBACnD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;gBACjC,uDAAuD;gBACvD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBAC1C,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,CAAC;gBAClC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAE3B,MAAM;YACV,CAAC;YACD,oCAAoC;YACpC,KAAK,gCAAc,CAAC,eAAe,CAAC,CAAC,CAAC;gBAClC,MAAM,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAE,CAAC;gBACzD,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;gBACvD,MAAM,SAAS,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAE,CAAC;gBACpD,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,CAAC;gBAEhD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBACnD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;gBACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;gBAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;gBAE7B,MAAM;YACV,CAAC;YACD,mEAAmE;YACnE,oEAAoE;YACpE,4DAA4D;YAC5D,KAAK,gCAAc,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBACnC,MAAM,QAAQ,GAAG,OAAO,CAAC,qBAAqB,CAAC;gBAC/C,MAAM,kBAAkB,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC,IAAI,KAAK,mBAAmB,CAAC;gBAErE,IAAI,CAAC,kBAAkB,IAAI,QAAQ,CAAC,CAAC,CAAE,CAAC,IAAI,KAAK,gCAAc,CAAC,cAAc,EAAE,CAAC;oBAC7E,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;gBACzE,CAAC;gBAED,uDAAuD;gBACvD,IAAI,CAAC,kBAAkB,EAAE,CAAC;oBACtB,MAAM,cAAc,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;oBACpC,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,mBAAmB,CAAC,cAAc,CAAC,CAAC;oBACvD,MAAM,OAAO,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;oBAEhE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;wBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;oBACnD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;oBACjC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;wBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBAC1C,MAAM,MAAM,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;oBAEhC,MAAM,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;oBAElE,MAAM;gBACV,CAAC;gBAED,0DAA0D;gBAC1D,yEAAyE;gBACzE,MAAM,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC,IAAI,CAAC;gBAC9B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC;oBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;gBACnD,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;gBAEjC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;oBAC/B,IAAI,CAAC,IAAI;wBAAE,OAAO;oBAElB,IAAI,IAAI,CAAC,IAAI,KAAK,gCAAc,CAAC,SAAS;wBACtC,MAAM,IAAI,KAAK,CAAC,kCAAkC,GAAG,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;oBAE1E,MAAM,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC;oBACpD,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY;wBACrC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;oBAE1E,MAAM,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC;oBACvB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC;wBAAE,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBAE1C,kDAAkD;oBAClD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;wBACf,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;wBAC1D,OAAO;oBACX,CAAC;oBAED,4BAA4B;oBAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,YAAY,EAAE,CAAC;wBACrD,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;4BACzC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;wBACpE,CAAC;6BAAM,CAAC;4BACJ,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;wBACjE,CAAC;wBAED,OAAO;oBACX,CAAC;oBAED,yEAAyE;oBACzE,IACI,IAAI,CAAC,MAAM,IAAI,CAAC;wBAChB,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,YAAY;wBAC9B,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,KAAK,YAAY,EAChC,CAAC;wBACC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,EAAE,IAAI,KAAK,IAAI,EAAE,CAAC;4BACzC,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAC;wBAC/D,CAAC;wBAED,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;wBACnE,OAAO;oBACX,CAAC;oBAED,kCAAkC;oBAClC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;oBACzC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;gBAChF,CAAC,CAAC,CAAC;YACP,CAAC;QACL,CAAC;IACL,CAAC;IAED,OAAO,OAAO,CAAC;AACnB,CAAC;AAED;;GAEG;AACH,SAAS,mBAAmB,CAAC,IAAU;IACnC,IAAI,IAAI,CAAC,IAAI,KAAK,gCAAc,CAAC,cAAc,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACvD,CAAC;IAED,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjE,OAAO,CAAC,GAAI,EAAE,GAAI,CAAC,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,IAAU;IAC9B,IAAI,IAAI,CAAC,IAAI,KAAK,gCAAc,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,IAAI,KAAK,CAAC,mCAAmC,GAAG,IAAI,CAAC,IAAI,GAAG,GAAG,CAAC,CAAC;IAC3E,CAAC;IAED,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACtE,OAAO,CAAC,MAAO,EAAE,KAAK,CAAC,CAAC;AAC5B,CAAC"}

package/out/index.js

@@ -0,0 +1,97 @@
+"use strict";
+// Copyright (c) The Move Contributors
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultOptions = exports.options = exports.printers = exports.parsers = exports.languages = void 0;
+/**
+ * Contains the Prettier Plugin definition for the Move language.
+ * For more information on Prettier plugins, see https://prettier.io/docs/en/plugins.html
+ *
+ * The printing logic is implemented in the `printer` module, which is routing the
+ * specific node types defined in the `cst/*` modules.
+ *
+ * Additionally, `utilities` module contains helper functions for the printer.
+ *
+ * @module prettier-move
+ */
+const path = require("path");
+const Parser = require("web-tree-sitter");
+const printer_1 = require("./printer");
+const tree_1 = require("./tree");
+exports.languages = [
+    {
+        name: 'move',
+        extensions: ['.move'],
+        parsers: ['move'],
+    },
+];
+exports.parsers = {
+    move: {
+        parse: (text) => {
+            return (async () => {
+                await Parser.init();
+                const parser = new Parser();
+                const Lang = await Parser.Language.load(path.join(__dirname, '..', 'tree-sitter-move.wasm'));
+                parser.setLanguage(Lang);
+                return new tree_1.Tree(parser.parse(text).rootNode);
+            })();
+        },
+        astFormat: 'move',
+        locStart: () => -1,
+        locEnd: () => -1,
+    },
+};
+exports.printers = {
+    move: { print: printer_1.print },
+};
+exports.options = {
+    autoGroupImports: {
+        type: 'choice',
+        category: 'Global',
+        default: 'package',
+        description: "Group all use imports by 'package', 'module' or 'none'.",
+        choices: [
+            {
+                value: 'package',
+                description: 'Group imports by package, eg `use sui::{balance::Balance, coin::Coin}',
+            },
+            {
+                value: 'module',
+                description: 'Group imports by module eg\n`use sui::balance::Balance;\nuse sui::coin::Coin`',
+            },
+        ],
+    },
+    wrapComments: {
+        type: 'boolean',
+        category: 'Global',
+        default: false,
+        description: 'Wrap comments to the next line if the line is too long.',
+    },
+    useModuleLabel: {
+        type: 'boolean',
+        category: 'Global',
+        default: true,
+        description: 'Enable module labels instead of module with braces. This option will be ignored if there is more than one module in the file.',
+    },
+    enableErrorDebug: {
+        type: 'boolean',
+        category: 'Global',
+        default: false,
+        description: 'Print ERROR nodes instead of throwing an error.',
+    },
+};
+exports.defaultOptions = {
+    tabWidth: 4,
+    useTabs: false,
+    printWidth: 100,
+    useModuleLabel: false,
+    groupImports: 'module',
+};
+exports.default = {
+    languages: exports.languages,
+    parsers: exports.parsers,
+    printers: exports.printers,
+    options: exports.options,
+    defaultOptions: exports.defaultOptions,
+};
+//# sourceMappingURL=index.js.map

package/out/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA,sCAAsC;AACtC,sCAAsC;;;AAEtC;;;;;;;;;;GAUG;AAEH,6BAA6B;AAC7B,0CAA2C;AAC3C,uCAAkC;AAClC,iCAA8B;AAcjB,QAAA,SAAS,GAAsB;IACxC;QACI,IAAI,EAAE,MAAM;QACZ,UAAU,EAAE,CAAC,OAAO,CAAC;QACrB,OAAO,EAAE,CAAC,MAAM,CAAC;KACpB;CACJ,CAAC;AAEW,QAAA,OAAO,GAAsC;IACtD,IAAI,EAAE;QACF,KAAK,EAAE,CAAC,IAAY,EAAiB,EAAE;YACnC,OAAO,CAAC,KAAK,IAAmB,EAAE;gBAC9B,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;gBACpB,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;gBAC5B,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,IAAI,CACnC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,EAAE,uBAAuB,CAAC,CACtD,CAAC;gBACF,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;gBACzB,OAAO,IAAI,WAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;YACjD,CAAC,CAAC,EAAE,CAAC;QACT,CAAC;QAED,SAAS,EAAE,MAAM;QACjB,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QAClB,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;KACnB;CACJ,CAAC;AAEW,QAAA,QAAQ,GAA+B;IAChD,IAAI,EAAE,EAAE,KAAK,EAAL,eAAK,EAAE;CAClB,CAAC;AAEW,QAAA,OAAO,GAAkC;IAClD,gBAAgB,EAAE;QACd,IAAI,EAAE,QAAQ;QACd,QAAQ,EAAE,QAAQ;QAClB,OAAO,EAAE,SAAS;QAClB,WAAW,EAAE,yDAAyD;QACtE,OAAO,EAAE;YACL;gBACI,KAAK,EAAE,SAAS;gBAChB,WAAW,EACP,uEAAuE;aAC9E;YACD;gBACI,KAAK,EAAE,QAAQ;gBACf,WAAW,EACP,+EAA+E;aACtF;SACJ;KACJ;IACD,YAAY,EAAE;QACV,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,QAAQ;QAClB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,yDAAyD;KACzE;IACD,cAAc,EAAE;QACZ,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,QAAQ;QAClB,OAAO,EAAE,IAAI;QACb,WAAW,EACP,+HAA+H;KACtI;IACD,gBAAgB,EAAE;QACd,IAAI,EAAE,SAAS;QACf,QAAQ,EAAE,QAAQ;QAClB,OAAO,EAAE,KAAK;QACd,WAAW,EAAE,iDAAiD;KACjE;CACJ,CAAC;AAEW,QAAA,cAAc,GAAG;IAC1B,QAAQ,EAAE,CAAC;IACX,OAAO,EAAE,KAAK;IACd,UAAU,EAAE,GAAG;IACf,cAAc,EAAE,KAAK;IACrB,YAAY,EAAE,QAAQ;CACzB,CAAC;AAEF,kBAAe;IACX,SAAS,EAAT,iBAAS;IACT,OAAO,EAAP,eAAO;IACP,QAAQ,EAAR,gBAAQ;IACR,OAAO,EAAP,eAAO;IACP,cAAc,EAAd,sBAAc;CACP,CAAC"}

package/out/printer.js

@@ -0,0 +1,69 @@
+"use strict";
+// Copyright (c) The Move Contributors
+// SPDX-License-Identifier: Apache-2.0
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.print = print;
+const common_1 = require("./cst/common");
+const formatting_1 = require("./cst/formatting");
+const module_1 = require("./cst/module");
+const use_declaration_1 = require("./cst/use_declaration");
+const constant_1 = require("./cst/constant");
+const struct_definition_1 = require("./cst/struct_definition");
+const function_definition_1 = require("./cst/function_definition");
+const source_file_1 = require("./cst/source_file");
+const expression_1 = require("./cst/expression");
+const literal_1 = require("./cst/literal");
+const utilities_1 = require("./utilities");
+const enum_definition_1 = require("./cst/enum_definition");
+const annotation_1 = require("./cst/annotation");
+/**
+ * Print the AST node at the given path.
+ */
+function print(path, options, print) {
+    // check if the node has an error child, if so, we throw an error or return the error text
+    const checkErrorsCb = (path) => {
+        if (path.node.children.some((n) => n.type === 'ERROR')) {
+            if (options.enableErrorDebug) {
+                return ((path, options, print) => ['/* ERROR: */', path.node.text]);
+            }
+            else {
+                throw new Error('tree-sitter failure on \n```\n' + path.node.text + '\n```');
+            }
+        }
+        if (path.node.children.some((n) => n.type === 'MISSING')) {
+            if (options.enableErrorDebug) {
+                return ((path, options, print) => ['/* MISSING: */', path.node.text]);
+            }
+            else {
+                throw new Error('tree-sitter failure on \n```\n' + path.node.text + '\n```');
+            }
+        }
+        return null;
+    };
+    // for unimplemented / not yet implemented nodes, we just return the node type
+    const defautCb = (path, options, print) => {
+        return path.node.type;
+    };
+    const fn = checkErrorsCb(path) ||
+        (0, source_file_1.default)(path) ||
+        (0, annotation_1.default)(path) ||
+        (0, formatting_1.default)(path) ||
+        (0, common_1.default)(path) ||
+        (0, module_1.default)(path) ||
+        (0, use_declaration_1.default)(path) ||
+        (0, constant_1.default)(path) ||
+        (0, enum_definition_1.default)(path) ||
+        (0, struct_definition_1.default)(path) ||
+        (0, function_definition_1.default)(path) ||
+        (0, expression_1.default)(path) ||
+        (0, literal_1.default)(path) ||
+        defautCb;
+    return [
+        (0, utilities_1.printLeadingComment)(path, options),
+        // if the node has a `skipFormattingNode` property, we just return
+        // the text without formatting it
+        path.node.skipFormattingNode ? path.node.text : fn(path, options, print),
+        (0, utilities_1.printTrailingComment)(path),
+    ];
+}
+//# sourceMappingURL=printer.js.map

package/out/printer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"printer.js","sourceRoot":"","sources":["../src/printer.ts"],"names":[],"mappings":";AAAA,sCAAsC;AACtC,sCAAsC;;AAyCtC,sBAkDC;AA/ED,yCAAkC;AAClC,iDAA0C;AAC1C,yCAAkC;AAClC,2DAAmD;AACnD,6CAAsC;AACtC,+DAAuD;AACvD,mEAA2D;AAC3D,mDAA2C;AAC3C,iDAA0C;AAC1C,2CAAoC;AACpC,2CAAwE;AACxE,2DAAmD;AACnD,iDAA0C;AAc1C;;GAEG;AACH,SAAgB,KAAK,CAAC,IAAmB,EAAE,OAAoB,EAAE,KAAc;IAC3E,0FAA0F;IAC1F,MAAM,aAAa,GAAG,CAAC,IAAmB,EAAE,EAAE;QAC1C,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,EAAE,CAAC;YACrD,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,OAAO,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAW,CAAC;YAClF,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;YACjF,CAAC;QACL,CAAC;QAED,IAAI,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,EAAE,CAAC;YACvD,IAAI,OAAO,CAAC,gBAAgB,EAAE,CAAC;gBAC3B,OAAO,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,gBAAgB,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAW,CAAC;YACpF,CAAC;iBAAM,CAAC;gBACJ,MAAM,IAAI,KAAK,CAAC,gCAAgC,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,CAAC;YACjF,CAAC;QACL,CAAC;QAED,OAAO,IAAI,CAAC;IAChB,CAAC,CAAC;IAEF,8EAA8E;IAC9E,MAAM,QAAQ,GAAW,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QAC9C,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;IAC1B,CAAC,CAAC;IAEF,MAAM,EAAE,GACJ,aAAa,CAAC,IAAI,CAAC;QACnB,IAAA,qBAAU,EAAC,IAAI,CAAC;QAChB,IAAA,oBAAU,EAAC,IAAI,CAAC;QAChB,IAAA,oBAAU,EAAC,IAAI,CAAC;QAChB,IAAA,gBAAM,EAAC,IAAI,CAAC;QACZ,IAAA,gBAAM,EAAC,IAAI,CAAC;QACZ,IAAA,yBAAc,EAAC,IAAI,CAAC;QACpB,IAAA,kBAAQ,EAAC,IAAI,CAAC;QACd,IAAA,yBAAc,EAAC,IAAI,CAAC;QACpB,IAAA,2BAAgB,EAAC,IAAI,CAAC;QACtB,IAAA,6BAAkB,EAAC,IAAI,CAAC;QACxB,IAAA,oBAAU,EAAC,IAAI,CAAC;QAChB,IAAA,iBAAO,EAAC,IAAI,CAAC;QACb,QAAQ,CAAC;IAEb,OAAO;QACH,IAAA,+BAAmB,EAAC,IAAI,EAAE,OAAO,CAAC;QAClC,kEAAkE;QAClE,iCAAiC;QACjC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC;QACxE,IAAA,gCAAoB,EAAC,IAAI,CAAC;KAC7B,CAAC;AACN,CAAC"}