From c179a1dbf2f92939cd1a99d746985a6d41a7528d Mon Sep 17 00:00:00 2001 From: dblock Date: Fri, 5 Jan 2018 15:36:55 -0500 Subject: [PATCH] Swap yard dependency for danger-toc. --- CHANGELOG.md | 1 + Dangerfile | 2 +- Gemfile | 3 +-- README.md | 33 ++++++++++++++++----------------- Rakefile | 7 ------- 5 files changed, 19 insertions(+), 27 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 92ac1e1..9883d22 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,7 @@ ### 0.8.7 (Next) * [#131](https://github.com/codegram/hyperclient/pull/131): Upgrade to Rubocop 0.50.0, fix Bundler's insecure git source warning - [@nebolsin](https://github.com/nebolsin). +* [#132](https://github.com/codegram/hyperclient/pull/132): Swapped yard dependency for danger-toc - [@dblock](https://github.com/dblock). * Your contribution here. ### 0.8.6 (August 27, 2017) diff --git a/Dangerfile b/Dangerfile index 3fed23b..7f3f1ad 100644 --- a/Dangerfile +++ b/Dangerfile @@ -1,2 +1,2 @@ -# check for changes in CHANGELOG changelog.check +toc.check diff --git a/Gemfile b/Gemfile index b545ce1..463d91c 100644 --- a/Gemfile +++ b/Gemfile @@ -18,12 +18,11 @@ group :development, :test do gem 'rake' gem 'rubocop', '~> 0.50.0', require: false gem 'simplecov', require: false - gem 'yard', '~> 0.8' - gem 'yard-tomdoc' end group :test do gem 'danger-changelog', '~> 0.1' + gem 'danger-toc', '~> 0.1' gem 'futuroscope', github: 'codegram/futuroscope' gem 'minitest' gem 'mocha' diff --git a/README.md b/README.md index 534a628..d63e9c6 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,22 @@ Hyperclient is a Hypermedia API client written in Ruby. It fully supports [JSON HAL](http://stateless.co/hal_specification.html). -* [Hyperclient](#hyperclient) -* [Usage](#usage) - * [API Client](#api-client) - * [Resources and Attributes](#resources-and-attributes) - * [Links and Embedded Resources](#links-and-embedded-resources) - * [Templated Links](#templated-links) - * [Curies](#curies) - * [Attributes](#attributes) - * [HTTP](#http) - * [Asynchronous requests](#asynchronous-requests) -* [Testing Using Hyperclient](#testing-using-hyperclient) -* [Reference](#reference) -* [Hyperclient Users](#hyperclient-users) -* [Contributing](#contributing) -* [License](#license) - -ToC created with [gh-md-toc](https://github.com/ekalinin/github-markdown-toc) +# Table of Contents + +- [Usage](#usage) + - [API Client](#api-client) + - [Resources and Attributes](#resources-and-attributes) + - [Links and Embedded Resources](#links-and-embedded-resources) + - [Templated Links](#templated-links) + - [Curies](#curies) + - [Attributes](#attributes) + - [HTTP](#http) + - [Asynchronous requests](#asynchronous-requests) +- [Testing Using Hyperclient](#testing-using-hyperclient) +- [Reference](#reference) +- [Hyperclient Users](#hyperclient-users) +- [Contributing](#contributing) +- [License](#license) # Usage diff --git a/Rakefile b/Rakefile index 45dd2e6..ae67eff 100755 --- a/Rakefile +++ b/Rakefile @@ -13,13 +13,6 @@ if ENV['COVERAGE'] end end -require 'yard' -YARD::Config.load_plugin('yard-tomdoc') -YARD::Rake::YardocTask.new do |t| - t.files = ['lib/**/*.rb'] - t.options = %w[-r README.md] -end - require 'rake/testtask' Rake::TestTask.new(:test) do |t|