Skip to content

only break import deconstruction if the list of items is longer than 1 #1178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 9, 2025
Merged

only break import deconstruction if the list of items is longer than 1 #1178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9b1a771
adding tests for import directives
Janther Jun 23, 2025
125445d
only break import deconstruction if the list of items is longer than 1
Janther Jun 23, 2025
6032dfc
update `antlr` parser
Janther Jun 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion src/nodes/ImportDirective.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ export const ImportDirective = {
let firstSeparator;
let separator;

if (compiler && satisfies(compiler, '>=0.7.4')) {
if (
compiler &&
satisfies(compiler, '>=0.7.4') &&
symbolAliases.length > 1
) {
// if the compiler exists and is greater than or equal to 0.7.4 we will
// split the ImportDirective.
firstSeparator = options.bracketSpacing ? line : softline;
Expand Down
2 changes: 1 addition & 1 deletion src/slang-nodes/ImportDeconstructionSymbols.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export class ImportDeconstructionSymbols implements SlangNode {
const compiler = coerce(options.compiler);
return printSeparatedList(
path.map(print, 'items'),
compiler && satisfies(compiler, '>=0.7.4')
compiler && satisfies(compiler, '>=0.7.4') && this.items.length > 1
? {
// if the compiler exists and is greater than or equal to 0.7.4 we will
// split the ImportDirective.
Expand Down
16 changes: 16 additions & 0 deletions tests/format/ImportDirective/ImportDirectives.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,19 @@ import "SomeFile.sol" as SomeOtherFile;
import * as SomeSymbol from "AnotherFile.sol";
import {symbol1 as alias1, symbol2} from "File.sol";
import {symbol1 as alias1, symbol2 as alias2, symbol3 as alias3, symbol4} from "File2.sol";
import {
GovernorVotesSuperQuorumFraction
} from "../../../contracts/governance/extensions/GovernorVotesSuperQuorumFraction.sol";
import {
IAccessControl
} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {
IERC7579Module,
IERC7579Validator,
IERC7579Execution,
IERC7579AccountConfig,
IERC7579ModuleConfig,
MODULE_TYPE_VALIDATOR,
MODULE_TYPE_EXECUTOR,
MODULE_TYPE_FALLBACK
} from "../../interfaces/draft-IERC7579.sol";
101 changes: 98 additions & 3 deletions tests/format/ImportDirective/__snapshots__/format.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Jest Snapshot v1, https://goo.gl/fbAQLP
// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing

exports[`ImportDirectives.sol - {"bracketSpacing":true} format 1`] = `
====================================options=====================================
Expand All @@ -12,7 +12,22 @@ import "SomeFile.sol" as SomeOtherFile;
import * as SomeSymbol from "AnotherFile.sol";
import {symbol1 as alias1, symbol2} from "File.sol";
import {symbol1 as alias1, symbol2 as alias2, symbol3 as alias3, symbol4} from "File2.sol";

import {
GovernorVotesSuperQuorumFraction
} from "../../../contracts/governance/extensions/GovernorVotesSuperQuorumFraction.sol";
import {
IAccessControl
} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {
IERC7579Module,
IERC7579Validator,
IERC7579Execution,
IERC7579AccountConfig,
IERC7579ModuleConfig,
MODULE_TYPE_VALIDATOR,
MODULE_TYPE_EXECUTOR,
MODULE_TYPE_FALLBACK
} from "../../interfaces/draft-IERC7579.sol";
=====================================output=====================================
import "SomeFile.sol";
import "SomeFile.sol" as SomeOtherFile;
Expand All @@ -24,12 +39,25 @@ import {
symbol3 as alias3,
symbol4
} from "File2.sol";
import { GovernorVotesSuperQuorumFraction } from "../../../contracts/governance/extensions/GovernorVotesSuperQuorumFraction.sol";
import { IAccessControl } from "@openzeppelin/contracts/access/IAccessControl.sol";
import {
IERC7579Module,
IERC7579Validator,
IERC7579Execution,
IERC7579AccountConfig,
IERC7579ModuleConfig,
MODULE_TYPE_VALIDATOR,
MODULE_TYPE_EXECUTOR,
MODULE_TYPE_FALLBACK
} from "../../interfaces/draft-IERC7579.sol";

================================================================================
`;

exports[`ImportDirectives.sol format 1`] = `
exports[`ImportDirectives.sol - {"compiler":"0.7.3"} format 1`] = `
====================================options=====================================
compiler: "0.7.3"
parsers: ["slang"]
printWidth: 80
| printWidth
Expand All @@ -39,7 +67,62 @@ import "SomeFile.sol" as SomeOtherFile;
import * as SomeSymbol from "AnotherFile.sol";
import {symbol1 as alias1, symbol2} from "File.sol";
import {symbol1 as alias1, symbol2 as alias2, symbol3 as alias3, symbol4} from "File2.sol";
import {
GovernorVotesSuperQuorumFraction
} from "../../../contracts/governance/extensions/GovernorVotesSuperQuorumFraction.sol";
import {
IAccessControl
} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {
IERC7579Module,
IERC7579Validator,
IERC7579Execution,
IERC7579AccountConfig,
IERC7579ModuleConfig,
MODULE_TYPE_VALIDATOR,
MODULE_TYPE_EXECUTOR,
MODULE_TYPE_FALLBACK
} from "../../interfaces/draft-IERC7579.sol";
=====================================output=====================================
import "SomeFile.sol";
import "SomeFile.sol" as SomeOtherFile;
import * as SomeSymbol from "AnotherFile.sol";
import {symbol1 as alias1, symbol2} from "File.sol";
import {symbol1 as alias1, symbol2 as alias2, symbol3 as alias3, symbol4} from "File2.sol";
import {GovernorVotesSuperQuorumFraction} from "../../../contracts/governance/extensions/GovernorVotesSuperQuorumFraction.sol";
import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {IERC7579Module, IERC7579Validator, IERC7579Execution, IERC7579AccountConfig, IERC7579ModuleConfig, MODULE_TYPE_VALIDATOR, MODULE_TYPE_EXECUTOR, MODULE_TYPE_FALLBACK} from "../../interfaces/draft-IERC7579.sol";

================================================================================
`;

exports[`ImportDirectives.sol format 1`] = `
====================================options=====================================
parsers: ["slang"]
printWidth: 80
| printWidth
=====================================input======================================
import "SomeFile.sol";
import "SomeFile.sol" as SomeOtherFile;
import * as SomeSymbol from "AnotherFile.sol";
import {symbol1 as alias1, symbol2} from "File.sol";
import {symbol1 as alias1, symbol2 as alias2, symbol3 as alias3, symbol4} from "File2.sol";
import {
GovernorVotesSuperQuorumFraction
} from "../../../contracts/governance/extensions/GovernorVotesSuperQuorumFraction.sol";
import {
IAccessControl
} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {
IERC7579Module,
IERC7579Validator,
IERC7579Execution,
IERC7579AccountConfig,
IERC7579ModuleConfig,
MODULE_TYPE_VALIDATOR,
MODULE_TYPE_EXECUTOR,
MODULE_TYPE_FALLBACK
} from "../../interfaces/draft-IERC7579.sol";
=====================================output=====================================
import "SomeFile.sol";
import "SomeFile.sol" as SomeOtherFile;
Expand All @@ -51,6 +134,18 @@ import {
symbol3 as alias3,
symbol4
} from "File2.sol";
import {GovernorVotesSuperQuorumFraction} from "../../../contracts/governance/extensions/GovernorVotesSuperQuorumFraction.sol";
import {IAccessControl} from "@openzeppelin/contracts/access/IAccessControl.sol";
import {
IERC7579Module,
IERC7579Validator,
IERC7579Execution,
IERC7579AccountConfig,
IERC7579ModuleConfig,
MODULE_TYPE_VALIDATOR,
MODULE_TYPE_EXECUTOR,
MODULE_TYPE_FALLBACK
} from "../../interfaces/draft-IERC7579.sol";

================================================================================
`;
1 change: 1 addition & 0 deletions tests/format/ImportDirective/format.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
runFormatTest(import.meta, ['slang']);
runFormatTest(import.meta, ['slang'], { bracketSpacing: true });
runFormatTest(import.meta, ['slang'], { compiler: '0.7.3' });