Project

packwerk_yard

0.0
The project is in a healthy, maintained state
packwerk_yardeuglena1215/packwerk-yardHomepageDocumentationSource CodeBug TrackerWiki
Parsing YARD plugin for packwerk
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
609
Stars
1
Forks
0
Watchers
1
 Releases
Current version
0.2.0
Total releases
2
First release
2024-01-07
Latest release
2024-01-07
 Issues
Open Issues
0
Closed Issues
1
Total Issues
1
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
11
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Average date of last 50 commits
2024-01-06
Reverse Dependencies
0

 Dependencies

Runtime

packwerk
>= 0
parser
>= 0
yard
>= 0
 Project Readme

Packwerk Yard

Warning

This gem currently depends on a development branch for packwerk !!! Once Shopify/packwerk#375 is merged and released, can this gem be safely used.

Add YARD support to packwerk.

Installation

  1. Add this line to your application's Gemfile:
gem 'packwerk_yard', require: false, group: :development
  1. Require packwerk-yard in your packwerk.yml 
require:
  - packwerk_yard

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/euglena1215/packwerk_yard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

Code of Conduct

Everyone interacting in the PackwerkYard project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.