File: README.md

package info (click to toggle)
golang-github-tdewolff-minify 2.20.37-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 39,388 kB
  • sloc: javascript: 394,644; xml: 25,649; ansic: 253; makefile: 108; python: 108; sh: 47
file content (46 lines) | stat: -rw-r--r-- 1,485 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
Python bindings for the Go minifiers for web formats `minify`, see [github.com/tdewolff/minify](https://github.com/tdewolff/minify).

## Requisites
Make sure to have [Go](https://go.dev/doc/install) installed.

## Usage
There are three functions available in Python: configure the minifiers, minify a string, and minify a file. Below an example of their usage:

```python
import minify

# default config option values
minify.config({
    'css-precision': 0,
    'html-keep-comments': False,
    'html-keep-conditional-comments': False,
    'html-keep-default-attr-vals': False,
    'html-keep-document-tags': False,
    'html-keep-end-tags': False,
    'html-keep-whitespace': False,
    'html-keep-quotes': False,
    'js-precision': 0,
    'js-keep-var-names': False,
    'js-version': 0,
    'json-precision': 0,
    'json-keep-numbers': False,
    'svg-keep-comments': False,
    'svg-precision': 0,
    'xml-keep-whitespace': False,
})

s = minify.string('text/html', '<span style="color:#ff0000;" class="text">Some  text</span>')
print(s)  # <span style=color:red class=text>Some text</span>

minify.file('text/html', 'example.html', 'example.min.html')  # creates example.min.html
```

## Mediatypes
The first argument is the mediatype of the content. The following mediatypes correspond to the configured minifiers:

- `text/css`: CSS
- `text/html`: HTML
- `image/svg+xml`: SVG
- `(application|text)/(x-)?(java|ecma)script`: JS
- `*/json */*-json`: JSON
- `*/xml */*-xml`: XML