From afc978c914a96f5530cf18e2f3d93498464e7deb Mon Sep 17 00:00:00 2001 From: Brooke Kuhlmann Date: Sun, 14 May 2017 07:27:01 -0600 Subject: [PATCH 1/3] Added Tocer gem. - Will be used to auto-generate the Table of Contents for the README (as well as keeping it up-to-date). - Usage: `tocer --generate` - [Documentation](https://github.com/bkuhlmann/tocer). --- Gemfile.lock | 11 +++++++++++ webpacker.gemspec | 1 + 2 files changed, 12 insertions(+) diff --git a/Gemfile.lock b/Gemfile.lock index 3c71b8747..6b253751e 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -99,6 +99,7 @@ GEM thor (>= 0.18.1, < 2.0) rainbow (2.2.1) rake (12.0.0) + refinements (4.1.0) rubocop (0.47.1) parser (>= 2.3.3.1, < 3.0) powerpack (~> 0.1) @@ -106,6 +107,8 @@ GEM ruby-progressbar (~> 1.7) unicode-display_width (~> 1.0, >= 1.0.1) ruby-progressbar (1.8.1) + runcom (0.6.0) + refinements (~> 4.1) sprockets (3.7.1) concurrent-ruby (~> 1.0) rack (> 1, < 3) @@ -114,7 +117,14 @@ GEM activesupport (>= 4.0) sprockets (>= 3.0.0) thor (0.19.4) + thor_plus (5.1.0) + thor (~> 0.19) thread_safe (0.3.6) + tocer (5.0.0) + refinements (~> 4.1) + runcom (~> 0.6) + thor (~> 0.19) + thor_plus (~> 5.1) tzinfo (1.2.2) thread_safe (~> 0.1) unicode-display_width (1.1.3) @@ -131,6 +141,7 @@ DEPENDENCIES rails rake (>= 11.1) rubocop (>= 0.47) + tocer (~> 5.0) webpacker! BUNDLED WITH diff --git a/webpacker.gemspec b/webpacker.gemspec index 36f102cdd..06baa5158 100644 --- a/webpacker.gemspec +++ b/webpacker.gemspec @@ -17,6 +17,7 @@ Gem::Specification.new do |s| s.add_dependency "railties", ">= 4.2" s.add_development_dependency "bundler", "~> 1.12" + s.add_development_dependency "tocer", "~> 5.0" s.files = `git ls-files`.split("\n") s.test_files = `git ls-files -- test/*`.split("\n") From f11aa5eb7e85a162bdf77ae4f87816713f3e9345 Mon Sep 17 00:00:00 2001 From: Brooke Kuhlmann Date: Sun, 14 May 2017 07:31:16 -0600 Subject: [PATCH 2/3] Added Tocer project configuration. - Tocer, by default uses a label of "# Table of Contents" but for this project we need a label of "## Table of Contents". This ensures the correct indentation of the Table of Contents for the README. --- .tocerrc | 1 + 1 file changed, 1 insertion(+) create mode 100644 .tocerrc diff --git a/.tocerrc b/.tocerrc new file mode 100644 index 000000000..af3bad821 --- /dev/null +++ b/.tocerrc @@ -0,0 +1 @@ +:label: "## Table of Contents" From ea750d61c8c1673a9c6d7515529900dd1e380252 Mon Sep 17 00:00:00 2001 From: Brooke Kuhlmann Date: Sun, 14 May 2017 07:33:18 -0600 Subject: [PATCH 3/3] Added Table of Contents to README. - Used `tocer --generate` to generate the Table of Contents. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 9ed33ee39..858481110 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,29 @@ JavaScript frameworks. It's designed to work with Rails 5.1+ and makes use of the [Yarn](https://yarnpkg.com) dependency management that's been made default from that version forward. + + +## Table of Contents + + - [Prerequisites](#prerequisites) + - [Installation](#installation) + - [Binstubs](#binstubs) + - [Configuration](#configuration) + - [Advanced Configuration](#advanced-configuration) + - [Linking to static assets](#linking-to-static-assets) + - [Getting asset path](#getting-asset-path) + - [Deployment](#deployment) + - [Linking to sprockets assets](#linking-to-sprockets-assets) + - [Ready for React](#ready-for-react) + - [Ready for Angular with TypeScript](#ready-for-angular-with-typescript) + - [Ready for Vue](#ready-for-vue) + - [Ready for Elm](#ready-for-elm) + - [Troubleshooting](#troubleshooting) + - [Wishlist](#wishlist) + - [License](#license) + + + ## Prerequisites * Ruby 2.2+