Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Commit

Permalink
chore(solidity/core/linter-lib): update documentation link
Browse files Browse the repository at this point in the history
  • Loading branch information
0xmemorygrinder committed Jan 10, 2024
1 parent 1225fcb commit 9881658
Show file tree
Hide file tree
Showing 30 changed files with 60 additions and 60 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ impl RuleType for CustomErrors {
.to_string(),
category: "best-practises".to_string(),
example_config: "{\"id\": \"custom-errors\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/custom_errors.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/CustomErrors".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/custom_errors.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/CustomErrors".to_string(),
options: vec![],
examples: Examples {
good: vec![
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ impl RuleType for ExplicitTypes {
.to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"explicit-types\", \"severity\": \"WARNING\", \"data\": \"explicit\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/explicit_types.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/ExplicitTypes".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/explicit_types.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/ExplicitTypes".to_string(),
options: vec![Options {
description: "Options need to be one of \"explicit\", \"implicit\"".to_string(),
default: "explicit".to_string(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ impl RuleType for FunctionMaxLines {
.to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"function-max-lines\", \"severity\": \"WARNING\", \"data\": 20}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/function_max_lines.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/FunctionMaxLines".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/function_max_lines.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/FunctionMaxLines".to_string(),
options: vec![Options {
description: "Maximum allowed lines count per function ".to_string(),
default: "50".to_string(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ impl RuleType for MaxLineLength {
description: "Line length must be no more than maxlen.".to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"max-line-length\", \"severity\": \"WARNING\", \"data\": 80}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/max_line_length.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/MaxLineLength".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/max_line_length.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/MaxLineLength".to_string(),
options: vec![Options {
description: "Maximum allowed number of characters per line".to_string(),
default: "120".to_string(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ impl RuleType for MaxStatesCount {
description: "Contract has \"some count\" states declarations but allowed no more than maxstates.".to_string(),
category: "best-practices".to_string(),
example_config: " {\"id\": \"max-states-count\", \"severity\": \"WARNING\", \"data\": [15]}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/max_states_count.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/MaxStatesCount".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/max_states_count.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/MaxStatesCount".to_string(),
options: vec![Options{description: "Maximum allowed states declarations".to_string(),
default: "15".to_string(),}],
examples: Examples {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ impl RuleType for NoConsole {
description: "No console.log/logInt/logBytesX/logString/etc & No hardhat and forge-std console.sol import statements.".to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"no-console\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/no_console.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/NoConsole".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/no_console.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/NoConsole".to_string(),
options: vec![],
examples: Examples {
good: vec![],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ impl RuleType for NoEmptyBlock {
description: "Code block has zero statements inside. Exceptions apply.".to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"no-empty-block\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/no_empty_block.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/NoEmptyBlock".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/no_empty_block.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/NoEmptyBlock".to_string(),
options: vec![],
examples: Examples {
good: vec![
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ impl RuleType for NoGlobalImport {
.to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"no-global-import\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/no_global_import.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/NoGlobalImport".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/no_global_import.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/NoGlobalImport".to_string(),
options: vec![],
examples: Examples {
good: vec![
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ impl RuleType for OneContractPerFile {
description: "Imported object name is not being used by the contract.".to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"one-contract-per-file\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/one_contract_per_file.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/OneContractPerFile".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/one_contract_per_file.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/OneContractPerFile".to_string(),
options: vec![],
examples: Examples {
good: vec![Example {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ impl RuleType for PayableFallback {
.to_string(),
category: "best-practices".to_string(),
example_config: "{\"id\": \"payable-fallback\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/payable_fallback.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/PayableFallback".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/payable_fallback.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/PayableFallback".to_string(),
options: vec![],
examples: Examples {
good: vec![Example {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,8 +135,8 @@ impl RuleType for ReasonString {
description: "Require or revert statement must have a reason string and check that each reason string is at most N characters long.".to_string(),
category: "best-practices".to_string(),
example_config: " {\"id\": \"reason-string\", \"severity\": \"WARNING\", \"data\": 20}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/reason_string.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/ReasonString".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/best_practices/reason_string.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/ReasonString".to_string(),
options: vec![Options{description: "A JSON object with a single property \"maxLength\" specifying the max number of characters per reason string.".to_string(),
default: "{\"maxLength\":32}".to_string()}],
examples: Examples {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ impl RuleType for ConstNameSnakeCase {
description: "Constant name must be in capitalized SNAKE_CASE. (Does not check IMMUTABLES, use immutable-vars-naming)".to_string(),
category: "naming".to_string(),
example_config: " {\"id\": \"const-name-snakecase\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/naming/const_name_snakecase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/ConstNameSnakecase".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/naming/const_name_snakecase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/ConstNameSnakecase".to_string(),
options: vec![],
examples: Examples {
good: vec![],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ impl RuleType for ContractNameCamelCase {
description: "Contract name must be in CamelCase.".to_string(),
category: "naming".to_string(),
example_config: "{\"id\": \"contract-name-camelcase\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/naming/contract_name_camelcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/ContractNameCamelcase".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/naming/contract_name_camelcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/ContractNameCamelcase".to_string(),
options: vec![],
examples: Examples {
good: vec![],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,8 @@ impl RuleType for EventNameCamelCase {
description: "Event name must be in CamelCase.".to_string(),
category: "naming".to_string(),
example_config: "{\"id\": \"event-name-camelcase\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/naming/event_name_camelcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/EventNameCamelcase".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/naming/event_name_camelcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/EventNameCamelcase".to_string(),
options: vec![],
examples: Examples {
good: vec![],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@ impl RuleType for FoundryTestFunctions {
.to_string(),
category: "naming".to_string(),
example_config: "{\"id\": \"foundry-test-functions\", \"severity\": \"WARNING\", \"data\": [\"setUp\"]}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/naming/foundry_test_functions.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/FoundryTestFunctions".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/naming/foundry_test_functions.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/FoundryTestFunctions".to_string(),
options: vec![Options {
description: "Array of function to be skipped".to_string(),
default: "[]".to_string(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,8 @@ impl RuleType for FuncNameMixedCase {
description: "Function name must be in mixedCase.".to_string(),
category: "naming".to_string(),
example_config: "{\"id\": \"func-name-mixedcase\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/naming/func_name_mixedcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/FuncNameMixedcase".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/naming/func_name_mixedcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/FuncNameMixedcase".to_string(),
options: vec![],
examples: Examples {
good: vec![],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@ impl RuleType for FuncParamNameMixedCase {
description: "Function param name must be in mixedCase.".to_string(),
category: "naming".to_string(),
example_config: "{\"id\": \"func-param-name-mixedcase\", \"severity\": \"WARNING\"}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/naming/func_param_name_mixedcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/FuncParamNameMixedcase".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/naming/func_param_name_mixedcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/FuncParamNameMixedcase".to_string(),
options: vec![],
examples: Examples {
good: vec![],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,8 @@ impl RuleType for ModifierNameMixedcase {
description: "Modifier name must be in mixedCase.".to_string(),
category: "naming".to_string(),
example_config: "{\"id\": \"modifier-name-mixedcase\", \"severity\": \"WARNING\", \"data\": []}".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/dev/toolchains/solidity/core/crates/linter-lib/src/rules/naming/modifier_name_mixedcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/dev/toolchains/solidity/core/crates/linter-lib/testdata/ModifierNameMixedcase".to_string(),
source_link: "https://github.com/astrodevs-labs/osmium/blob/main/toolchains/solidity/core/crates/linter-lib/src/rules/naming/modifier_name_mixedcase.rs".to_string(),
test_link: "https://github.com/astrodevs-labs/osmium/tree/main/toolchains/solidity/core/crates/linter-lib/testdata/ModifierNameMixedcase".to_string(),
options: vec![],
examples: Examples {
good: vec![],
Expand Down
Loading

0 comments on commit 9881658

Please sign in to comment.