pronto-markdownlint 0.0.1 → 0.0.2.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 326824f80e416de98b6b0a2ae1d1ad6a70489ac0fea6d91efe6e8f9845b1c7e7
-  data.tar.gz: 41015ad3f63e109b857987c70b26f8c0c14a64547d9bc9a00bc24fbfafb19c4a
+  metadata.gz: 95554616dc9c03f488477ae94bca6e2eff0424e29260c4c30493f09d2ef12f4c
+  data.tar.gz: d71add36b7a5628b7473fbc87ec662a0a340ca3f203fcd1913365cd8dc0bc749
 SHA512:
-  metadata.gz: e9966e6556cddaad2d56d6079bc4b30cf827f7785243eee7c21da76a88098b0c32680e7e3c18a4445f3de67efb702f451eddf12c31075cf3017f592a356d5baa
-  data.tar.gz: 9b0a99c5a37c2183081d257eed175f81f1202878d5b34b80f62d5d52a522f1c3810f2c23a2cd125c900237e23c950ff7d9b21ad2455b7ade2b2e768f56baf735
+  metadata.gz: c77e47513f2f1a4641b0cef398cb88a1f57c6faf6e2d84e1aa9717d7ed2ed653921200cc3e068f9bf6209792c15e89ddeaddeadeb85ba98efd53694ca1c0f1e5
+  data.tar.gz: 5359b98bc7bd806c412935f4ef76c63be5cddb8ae25e3f6a4dc9228b0eabf7d9f24fb7cc49a696fa666edbc2c419728195f0b621d0fd4c2d9e283efde1222f90

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tem@circleci.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pronto-markdownlint.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Tem
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Pronto runner for stylelint
+
+## Prerequisites
+
+You will need to install [markdownlint](https://github.com/DavidAnson/markdownlint-cli2) with JSON output formatter.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pronto-markdownlint'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pronto-markdownlint
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pronto-markdownlint. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pronto::Markdownlint project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/pronto-markdownlint/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pronto/markdownlint"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pronto/markdownlint.rb

@@ -0,0 +1,52 @@
+require "pronto"
+require "json"
+require "shellwords"
+
+module Pronto
+  class Markdownlint < Runner
+    def run
+      return [] if !@patches || @patches.count.zero?
+
+      @patches
+        .select { |patch| patch.additions > 0 }
+        .select { |patch| style_file?(patch.new_file_full_path) }
+        .map { |patch| inspect(patch) }
+        .flatten.compact
+    end
+
+    private
+
+      def style_file?(file_path)
+        /\.md$/ =~ file_path.to_s
+      end
+
+      def inspect(patch)
+        offences = run_stylelint(patch)
+
+        offences.map do |offence|
+          patch
+            .added_lines
+            .select { |line| line.new_lineno == offence["lineNumber"] }
+            .map { |line| new_message(offence, line) }
+        end
+      end
+
+      def offence_message(offence)
+        message = "#{offence["ruleNames"][0]}/#{offence["ruleNames"][1]} #{offence["ruleDescription"]} #{offence["errorDetail"]}"
+
+        message
+      end
+
+      def new_message(offence, line)
+        path = line.patch.delta.new_file[:path]
+        Message.new(path, line, :warning, offence_message(offence), nil, self.class)
+      end
+
+      def run_stylelint(patch)
+        escaped_file_path = Shellwords.escape(patch.new_file_full_path.to_s)
+        `markdownlint-cli2 #{escaped_file_path}`
+
+        JSON.parse(File.read("./markdownlint-results.json"))
+      end
+  end
+end

data/lib/pronto/markdownlint/version.rb

@@ -0,0 +1,5 @@
+module Pronto
+  module MarkdownlintVersion
+    VERSION = "0.0.2-beta"
+  end
+end

data/pronto-markdownlint.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pronto/markdownlint/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pronto-markdownlint"
+  spec.version       = Pronto::MarkdownlintVersion::VERSION
+  spec.authors       = ["Temuulen Enkhee"]
+  spec.email         = ["temulen.mr@gmail.com"]
+
+  spec.summary       = %q{Pronto runner for markdownlint}
+  spec.homepage      = "https://github.com/teka23/pronto-markdownlint"
+  spec.license       = "MIT"
+
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pronto"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pronto-markdownlint
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2.pre.beta
 platform: ruby
 authors:
 - Temuulen Enkhee
@@ -10,6 +10,48 @@ bindir: bin
 cert_chain: []
 date: 2021-03-24 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: pronto
   requirement: !ruby/object:Gem::Requirement
@@ -17,7 +59,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -26,11 +68,22 @@ dependencies:
         version: '0'
 description: 
 email:
-- tem@circleci.com
+- temulen.mr@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pronto/markdownlint.rb
+- lib/pronto/markdownlint/version.rb
+- pronto-markdownlint.gemspec
 homepage: https://github.com/teka23/pronto-markdownlint
 licenses:
 - MIT
@@ -43,12 +96,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
 signing_key: