Skip to content
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
26 changes: 13 additions & 13 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ jobs:
tests:

env:
TOXENV: py38
TOXENV: py311

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.9
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools tox
python -m pip install --upgrade pip setuptools tox build
- name: Tests
run: |
python -m tox
Expand All @@ -39,14 +39,14 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.9
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools tox
python -m pip install --upgrade pip setuptools tox build
- name: Lint
run: |
python -m tox
Expand All @@ -59,14 +59,14 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.9
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools tox
python -m pip install --upgrade pip setuptools tox build
- name: Install Aspell
run: |
sudo apt-get install aspell aspell-en
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,16 +12,16 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v1
uses: actions/setup-python@v4
with:
python-version: 3.9
python-version: 3.11
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools
python -m pip install --upgrade pip setuptools build
python -m pip install -r docs/src/requirements.txt
- name: Deploy documents
run: |
Expand Down
4 changes: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ScopeHunter

## 2.18.2

- **FIX**: Fix color API access failures.

## 2.18.1

- **FIX**: Scope backtrace fixes.
Expand Down
69 changes: 35 additions & 34 deletions docs/src/markdown/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ ST3 | Fully supported and actively maintained.

Contribution from the community is encouraged and can be done in a variety of ways:

- Bug reports.
- Reviewing code.
- Code patches via pull requests.
- Documentation improvements via pull requests.
- Bug reports.
- Reviewing code.
- Code patches via pull requests.
- Documentation improvements via pull requests.

## Become a Sponsor :octicons-heart-fill-16:{: .heart-throb}

Expand All @@ -24,27 +24,27 @@ any tier you feel comfortable with. No amount is too little. We also accept one

## Bug Reports

1. Please **read the documentation** and **search the issue tracker** to try to find the answer to your question
**before** posting an issue.
1. Please **read the documentation** and **search the issue tracker** to try to find the answer to your question
**before** posting an issue.

