Skip to content

okuramasafumi/bundler-ctags_generator

Repository files navigation

Bundler::CtagsGenerator

A Bundler plugin to automatically execute ctags after bundle install.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add bundler-ctags_generator

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install bundler-ctags_generator

Usage

Install as a Bundler plugin with bundle plugin install bundler-ctags_generator. After installing it, it executes ctags command after each bundle install.

It's recommended to install and use Universal Ctags, other ctags implementations are not tested.

TODO

  • Add configuration for ctags arguments and output file name
  • Add option to filter gems

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/okuramasafumi/bundler-ctags_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

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

About

Provides a hook after gem installation to generate ctags

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published