Skip to content

Commit bdb895a

Browse files
Re-generate README documentation
1 parent 7833cff commit bdb895a

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed

README.md

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ To indicate that your project is using Solid Lints, you can use the following ba
4040
```markdown
4141
[![style: solid](https://img.shields.io/badge/style-solid-orange)](https://pub.dev/packages/solid_lints)
4242
```
43-
4443
# Solid Lints Documentation
4544

4645
## Table of contents:
@@ -54,20 +53,21 @@ To indicate that your project is using Solid Lints, you can use the following ba
5453
7. [avoid_unnecessary_type_casts](#avoid_unnecessary_type_casts)
5554
8. [avoid_unrelated_type_assertions](#avoid_unrelated_type_assertions)
5655
9. [avoid_unused_parameters](#avoid_unused_parameters)
57-
10. [cyclomatic_complexity](#cyclomatic_complexity)
58-
11. [double_literal_format](#double_literal_format)
59-
12. [function_lines_of_code](#function_lines_of_code)
60-
13. [member_ordering](#member_ordering)
61-
14. [newline_before_return](#newline_before_return)
62-
15. [no_empty_block](#no_empty_block)
63-
16. [no_equal_then_else](#no_equal_then_else)
64-
17. [no_magic_number](#no_magic_number)
65-
18. [number_of_parameters](#number_of_parameters)
66-
19. [prefer_conditional_expressions](#prefer_conditional_expressions)
67-
20. [prefer_first](#prefer_first)
68-
21. [prefer_last](#prefer_last)
69-
22. [prefer_match_file_name](#prefer_match_file_name)
70-
23. [proper_super_calls](#proper_super_calls)
56+
10. [avoid_using_api](#avoid_using_api)
57+
11. [cyclomatic_complexity](#cyclomatic_complexity)
58+
12. [double_literal_format](#double_literal_format)
59+
13. [function_lines_of_code](#function_lines_of_code)
60+
14. [member_ordering](#member_ordering)
61+
15. [newline_before_return](#newline_before_return)
62+
16. [no_empty_block](#no_empty_block)
63+
17. [no_equal_then_else](#no_equal_then_else)
64+
18. [no_magic_number](#no_magic_number)
65+
19. [number_of_parameters](#number_of_parameters)
66+
20. [prefer_conditional_expressions](#prefer_conditional_expressions)
67+
21. [prefer_first](#prefer_first)
68+
22. [prefer_last](#prefer_last)
69+
23. [prefer_match_file_name](#prefer_match_file_name)
70+
24. [proper_super_calls](#proper_super_calls)
7171

7272
---
7373

@@ -106,9 +106,9 @@ inside those methods.
106106

107107
Cases where setState is unnecessary:
108108
- synchronous calls inside State lifecycle methods:
109-
- initState
110-
- didUpdateWidget
111-
- didChangeDependencies
109+
- initState
110+
- didUpdateWidget
111+
- didChangeDependencies
112112
- synchronous calls inside `build` method
113113

114114
Nested synchronous setState invocations are also disallowed.
@@ -157,6 +157,16 @@ A `avoid_unused_parameters` rule which
157157
warns about unused parameters
158158

159159

160+
## avoid_using_api
161+
A `avoid_using_api` rule which
162+
warns about usage of avoided APIs
163+
### Parameters:
164+
- **entries** (_List<AvoidUsingApiEntryParameters>_)
165+
A list of BannedCodeOption parameters.
166+
- **severity** (_ErrorSeverity?_)
167+
The default severity of the lint for each entry.
168+
169+
160170
## cyclomatic_complexity
161171
A Complexity metric checks content of block and detects more easier solution
162172
### Parameters:

0 commit comments

Comments
 (0)