Sign upLogin

devedbox/Commander

View on GitHub
Star

Showing 375 of 376 total issues

Function split has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

  public func split(delimiter: Character, omittingEmptySubsequences: Bool = true) -> [String] {
    var isEscaping: Bool = false
    var isQuoting: Bool = false
    var iterator = makeIterator()
    var results: [String] = []
Severity: Minor
Found in Sources/Utility/String+.swift - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function describe has a Cognitive Complexity of 16 (exceeds 5 allowed). Consider refactoring.
Open

  internal func describe(_ command: CommandDescribable.Type, path: String = "", usagePath: String? = nil) -> String {
    let optionsFormat: (symbol: String, short: String) = (
      OptionsDecoder.optionsFormat.symbol,
      OptionsDecoder.optionsFormat.shortSymbol
    )
Severity: Minor
Found in Sources/Commander/Commands/CommandDescriber.swift - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function camelcase2dashcase has a Cognitive Complexity of 8 (exceeds 5 allowed). Consider refactoring.
Open

  public func camelcase2dashcase() -> String {
    var separatedComponent: [String] = []
    var index = self.startIndex
    
    while index < self.endIndex {
Severity: Minor
Found in Sources/Utility/String+.swift - About 45 mins to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

extension OptionsRepresentable where ArgumentsResolver == Commander.ArgumentsResolver<DefaultOptions.None> {
  /// The arguments of the options if arguments can be resolved.
  public var arguments: [ArgumentsResolver.Argument] {
    get { return [] }
    set { }
Severity: Minor
Found in Sources/Commander/Options/DefaultOptions.swift and 1 other location - About 45 mins to fix
Sources/Commander/Options/DefaultOptions.swift on lines 79..85

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 53.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Similar blocks of code found in 2 locations. Consider refactoring.
Open

extension OptionsRepresentable where ArgumentsResolver == Commander.ArgumentsResolver<DefaultOptions.Empty> {
  /// The arguments of the options if arguments can be resolved.
  public var arguments: [ArgumentsResolver.Argument] {
    get { return [] }
    set { }
Severity: Minor
Found in Sources/Commander/Options/DefaultOptions.swift and 1 other location - About 45 mins to fix
Sources/Commander/Options/DefaultOptions.swift on lines 71..77

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 53.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Commander/Commands/CommandDescriber.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Commander/Built-Ins/Commands/Complete.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Commander/Built-Ins/Commands/Complete.swift by swiftlint

Opening braces should be preceded by a single space and on the same line as the declaration.
Open

  {
Severity: Minor
Found in Sources/Commander/Options/OptionDescription.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Commander/Commander.swift by swiftlint

Line should be 120 characters or less: currently 135 characters
Open

      return "Unrecognized options\(path == nil ? "" : " for command '\(path!.command.symbol)'"): '\(options.joined(separator: " "))'."
Severity: Minor
Found in Sources/Commander/Error.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/commander-sample/SampleCommand.swift by swiftlint

Opening braces should be preceded by a single space and on the same line as the declaration.
Open

    \(optionsSymbols.map    { intents(2) + $0.0.merging(alignment) + intents(1) + $0.1 }.joined(separator: "\n"))
Severity: Minor
Found in Sources/Commander/Commands/CommandDescriber.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Commander/Commands/CommandDescriber.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Commander/Built-Ins/Commands/Complete.swift by swiftlint

Variable name should be between 3 and 40 characters long: 'k'
Open

  var k: String? { get }
Severity: Critical
Found in Sources/Commander/Options/Option.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Commander/Commander.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Utility/String+.swift by swiftlint

Lines should not have trailing whitespace.
Open
Severity: Minor
Found in Sources/Utility/String+.swift by swiftlint

Variable name should only contain alphanumeric characters: '_ArgumentsStorage'
Open

internal var _ArgumentsStorage: [AnyHashable: Any] = [:]
Severity: Critical
Found in Sources/Commander/Options/OptionsRepresentable.swift by swiftlint
Severity
Category
Status
Source
Language