Skip to main content

A CLI formatter for JavaScript and CSS (beautify or minimize).

Project description

# z-format

An opinionated CLI formatter for JavaScript and CSS (beautify or minimize).

If the file is being beautified, the file's contents are replaced with the new
formatting. If the file is being minimized, we create a new file with `.min`
before the normal file extensions (e.g. `.min.js` or `.min.css`).


## Usage

```sh
usage: format.py [-h] [-m] path

An opinionated CLI formatter for JavaScript and CSS (beautify or minimize).

positional arguments:
path file's path to format

optional arguments:
-h, --help show this help message and exit
-m, --minify minimize the file's content instead of beautifying
```


## Install

```sh
pip install z-format
```


## Dependencies

This is a simple wrapper for several libraries which it installs by default:

- jsbeautifier - JavaScript beautification
- jsmin - JavaScript minification
- cssformatter - CSS beautification and minification


## License

MIT License

Copyright (c) 2017 Joshua S. Ziegler

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 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.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

z_format-0.7.0-py3-none-any.whl (8.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page