https://github.com/jWinterDay/cool_linter
linter for dart code
https://github.com/jWinterDay/cool_linter
code-checker dart flutter linter
Last synced: 11 months ago
JSON representation
linter for dart code
- Host: GitHub
- URL: https://github.com/jWinterDay/cool_linter
- Owner: jWinterDay
- License: mit
- Created: 2021-04-04T12:11:03.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T07:55:28.000Z (over 1 year ago)
- Last Synced: 2024-11-03T23:34:43.437Z (over 1 year ago)
- Topics: code-checker, dart, flutter, linter
- Language: Dart
- Homepage: https://pub.dev/packages/cool_linter
- Size: 1.39 MB
- Stars: 9
- Watchers: 2
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://pub.dev/packages/cool_linter/)
[](https://pub.dev/packages/cool_linter/)
[](https://pub.dev/packages/cool_linter/score)
# Cool linter
This is a custom linter [package](https://pub.dev/packages/cool_linter) for dart/flutter code. It can set linter for exclude some of words. This words you can set
in analysis_options.yaml by example below
## Usage
### 1. Add dependency to `pubspec.yaml`
```yaml
dev_dependencies:
cool_linter: ^1.2.0 # last version of plugin
```
### 2. Add configuration to `analysis_options.yaml`
```yaml
analyzer:
plugins:
- cool_linter
cool_linter:
extended_rules:
- always_specify_stream_subscription
- prefer_trailing_comma
always_specify_types:
- typed_literal
- declared_identifier
- set_or_map_literal
- simple_formal_parameter
- type_name
- variable_declaration_list
regexp_exclude:
-
pattern: Colors
hint: Use colors from design system instead!
severity: WARNING
-
pattern: Test123{1}
severity: ERROR
exclude_folders:
- test/**
- lib/ku/**
```
1. ### **always_specify_types linter**:
[always_specify_types](https://dart-lang.github.io/linter/lints/always_specify_types.html)
This rule is like dart core linter rule, but you can choose which of this subrules want to use:
* typed_literal
* declared_identifier
* set_or_map_literal
* simple_formal_parameter
* type_name
* variable_declaration_list
Also you can choose exclude folders for this rule. See `exclude_folders`
2. ### **regexp_exclude linter**:
* `pattern` - RegExp-pattern, for example: Test123{1}, ^Test123$ and others
* `severity` - [optional parameter]. It is console information level. May be `WARNING`, `INFO`, `ERROR`. Default is WARNING
* `hint` - [optional parameter]. It is console information sentence
* `exclude_folders` - this folders linter will ignore. By default excluded folders are:
```dart
'.dart_tool/**',
'.vscode/**',
'packages/**',
'ios/**',
'macos/**',
'web/**',
'linux/**',
'windows/**',
'go/**',
```
3. ### extended_rules. **always_specify_stream_subscription** linter:
Always use `StreamSubscription` for Stream.listen();
CORRECT:
```dart
final Stream stream2 = Stream.value('value');
final StreamSubscription sub = stream2.listen((_) {}); // OK
```
WARNING:
```dart
final Stream stream1 = Stream.value('value');
stream1.listen((String ttt) {}); // LINT
```
## :warning: Attention!!!
### You must restart your IDE for starting plugin
# 3. CLI
You can use linter as command line tool
```dart bin/cool_linter_cli.dart analyze -tsc -d test/fix/result --regexp_path test/regexp/regexp_settings_cli.yaml```
[or using dart pub run](https://pub.dev/packages/cool_linter/install)
:muscle: available autofix :muscle: for:
- **prefer_trailing_comma**
- **always_specify_types_rule**
for this subrules: ```declared_identifier``` ```simple_formal_parameter``` ```variable_declaration_list```
for others subrules feel free to provide me PRs
`Available options`:
* `-d` - Folder to analyze
* `-f` - Fix issues. Now only for prefer_trailing_comma rule
* `-t` - Use always_specify_types_rule rule
* `-s` - Use always_specify_stream_subscription rule
* `-c` - Use prefer_trailing_comma rule
* `-f` - Fix issues. Now only for prefer_trailing_comma rule
* `--regexp_path` - Path to file with RegExp settings
Also you must specify ```--regexp_path``` parameter if you want to regexp analyzer.
Example: ```--regexp_path ```
```yaml
regexp_exclude:
-
pattern: Colors
hint: Use colors from design system instead!
severity: WARNING
-
pattern: \sTestClass\s
hint: Dont use TestClass
severity: ERROR
-
pattern: \sTestClass2\s
hint: Dont use TestClass2
severity: INFO
```
# 4. Result
Example of analysis_options.yaml
```yaml
analyzer:
plugins:
- cool_linter
cool_linter:
extended_rules:
- always_specify_stream_subscription
- prefer_trailing_comma
always_specify_types:
- typed_literal
- declared_identifier
- set_or_map_literal
- simple_formal_parameter
- type_name
- variable_declaration_list
regexp_exclude:
-
pattern: Colors
hint: Use colors from design system instead!
severity: WARNING
-
pattern: Test123{1}
severity: ERROR
exclude_folders:
- test/**
- lib/ku/**
```
