https://github.com/jcs-elpa/isearch-project
Incremental search through the whole project.
https://github.com/jcs-elpa/isearch-project
convenience emacs isearch replace
Last synced: about 1 year ago
JSON representation
Incremental search through the whole project.
- Host: GitHub
- URL: https://github.com/jcs-elpa/isearch-project
- Owner: jcs-elpa
- License: gpl-3.0
- Created: 2019-03-18T17:19:21.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-23T00:08:29.000Z (about 1 year ago)
- Last Synced: 2025-04-23T01:21:09.616Z (about 1 year ago)
- Topics: convenience, emacs, isearch, replace
- Language: Emacs Lisp
- Homepage:
- Size: 10.7 MB
- Stars: 8
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://jcs-emacs.github.io/jcs-elpa/#/isearch-project)
[](https://melpa.org/#/isearch-project)
[](https://stable.melpa.org/#/isearch-project)
# isearch-project
> Incremental search through the whole project.
[](https://github.com/jcs-elpa/isearch-project/actions/workflows/test.yml)
This is an alternative package replacing `ag` searcher. The logic behinds this
package is similar to [Visual Studio](https://visualstudio.microsoft.com/)
`find and replace` functionalities, but using `isearch`. It simply searches
`regexp` in each file accordingly to the project file tree.
`isearch` gives a better visuality than `ag` does. `ag` is great but is verbose
for me to use because it gives you a whole list that matches even the matching line
are in the exact same line.
*P.S. Inspired by [Visual Studio](https://visualstudio.microsoft.com/) `find and replace` preset behavior.*
## 🧪 Customization
Set the paths you usually want to ignore to search through.
```el
(setq isearch-project-ignore-paths '(".vs/"
".vscode/"
"node_modules/"))
```
## 🔧 Usage
Call it from `minibuffer` directly,
```
M-x isearch-project-forward
```
Or you can bind it globally to any key you want.
```el
(global-set-key (kbd "any-key") #'isearch-project-forward)
```
## 🛠️ Contribute
[](http://makeapullrequest.com)
[](https://github.com/bbatsov/emacs-lisp-style-guide)
[](https://www.paypal.me/jcs090218)
[](https://www.patreon.com/jcs090218)
If you would like to contribute to this project, you may either
clone and make pull requests to this repository. Or you can
clone the project and establish your own branch of this tool.
Any methods are welcome!
### 🔬 Development
To run the test locally, you will need the following tools:
- [Eask](https://emacs-eask.github.io/)
- [Make](https://www.gnu.org/software/make/) (optional)
Install all dependencies and development dependencies:
```sh
$ eask install-deps --dev
```
To test the package's installation:
```sh
$ eask package
$ eask install
```
To test compilation:
```sh
$ eask compile
```
**🪧 The following steps are optional, but we recommend you follow these lint results!**
The built-in `checkdoc` linter:
```sh
$ eask lint checkdoc
```
The standard `package` linter:
```sh
$ eask lint package
```
*📝 P.S. For more information, find the Eask manual at https://emacs-eask.github.io/.*
## ⚜️ License
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
See [`LICENSE`](./LICENSE.txt) for details.