Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add screencast and update documentation #71

Merged
merged 1 commit into from
Apr 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ recursive-include jupyter-config *.json
recursive-include jupyterlab_search_replace *.json
include jupyter_server_test_config.py
include conftest.py
exclude *.gif

include package.json
include install.json
Expand Down
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,22 @@
# jupyterlab_search_replace

[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/) [![Build](https://github.com/jupyterlab-contrib/search-replace/actions/workflows/build.yml/badge.svg)](https://github.com/jupyterlab-contrib/search-replace/actions/workflows/build.yml) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/search-replace/master?urlpath=lab)
[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/) [![Build](https://github.com/jupyterlab-contrib/search-replace/actions/workflows/build.yml/badge.svg)](https://github.com/jupyterlab-contrib/search-replace/actions/workflows/build.yml) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/search-replace/master?urlpath=lab) [![Version](https://img.shields.io/pypi/v/jupyterlab-search-replace.svg)](https://pypi.org/project/jupyterlab-search-replace/) [![Version](https://img.shields.io/conda/vn/conda-forge/jupyterlab-search-replace.svg)](https://anaconda.org/conda-forge/jupyterlab-search-replace)

Search and replace across files.

![Demo](https://raw.githubusercontent.com/jupyterlab-contrib/search-replace/master/search-replace-demo.gif)

**Notes on replace**

There are three levels of replacement. Undo capability is possible except for replace all matches:

- Replace all matches: _Cannot_ be undone. A dialog will ask confirmation and all files will be backed up
in `.ipynb_checkpoints` folders before applying the replacement actions.
- Replace all matches in a file: The file will be opened in the text editor and the replacement will be done
as a single text edition. So all replacements can will be undone by calling the editor undo action.
- Replace a single match: The file will be opened in the text editor and the replacement will be done as
a text edition. The replacement will be undone by calling the editor undo action.

## Requirements

- JupyterLab >= 3.0
Expand All @@ -16,27 +29,27 @@ Search and replace across files.
To install the extension, execute:

```bash
pip install jupyterlab jupyterlab_search_replace
pip install jupyterlab jupyterlab-search-replace
```

or

```bash
conda install -c conda-forge jupyterlab jupyterlab_search_replace ripgrep
conda install -c conda-forge jupyterlab-search-replace ripgrep
```

## Uninstall

To remove the extension, execute:

```bash
pip uninstall jupyterlab jupyterlab_search_replace
pip uninstall jupyterlab-search-replace
```

or

```bash
conda remove jupyterlab jupyterlab_search_replace ripgrep
conda remove jupyterlab-search-replace ripgrep
```

## Troubleshoot
Expand Down
Binary file added search-replace-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.