https://github.com/alexhcjp/markup_analyzer
https://github.com/alexhcjp/markup_analyzer
flutter linter
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/alexhcjp/markup_analyzer
- Owner: AlexHCJP
- License: bsd-3-clause
- Created: 2024-05-07T20:57:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-06-19T06:08:08.000Z (about 1 year ago)
- Last Synced: 2025-06-29T23:34:49.695Z (about 1 year ago)
- Topics: flutter, linter
- Language: Dart
- Size: 435 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# MarkupAnalyzer Lint Rule
[](https://codecov.io/gh/AlexHCJP/markup_analyzer)
## Description
`Markup Analyzer` is a customizable lint rule for the [`custom_lint`](https://pub.dev/packages/custom_lint) package in Dart/Flutter. It allows you to prohibit specific types of string expressions in the parameters of Flutter widgets.
This rule enables you to control the usage of string expressions such as simple string literals, interpolations, binary expressions, and others based on your configuration.
- [MarkupAnalyzer Lint Rule](#markupanalyzer-lint-rule)
- [Description](#description)
- [Installation](#installation)
- [Configuration](#configuration)
- [Usage](#usage)
- [Examples](#examples)
- [1. Simple String Literals (`simple`)](#1-simple-string-literals-simple)
- [2. Prefixed Identifiers (`prefixed_identifier`)](#2-prefixed-identifiers-prefixed_identifier)
- [3. String Interpolation (`interpolation`)](#3-string-interpolation-interpolation)
- [4. Binary Expressions (`binary`)](#4-binary-expressions-binary)
- [5. Adjacent Strings (`adjacent`)](#5-adjacent-strings-adjacent)
- [6. Method Invocations (`method`)](#6-method-invocations-method)
- [7. Simple Identifiers (`simple_identifier`)](#7-simple-identifiers-simple_identifier)
- [8. Function Invocations (`function`)](#8-function-invocations-function)
## Installation
1. **Add the package to your project's dependencies:**
Add the following to your project's `pubspec.yaml` under `dev_dependencies`:
```yaml
dev_dependencies:
custom_lint:
markup_analyzer: ^latest_version
```
2. **Get the dependencies:**
```bash
flutter pub get
```
3. **Activate the plugin in `analysis_options.yaml`:**
Create or update the `analysis_options.yaml` file at the root of your project:
```yaml
analyzer:
plugins:
- custom_lint
custom_lint:
rules:
- markup_analyzer
```
## Configuration
You can configure the `MarkupAnalyzer` rule via `analysis_options.yaml` by specifying which types of string expressions should be prohibited and the severity level of the error.
Example of a full configuration:
```yaml
custom_lint:
rules:
- markup_analyzer:
simple: error
interpolation: warning
binary: warning
adjacent: warning
prefixed_identifier: none
method: none
simple_identifier: none
function: none
```
## Usage
After setting up the plugin and configuring the rules, run the analyzer on your project:
```bash
dart run custom_lint
```
All rule violations will be displayed in the console and highlighted in your IDE if it supports `custom_lint`.
## Examples
### 1. Simple String Literals (`simple`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
simple: error
```
```dart
// BAD
Text('Hello, world!'); // Simple string literal is prohibited.
// OR GOOD
Text(AppLocalizations.of(context).greeting)
```
### 2. Prefixed Identifiers (`prefixed_identifier`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
prefixed_identifier: error
```
```dart
// ERROR
Text(widget.title); // Prefixed identifier is prohibited.
```
### 3. String Interpolation (`interpolation`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
interpolation: error
```
```dart
// BAD
Text('Hello, $name!'); // String interpolation is prohibited.
// GOOD
Text(AppLocalizations.of(context).helloWithName(name)); // Use string concatenation instead.
```
### 4. Binary Expressions (`binary`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
binary: error
```
```dart
// ERROR
Text('Hello, ' + 'world!'); // Binary expression with '+' is prohibited.
```
### 5. Adjacent Strings (`adjacent`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
adjacent: error
```
```dart
// ERROR
Text(
'Hello, '
'world!'
); // Adjacent strings are prohibited.
```
### 6. Method Invocations (`method`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
method: error
```
```dart
// BAD
Text('hello'.tr()); // Method invocation is prohibited.
//GOOD
Text(AppLocalizations.of(context).hello)
```
### 7. Simple Identifiers (`simple_identifier`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
simple_identifier: error
```
```dart
// ERROR
Text(title); // Simple identifier is prohibited.
```
### 8. Function Invocations (`function`)
**Configuration:**
```yaml
custom_lint:
rules:
markup_analyzer:
function: error
```
```dart
// ERROR
Text(() { return 'Hello' } ()); // Function invocation is prohibited.
```
