https://github.com/dozmus/csar
csar: Query-driven Code Search and Refactoring Framework
https://github.com/dozmus/csar
code-search context-aware csar java java-8 refactor search semanticsearch
Last synced: 3 months ago
JSON representation
csar: Query-driven Code Search and Refactoring Framework
- Host: GitHub
- URL: https://github.com/dozmus/csar
- Owner: dozmus
- Created: 2018-06-11T12:24:18.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-03T20:38:09.000Z (over 6 years ago)
- Last Synced: 2025-01-20T17:14:30.552Z (4 months ago)
- Topics: code-search, context-aware, csar, java, java-8, refactor, search, semanticsearch
- Language: Java
- Size: 1.72 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
csar (code search and refactor)
========
csar is a query-driven, semantics-based, and language-agnostic code searching and refactoring tool.
Currently it only supports searching for methods and method calls in Java projects, and refactoring them by
changing their names or parameters.
You can find more information in the project report and the [use guide](USEGUIDE.md).
### Example queries
* `SELECT method:use:final String appender(int, String)`
This will find all method calls which have the signature `final String appender(int, String)`.
* `SELECT method:def:public int add(4) REFACTOR rename:sum`
This will find all methods called `add` with four arguments of any type, and rename them to `sum'.
* `SELECT method:def:public int double(2) REFACTOR changeparam:int a`
This will find and replace the parameter's of this method to be just `int a`.
### Usage
All source code in the working directory will be searched, if the current directory is a git repository then only source code in the repository (and staging area) will be searched.
This can be toggled using the `--narrow-search` CLI flag.
```
Usage: java -jar csar.jar [options] search-query
Options:
--directory, -d
Target directory (default: .)
--threads, -t
Thread count (default: 1)
--log-level
Log level (default: INFO)
Possible Values (most restrictive to least): ERROR, WARN, INFO, DEBUG, TRACE
--format, -f
Output format (default: PlainText)
Possible Values: PlainText, JSON
--narrow-search
Narrow search domain (default: true)
--ignore-file
Ignore file (default: .csarignore)
--project-url, --url
Print project URL
--help, -h
Print help information
```
Example (more in the project report): `java -jar csar.jar SELECT method:def:add -t 4`.
### Gradle cheat sheet
* You can invoke gradle using the `gradlew` scripts, there is one for Windows and one for Unix.
* Build: `build`
* Run: `:csar-cli:run`
* Build distribution JARs: `:csar-cli:distJar` (these will be placed in `csar\csar-cli\build\distributions` alongside archive distributions)
* Specify Java arguments to `:csar-cli:run` with `-Pjargs="SELECT method:def:add -t 1 --log-level TRACE"`