Automatically comment your Gems with descriptions from RubyGems
One simple command turns this:
gem 'rails', '4.2.0'
gem 'sqlite3'
gem 'sass-rails', '~> 5.0'
into this:
# Ruby on Rails is a full-stack web framework optimized for programmer happiness
# and sustainable productivity. It encourages beautiful code by favoring
# convention over configuration.
gem 'rails', '4.2.0'
# This module allows Ruby programs to interface with the SQLite3
# database engine (http://www.sqlite.org). You must have the
# SQLite engine installed in order to build this module.
# Note that this module is only compatible with SQLite 3.6.16 or newer.
gem 'sqlite3'
# Sass adapter for the Rails asset pipeline.
gem 'sass-rails', '~> 5.0'
> gem install bundler-commentator
> bundler-commentator
At the moment bundler-commentator doesn't remove existing comments, so I would
highly recommend first using bundler-reorganizer which organizes and cleans your Gemfile
--gemfile_path "path/to/Gemfile"
--output_path "path/to/commented/Gemfile"
FAQs
Unknown package
We found that bundler-commentator demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware negotiators share how modern cybercriminals operate like corporations, using specialized teams, negotiation tactics, and reputation management.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.