@slippy-lint/slippy/dist/rules/no-default-visibility.js

A simple but powerful linter for Solidity

import { StateVariableDefinition } from "@nomicfoundation/slang/ast";
import { hasDefaultVisibility } from "../slang/state-variables.js";
import { assertNonterminalNode, NonterminalKind, TerminalKind, TerminalKindExtensions, } from "@nomicfoundation/slang/cst";
export const NoDefaultVisibility = {
    name: "no-default-visibility",
    recommended: true,
    create: function () {
        return new NoDefaultVisibilityRule(this.name);
    },
};
class NoDefaultVisibilityRule {
    constructor(name) {
        this.name = name;
    }
    run({ content, file }) {
        const diagnostics = [];
        const cursor = file.createTreeCursor();
        while (cursor.goToNextNonterminalWithKind(NonterminalKind.StateVariableDefinition)) {
            assertNonterminalNode(cursor.node);
            const stateVariableDefinition = new StateVariableDefinition(cursor.node);
            const defaultVisibility = hasDefaultVisibility(stateVariableDefinition);
            if (defaultVisibility) {
                const nameCursor = getNameCursor(cursor.spawn(), stateVariableDefinition);
                const name = nameCursor.node.unparse();
                const firstTerminalCursor = cursor.spawn();
                while (firstTerminalCursor.goToNextTerminal() &&
                    firstTerminalCursor.node.isTerminalNode() &&
                    TerminalKindExtensions.isTrivia(firstTerminalCursor.node.kind)) {
                    // ignore trivia
                }
                const insertionPoint = nameCursor.textRange.start.utf16;
                const charBeforeInsertionPoint = content[insertionPoint - 1];
                const hasNonWhitespaceBefore = charBeforeInsertionPoint !== undefined &&
                    charBeforeInsertionPoint.match(/\S/) !== null;
                diagnostics.push({
                    rule: this.name,
                    sourceId: file.id,
                    line: firstTerminalCursor.textRange.start.line,
                    column: firstTerminalCursor.textRange.start.column,
                    message: `State variable '${name}' has default visibility`,
                    fix: [
                        {
                            range: [insertionPoint, insertionPoint],
                            replacement: hasNonWhitespaceBefore ? " public " : "public ",
                        },
                    ],
                });
            }
        }
        return diagnostics;
    }
}
function getNameCursor(cursor, stateVariableDefinition) {
    const nameId = stateVariableDefinition.name.id;
    while (cursor.node.id !== nameId &&
        cursor.goToNextTerminalWithKind(TerminalKind.Identifier)) {
        // iterate to the name
    }
    return cursor;
}
//# sourceMappingURL=no-default-visibility.js.map