eslint-plugin-sf-plugin/dist/rules/migration/no-filepath-flags.js

Helpful eslint rules for sf plugins.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.noFilepathFlags = void 0;
/*
 * Copyright (c) 2020, salesforce.com, inc.
 * All rights reserved.
 * Licensed under the BSD 3-Clause license.
 * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
 */
const eslint_utils_1 = require("@typescript-eslint/utils/eslint-utils");
const commands_1 = require("../../shared/commands");
const flags_1 = require("../../shared/flags");
exports.noFilepathFlags = eslint_utils_1.RuleCreator.withoutDocs({
    meta: {
        docs: {
            description: 'Change filepath flag to file flag',
            recommended: 'recommended',
        },
        messages: {
            message: 'filepath flags are not available on sfCommand.  Use file instead',
        },
        type: 'problem',
        schema: [],
        fixable: 'code',
    },
    defaultOptions: [],
    create(context) {
        return (0, commands_1.isInCommandDirectory)(context)
            ? {
                Property(node) {
                    if ((0, flags_1.isFlag)(node) && (0, commands_1.ancestorsContainsSfCommand)(context)) {
                        const toReplace = (0, flags_1.getCalleePropertyByName)(node, 'filepath');
                        if (toReplace) {
                            context.report({
                                node: toReplace,
                                messageId: 'message',
                                fix: (fixer) => fixer.replaceText(toReplace, 'file'),
                            });
                        }
                    }
                },
            }
            : {};
    },
});