Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eapache/starscope
Smart code search for Ruby, Go, and JavaScript
https://github.com/eapache/starscope
cscope ctags javascript ruby
Last synced: 3 days ago
JSON representation
Smart code search for Ruby, Go, and JavaScript
- Host: GitHub
- URL: https://github.com/eapache/starscope
- Owner: eapache
- License: mit
- Created: 2013-06-06T13:59:00.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2023-12-22T22:00:30.000Z (about 1 year ago)
- Last Synced: 2024-10-14T12:48:26.395Z (4 months ago)
- Topics: cscope, ctags, javascript, ruby
- Language: Ruby
- Homepage: https://rubygems.org/gems/starscope
- Size: 576 KB
- Stars: 266
- Watchers: 9
- Forks: 18
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Starscope
=========
[](https://rubygems.org/gems/starscope)
[](https://github.com/eapache/starscope/actions/workflows/ruby-ci.yml)
[](https://eapache.github.io/conduct.html)
Starscope is a code indexer, search and navigation tool for
[Ruby](https://www.ruby-lang.org/), [Golang](https://golang.org/), and
[JavaScript](https://en.wikipedia.org/wiki/JavaScript) with a design intended
to make it easy to add [support for other languages](doc/LANGUAGE_SUPPORT.md).
Inspired by the extremely popular [Ctags](https://en.wikipedia.org/wiki/Ctags)
and [Cscope](http://cscope.sourceforge.net/) utilities, Starscope can answer a
lot of questions about your code. It can tell you:
- where methods are defined
- where methods are called
- where variables are assigned
- where symbols are used
- where files and libraries are imported or required
While Ctags already supports many languages, it can only tell you where things
are defined. Cscope can answer a lot more of your questions, but it is limited
to just the C language family. Starscope was written to combine the power of
Cscope with the flexibility of Ctags, bringing full code indexing to as many
developers as possible.
Quick Start
-----------
Install it as a gem:
```
$ gem install starscope
```
Build your database by just running it in the project directory:
```
$ cd ~/my-project
$ starscope
```
Ask it things directly:
```
$ starscope -q calls,new # Lists all callers of new
```
Export it to various existing formats for automatic integration with your editor:
```
$ starscope -e ctags
$ starscope -e cscope
```
More Documentation
------------------
* [User Guide](doc/USER_GUIDE.md)
* [Version History](CHANGELOG.md)
* [Language Support](doc/LANGUAGE_SUPPORT.md)
* [Database Format](doc/DB_FORMAT.md)
Other Uses
----------
- Starscope is a supported backend for
[CodeQuery](https://github.com/ruben2020/codequery).