2. When an issue is created, a [template](https://github.com/facelessuser/ScopeHunter/blob/master/.github/ISSUE_TEMPLATE.md)
will be shown, please fill out the appropriate sections. If the template is not followed, the issue will be marked
`Invalid` and closed.
2. When an issue is created, a [template](https://github.com/facelessuser/ScopeHunter/blob/master/.github/ISSUE_TEMPLATE.md)
will be shown, please fill out the appropriate sections. If the template is not followed, the issue will be marked
`Invalid` and closed.

3. When creating an issue on the repository, please provide as much info as possible:
3. When creating an issue on the repository, please provide as much info as possible:

- Provide environment information by running `Preferences->Package Settings->RegReplace->Support Info`. The
information will be copied to the clipboard; paste the info in issue.
- Errors in console.
- Detailed description of the problem.
- Examples for reproducing the error. You can post pictures, but if specific text or code is required to reproduce
the issue, please provide the text in a plain text format for easy copy/paste.
- Provide link to color scheme used (with link if a 3rd party color scheme) if applicable.
- Provide environment information by running `Preferences->Package Settings->RegReplace->Support Info`. The
information will be copied to the clipboard; paste the info in issue.
- Errors in console.
- Detailed description of the problem.
- Examples for reproducing the error. You can post pictures, but if specific text or code is required to
reproduce the issue, please provide the text in a plain text format for easy copy/paste.
- Provide link to color scheme used (with link if a 3rd party color scheme) if applicable.

The more info provided the greater the chance someone will take the time to answer, implement, or fix the issue.

4. Be prepared to answer questions and provide additional information if required. Issues in which the creator refuses
to respond to follow up questions will be marked as stale and closed.
4. Be prepared to answer questions and provide additional information if required. Issues in which the creator refuses
to respond to follow up questions will be marked as stale and closed.

## Reviewing Code

Expand All @@ -63,20 +63,21 @@ it is strongly suggested that requesters make an effort to verify before request

### Running Validation Tests

!!! tip "Tip"
If you are running Sublime on a macOS or Linux/Unix system, you run all tests by by running the shell script
(assuming you have installed your environment fulfills all requirements below):
/// tip | Tip
If you are running Sublime on a macOS or Linux/Unix system, you run all tests by by running the shell script
(assuming you have installed your environment fulfills all requirements below):

```
chmod +x run_tests.sh
./run_tests.sh
```
```
chmod +x run_tests.sh
./run_tests.sh
```
///

There are a couple of dependencies that must be present before running the tests.

1. As ST3 is the only current, actively supported version, Python 3.3 must be used to validate the tests.
1. As ST3 is the only current, actively supported version, Python 3.3 must be used to validate the tests.

2. Unit tests are run with pytest (@pytest-dev/pytest). You can install `pytest` via:
2. Unit tests are run with pytest (@pytest-dev/pytest). You can install `pytest` via:

```
pip install pytest
Expand All @@ -88,13 +89,13 @@ There are a couple of dependencies that must be present before running the tests
py.test .
```

3. Linting is performed on the entire project with the following modules:
3. Linting is performed on the entire project with the following modules:

- @gitlab:pycqa/flake8
- @gitlab:pycqa/flake8-docstrings
- @ebeweber/flake8-mutable
- @gforcada/flake8-builtins
- @gitlab:pycqa/pep8-naming
- @gitlab:pycqa/flake8
- @gitlab:pycqa/flake8-docstrings
- @ebeweber/flake8-mutable
- @gforcada/flake8-builtins
- @gitlab:pycqa/pep8-naming

These can be installed via:

Expand Down
15 changes: 11 additions & 4 deletions docs/src/markdown/about/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,17 @@

Scope Hunter is released under the MIT license.

Copyright (c) 2012 - 2022 Isaac Muse <[email protected]>
Copyright (c) 2012 - 2025 Isaac Muse <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14 changes: 7 additions & 7 deletions docs/src/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ development.
## Features
All features are configurable via the settings file

- Tooltip output showing scope, context backtrace, scope extent, color values, links to current syntax and relevant
color schemes.
- Customizable to show only the information you care about.
- Auto copy scope to clipboard on execution.
- Quick copy any or all information to the clipboard.
- Toggle instant scoping to keep showing scope as you move around a file.
- Supports [SubNotify][subnotify] messages.
- Tooltip output showing scope, context backtrace, scope extent, color values, links to current syntax and relevant
color schemes.
- Customizable to show only the information you care about.
- Auto copy scope to clipboard on execution.
- Quick copy any or all information to the clipboard.
- Toggle instant scoping to keep showing scope as you move around a file.
- Supports [SubNotify][subnotify] messages.

--8<-- "refs.txt"
56 changes: 33 additions & 23 deletions docs/src/markdown/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,42 +2,51 @@

## Package Control

The recommended way to install ScopeHunter is via [Package Control][package-control]. Package Control will install the correct branch on your system and keep it up to date.
The recommended way to install ScopeHunter is via [Package Control][package-control]. Package Control will install the
correct branch on your system and keep it up to date.

1. Ensure Package Control is installed. Instructions are found [here][package-control-install].
1. Ensure Package Control is installed. Instructions are found [here][package-control-install].

2. In Sublime Text, press ++ctrl+shift+p++ (Win, Linux) or ++cmd+shift+p++ (macOS) to bring up the quick panel and start typing `Package Control: Install Package`. Select the command and it will show a list of installable plugins.
2. In Sublime Text, press ++ctrl+shift+p++ (Win, Linux) or ++cmd+shift+p++ (macOS) to bring up the quick panel and
start typing `Package Control: Install Package`. Select the command and it will show a list of installable plugins.

3. Start typing `ScopeHunter`; when you see it, select it.
3. Start typing `ScopeHunter`; when you see it, select it.

4. Restart to be sure everything is loaded proper.
4. Restart to be sure everything is loaded proper.

5. Enjoy!
5. Enjoy!

## Manual Installation

!!! warning "Warning"
This is not the recommended way to install ScopeHunter for the average user. Installing this way **will not** get automatically updated.
/// warning | Warning
This is not the recommended way to install ScopeHunter for the average user. Installing this way **will not** get
automatically updated.

If you are forking for a pull request, you should **just** clone ScopeHunter and run Package Control's `Satisfy Dependency` command to get all the dependencies.
If you are forking for a pull request, you should **just** clone ScopeHunter and run Package Control's
`Satisfy Dependency` command to get all the dependencies.
///

For those who want to install ScopeHunter without package control, here are the steps. It understood that some people for what ever reason will prefer manually and may even have legitimate reasons to do so. When going this route, you will have to keep all the packages updated yourself.
For those who want to install ScopeHunter without package control, here are the steps. It understood that some people
for what ever reason will prefer manually and may even have legitimate reasons to do so. When going this route, you
will have to keep all the packages updated yourself.

---

1. Download the latest releases of the following dependencies and unpack or git clone in the `Packages` folder as shown below:
1. Download the latest releases of the following dependencies and unpack or git clone in the `Packages` folder as shown
below:

- @bitbucket:teddy_beer_maniac/sublime-text-dependency-markupsafe -> `markupsafe`
- @bitbucket:teddy_beer_maniac/sublime-text-dependency-jinja2 -> `python-jinja2`
- @packagecontrol/pygments -> `pygments`
- @facelessuser/sublime-markdown-popups -> `mdpopups`
- @facelessuser/sublime-markdown -> `python-markdown`
- @bitbucket:teddy_beer_maniac/sublime-text-dependency-markupsafe -> `markupsafe`
- @bitbucket:teddy_beer_maniac/sublime-text-dependency-jinja2 -> `python-jinja2`
- @packagecontrol/pygments -> `pygments`
- @facelessuser/sublime-markdown-popups -> `mdpopups`
- @facelessuser/sublime-markdown -> `python-markdown`

2. Download and unpack or git clone the latest ScopeHunter release and unpack as `ScopeHunter`:
2. Download and unpack or git clone the latest ScopeHunter release and unpack as `ScopeHunter`:

- @facelessuser/ScopeHunter -> ScopeHunter
- @facelessuser/ScopeHunter -> ScopeHunter

3. Create a folder under `Packages` called `00-dependencies` and under that folder create a file called `00-dependencies.py`:
3. Create a folder under `Packages` called `00-dependencies` and under that folder create a file called
`00-dependencies.py`:

Copy the following code to `00-dependencies.py` (this code was taken from Package Control):

Expand Down Expand Up @@ -197,19 +206,20 @@ For those who want to install ScopeHunter without package control, here are the
add_dependency('mdpopups')
```

4. Restart and enjoy.
4. Restart and enjoy.

## Git Cloning

1. Quit Sublime Text.
1. Quit Sublime Text.

2. Open a terminal and enter the following. For dependencies replace the URL with the appropriate URL, and the appropriate folder to check it out to:
2. Open a terminal and enter the following. For dependencies replace the URL with the appropriate URL, and the
appropriate folder to check it out to:

```
cd /path/to/Sublime Text 3/Packages
git clone https://github.com/facelessuser/ScopeHunter.git RegReplace
```

3. Restart Sublime Text.
3. Restart Sublime Text.

--8<-- "refs.txt"
1 change: 1 addition & 0 deletions lib/file_strip/json.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# noqa: A005
"""
File Strip.

Expand Down
Loading