PreferCurlyApostropheRule class

Warns when straight apostrophes are used instead of stylized (curly) apostrophes

Since: v4.2.3 | Updated: v4.13.0 | Rule version: v4

in string literals.

This is an opinionated rule - not included in any tier by default.

For user-facing strings, Right Single Quotation Mark (\u2019) (U+2019) provides better typography than straight ASCII apostrophes (') (U+0027). This is the inverse of PreferStraightApostropheRule.

Pros of curly apostrophes in strings:

• Better typography in user-facing text
• Professional appearance
• Common in publishing and design
• More readable for prose

Cons (why some teams avoid them):

• Code convention is straight apostrophes
• Harder to type on some keyboards
• May not display correctly in some contexts
• Can be confusing when mixed with code

Quick fix available: Replaces straight apostrophes with curly ones in common contractions and proper names.

Example

BAD (with this rule enabled):

String message = "It's a beautiful day";  // Straight ASCII apostrophe (U+0027)
String name = "O'Brien";                   // Straight ASCII apostrophe (U+0027)

GOOD:

String message = "It's a beautiful day";  // Right Single Quotation Mark (U+2019)
String name = "O'Brien";                   // Right Single Quotation Mark (U+2019)

Inheritance

• Object
• SaropaLintRule
• PreferCurlyApostropheRule

Constructors

PreferCurlyApostropheRule()

Properties

accuracyTarget → AccuracyTarget?

Optional accuracy target for this rule (for documentation and tooling). Does not enforce; used by reports and rule-audit scripts.

no setter, inherited

applicableFileTypes → Set<FileType>?

The file types this rule applies to.

no setter, inherited

canUseParsedResult → bool

Indicates whether this analysis rule can work with just the parsed information or if it requires a resolved unit.

no setter, inherited

certIds → List<String>

CERT coding standard identifiers (e.g. STR02-C). Populate only where there is a clear mapping; leave empty for most rules initially.

no setter, inherited

code → LintCode

The lint code for this rule.

no setter, inherited

configAliases → List<String>

Alternate config keys that can be used to reference this rule.

no setter, inherited

conflictingRules → List<String>

Curated opposite/competing rule names.

no setter, override

cost → RuleCost

The estimated execution cost of this rule.

no setter, override

cweIds → List<int>

CWE identifiers this rule helps prevent or detect. https://cwe.mitre.org/ — e.g. CWE-798 (Hardcoded Credentials).

no setter, inherited

description → String

Short description suitable for display in console output and IDEs.

final, inherited

diagnosticCode → DiagnosticCode

The code to report for a violation.

no setter, inherited

diagnosticCodes → List<DiagnosticCode>

The diagnostic codes associated with this analysis rule.

no setter, inherited

documentationUrl → String

Returns the documentation URL for this rule.

no setter, inherited

effectiveSeverity → DiagnosticSeverity?

Get the effective severity for this rule, considering overrides.

no setter, inherited

exampleBad → String

Short code example that VIOLATES this rule (shown in CLI walkthrough).

no setter, override

exampleGood → String

Short code example of COMPLIANT code (shown in CLI walkthrough).

no setter, override

fixGenerators → List<SaropaFixGenerator>

Fix producer generators for this rule.

no setter, override

hashCode → int

The hash code for this object.

no setter, inherited

hyphenatedName → String

Returns the rule name in hyphenated format for display.

no setter, inherited

impact → LintImpact

Stylistic rule - style/consistency issues are acceptable in legacy code.

no setter, override

incompatibleRules → List<String>

A list of incompatible rule names.

no setter, inherited

isDisabled → bool

Check if this rule is disabled via configuration.

no setter, inherited

maximumLineCount → int

Maximum line count for this rule to run.

no setter, inherited

minimumLineCount → int

Minimum line count for this rule to run.

no setter, inherited

name → String

The rule name.

final, inherited

owasp → OwaspMapping?

OWASP categories this rule helps prevent.

no setter, inherited

pubspecVisitor → PubspecVisitor?

A visitor that visits a Pubspec to perform analysis.

no setter, inherited

relatedRules → List<String>

Curated "see also" rule names for discoverability in docs/IDE tooling.

no setter, inherited

reporter ← DiagnosticReporter

Sets the DiagnosticReporter for the CompilationUnit currently being visited.

no getter, inherited

requiredPatterns → Set<String>?

String patterns that must be present in the file for this rule to run.

no setter, inherited

requiresAsync → bool

Whether this rule only applies to async code.

no setter, inherited

requiresBlocImport → bool

Whether this rule only applies to files that import Bloc.

no setter, inherited

requiresClassDeclaration → bool

Whether this rule only applies to files with class declarations.

no setter, inherited

requiresFlutterImport → bool

Whether this rule only applies to files that import Flutter.

no setter, inherited

requiresImports → bool

Whether this rule only applies to files with imports.

no setter, inherited

requiresMainFunction → bool

Whether this rule only applies to files with a main() function.

no setter, inherited

requiresProviderImport → bool

Whether this rule only applies to files that import Provider.

no setter, inherited

requiresRiverpodImport → bool

Whether this rule only applies to files that import Riverpod.

no setter, inherited

requiresWidgets → bool

Whether this rule only applies to Flutter widget code.

no setter, inherited

ruleStatus → RuleStatus

Lifecycle status. Default RuleStatus.ready. Use RuleStatus.beta for new or heuristic-heavy rules; RuleStatus.deprecated for sunset.

no setter, inherited

ruleType → RuleType?

Semantic type of this rule. Default null = unspecified (legacy). When set, used for quality gates, accuracy targets, and reporting.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

skipExampleFiles → bool

Whether to skip example files (example/**).

no setter, inherited

skipFixtureFiles → bool

Whether to skip fixture files (fixture/, fixtures/).

no setter, inherited

skipGeneratedCode → bool

Whether to skip generated files (*.g.dart, *.freezed.dart, *.gen.dart).

no setter, inherited

skipTestFiles → bool

Whether to skip test files (*_test.dart, test/**).

no setter, inherited

state → RuleState

The state of this analysis rule.

final, inherited

supersedesRules → List<String>

Rule names this rule supersedes/replaces.

no setter, inherited

tags → Set<String>

Tags for filtering and discovery (e.g. in docs, IDE, or CI). Examples: 'performance', 'accessibility', 'suspicious', 'convention'.

no setter, override

testRelevance → TestRelevance

How this rule relates to test files.

no setter, inherited

usesTypeResolution → bool

Whether this rule triggers lazy cross-library type resolution in the analyzer (e.g. .staticType, .library, .allSupertypes, .enclosingElement).

no setter, override

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerNodeProcessors(RuleVisitorRegistry registry, RuleContext context) → void

Registers node processors in the given registry.

inherited

registerNodeProcessors2(RuleVisitorRegistry2 registry, RuleContext context) → void

Registers node processors in the given registry.

inherited

reportAtNode(AstNode? node, {List<Object> arguments = const [], List<DiagnosticMessage>? contextMessages}) → Diagnostic?

Reports a diagnostic at node with message arguments and contextMessages.

inherited

reportAtOffset(int offset, int length, {List<Object> arguments = const [], List<DiagnosticMessage>? contextMessages}) → Diagnostic

Reports a diagnostic at offset, with length, with message arguments and contextMessages.

inherited

reportAtPubNode(PubspecNode node, {List<Object> arguments = const [], List<DiagnosticMessage> contextMessages = const []}) → Diagnostic

Reports a diagnostic at Pubspec node, with message arguments and contextMessages.

inherited

reportAtSourceRange(SourceRange sourceRange, {List<Object> arguments = const [], List<DiagnosticMessage>? contextMessages}) → Diagnostic

Reports a diagnostic at sourceRange, with message arguments and contextMessages.

inherited

reportAtToken(Token token, {List<Object> arguments = const [], List<DiagnosticMessage>? contextMessages}) → Diagnostic?

Reports a diagnostic at token, with message arguments and contextMessages.

inherited

runWithReporter(SaropaDiagnosticReporter reporter, SaropaContext context) → void

Override this method to implement your lint rule.

override

shouldSkipFile(String path) → bool

Check if a file path should be skipped based on context settings.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

curlyApostrophe → const String

Unicode Right Single Quotation Mark (U+2019)

straightApostrophe → const String

ASCII straight apostrophe (U+0027)