Sha256: fd2735e037ce7b6b9271fd0c9650075532bdef48f1e0b11b7ef9e1f751d70d9a

Contents?: true

Size: 1.29 KB

Versions: 17

Compression:

Stored size: 1.29 KB

Contents

# JavaScript's configuration

Inch::Config.register(:javascript) do
  codebase do
    object_provider :JSDoc
    include_files   ['src/**/*.js']
    exclude_files   []
  end

  evaluation do
    schema(:MemberObject) do
      docstring           1.0

      # optional:
      code_example_single 0.1
      code_example_multi  0.2
      unconsidered_tag    0.2
    end

    schema(:ModuleObject) do
      docstring           1.0

      # optional:
      code_example_single 0.1
      code_example_multi  0.2
      unconsidered_tag    0.2
    end

    schema(:ClassObject) do
      docstring           1.0

      # optional:
      code_example_single 0.1
      code_example_multi  0.2
      unconsidered_tag    0.2
    end

    schema(:FunctionObject) do
      docstring           0.5
      parameters          0.4
      return_type         0.1
      return_description  0.3

      if object.questioning_name?
        parameters          parameters + return_type
        return_type         0.0
      end

      if !object.has_parameters? || object.setter?
        return_description  docstring + parameters
        docstring           docstring + parameters
        parameters          0.0
      end

      # optional:
      code_example_single 0.1
      code_example_multi  0.25
      unconsidered_tag    0.2
    end
  end
end

Version data entries

17 entries across 17 versions & 1 rubygems

Version Path
inch-0.9.0.rc1 config/javascript.rb
inch-0.8.0 config/javascript.rb
inch-0.8.0.rc2 config/javascript.rb
inch-0.8.0.rc1 config/javascript.rb
inch-0.7.1 config/javascript.rb
inch-0.7.0 config/javascript.rb
inch-0.6.4 config/javascript.rb
inch-0.6.3 config/javascript.rb
inch-0.6.2 config/javascript.rb
inch-0.6.1 config/javascript.rb
inch-0.6.0 config/javascript.rb
inch-0.6.0.rc6 config/javascript.rb
inch-0.6.0.rc5 config/javascript.rb
inch-0.6.0.rc4 config/javascript.rb
inch-0.6.0.rc3 config/javascript.rb
inch-0.6.0.rc2 config/javascript.rb
inch-0.6.0.rc1 config/javascript.rb