/*
* Copyright 2025, Salesforce, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { CodeAnalysisBaseIssueType } from '../../schemas/analysisSchema.js';
import dedent from 'dedent';
export interface RuleConfig {
id: string; //ESLint rule id
config: CodeAnalysisBaseIssueType;
}
// ********** Rules: no-private-wire-config-property **********
const NO_PRIVATE_WIRE_CONFIG_RULE_ID = '@salesforce/lwc-graph-analyzer/no-private-wire-config-property';
const noPrivateWireRule: CodeAnalysisBaseIssueType = {
type: 'Private Wire Configuration Property',
description:
'Properties used in wire configurations must be decorated with @api to be public and resolvable by the wire service.',
intentAnalysis:
'The developer used properties in wire configurations without making them public using the @api decorator.',
suggestedAction: dedent`
Make the properties public by using the @api decorator:
- Add @api decorator to properties used in wire configurations
`,
};
// ********** Rules: no-wire-config-references-non-local-property-reactive-value **********
const NO_WIRE_CONFIG_REFERENCES_NON_LOCAL_PROPERTY_REACTIVE_VALUE_RULE_ID =
'@salesforce/lwc-graph-analyzer/no-wire-config-references-non-local-property-reactive-value';
const noWireConfigReferenceNonLocalPropertyRule: CodeAnalysisBaseIssueType = {
type: 'Wire Configuration References Non-Local Property',
description:
'Wire configurations with reactive values ($prop) must reference only component properties, not imported values or values defined outside the component class.',
intentAnalysis:
'The developer is trying to use a non-local value (imported or module-level) as a reactive parameter in a wire configuration.',
suggestedAction: dedent`
Wrap the non-local value in a getter:
- Introduce a getter which returns the imported value or the value of a module-level constant
- Update the wire configuration to use the getter name as the reactive parameter
Example:
// Instead of:
@wire(getData, { param: '$importedValue' })
// Use:
get localValue() {
return importedValue;
}
@wire(getData, { param: '$localValue' })
`,
};
const noPrivateWireRuleConfig: RuleConfig = {
id: NO_PRIVATE_WIRE_CONFIG_RULE_ID,
config: noPrivateWireRule,
};
const noWireConfigReferenceNonLocalPropertyRuleConfig: RuleConfig = {
id: NO_WIRE_CONFIG_REFERENCES_NON_LOCAL_PROPERTY_REACTIVE_VALUE_RULE_ID,
config: noWireConfigReferenceNonLocalPropertyRule,
};
export const ruleConfigs: RuleConfig[] = [noPrivateWireRuleConfig, noWireConfigReferenceNonLocalPropertyRuleConfig];
