Review Sublime Text packages
Project description
# package_reviewer
A tool to review packages for [Sublime Text 3][]
(and its package manager [Package Control][]).
Supports passing local file paths
or URLs to GitHub repositories.
This README focuses on installation and usage of the tool.
For how to *resolve* failures or warnings
reported by the tool,
[refer to the wiki][wiki].
Sublime Text 2 has essentially been deprecated
a long time ago,
which is why it is not considered.
## Installation
Requires **Python 3.4** or higher.
```bash
$ pip install st_package_reviewer
```
## Usage
```
usage: st_package_reviewer [-h] [--clip] [--repo-only] [-w] [-v] [--debug]
[path_or_URL [path_or_URL ...]]
Check a Sublime Text package for common errors.
positional arguments:
path_or_URL URL to the repository or path to the package to be checked. If not provided, runs in interactive mode.
optional arguments:
-h, --help show this help message and exit
--clip Copy report to clipboard.
--repo-only Do not check the package itself and only its repository.
-w, --fail-on-warnings
Return a non-zero exit code for warnings as well.
-v, --verbose Increase verbosity.
--debug Enter pdb on exceptions. Implies --verbose.
Return values:
0: No errors
-1: Invalid command line arguments
Additional return values in non-interactive mode (a combination of bit flags):
1: Package check finished with failures
2: Repository check finished with failures
4: Unable to download repository
Interactive mode:
Enter package paths or repository URLS continuously.
Type `c` to copy the last report to your clipboard.
```
[Sublime Text 3]: https://sublimetext.com/
[Package Control]: https://packagecontrol.io/
[wiki]: https://github.com/packagecontrol/st_package_reviewer/wiki
A tool to review packages for [Sublime Text 3][]
(and its package manager [Package Control][]).
Supports passing local file paths
or URLs to GitHub repositories.
This README focuses on installation and usage of the tool.
For how to *resolve* failures or warnings
reported by the tool,
[refer to the wiki][wiki].
Sublime Text 2 has essentially been deprecated
a long time ago,
which is why it is not considered.
## Installation
Requires **Python 3.4** or higher.
```bash
$ pip install st_package_reviewer
```
## Usage
```
usage: st_package_reviewer [-h] [--clip] [--repo-only] [-w] [-v] [--debug]
[path_or_URL [path_or_URL ...]]
Check a Sublime Text package for common errors.
positional arguments:
path_or_URL URL to the repository or path to the package to be checked. If not provided, runs in interactive mode.
optional arguments:
-h, --help show this help message and exit
--clip Copy report to clipboard.
--repo-only Do not check the package itself and only its repository.
-w, --fail-on-warnings
Return a non-zero exit code for warnings as well.
-v, --verbose Increase verbosity.
--debug Enter pdb on exceptions. Implies --verbose.
Return values:
0: No errors
-1: Invalid command line arguments
Additional return values in non-interactive mode (a combination of bit flags):
1: Package check finished with failures
2: Repository check finished with failures
4: Unable to download repository
Interactive mode:
Enter package paths or repository URLS continuously.
Type `c` to copy the last report to your clipboard.
```
[Sublime Text 3]: https://sublimetext.com/
[Package Control]: https://packagecontrol.io/
[wiki]: https://github.com/packagecontrol/st_package_reviewer/wiki
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
st_package_reviewer-0.2.1.tar.gz
(35.0 kB
view hashes)
Built Distribution
Close
Hashes for st_package_reviewer-0.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7c7d78199843f48109f7e6a2e491f2540ff91d6589dfbc9732ad06c94b3b357 |
|
MD5 | e0f5066116b056cdbea09dd914a9dc55 |
|
BLAKE2b-256 | 4cb595f3c7ceccd9db1993b59f7c14b7afb04b9a02aaa78d878332e6157a0ee7 |
Close
Hashes for st_package_reviewer-0.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f57a8e3f59915a659d43d11089f8a5a38ecd0ce229c81312f043e7b2f227957b |
|
MD5 | da421005d35d7a9dd098000af70ab96c |
|
BLAKE2b-256 | 1665252c7a129bdf03fc05c15056cd90cec8fef9a4333081b7aeeebe10ceb97e |