minify

README

gin-minify

gin middleware to minify css/js/json/svg/xml data.

Notice: It's an early stage library, please DO NOT use in production. PR is warmly welcome.

Usage

import 	"github.com/missdeer/gin-minify"

func main() {
	r := gin.Default()

	r.Use(minify.Minify(minify.IgnoreHTML())) // HTML can't work properly due to Transfer-Encoding: chunked
    ...
}

Documentation

Index

• Variables
• func Minify(options ...Option) gin.HandlerFunc
• type ExcludedExtensions
  • func NewExcludedExtensions(extensions []string) ExcludedExtensions
  • func (e ExcludedExtensions) Contains(target string) bool
• type ExcludedPathesRegexs
  • func NewExcludedPathesRegexs(regexs []string) ExcludedPathesRegexs
  • func (e ExcludedPathesRegexs) Contains(requestURI string) bool
• type ExcludedPaths
  • func NewExcludedPaths(paths []string) ExcludedPaths
  • func (e ExcludedPaths) Contains(requestURI string) bool
• type Option
  • func IgnoreCSS() Option
  • func IgnoreHTML() Option
  • func IgnoreJS() Option
  • func IgnoreJSON() Option
  • func IgnoreSVG() Option
  • func IgnoreXML() Option
  • func WithExcludedExtensions(args []string) Option
  • func WithExcludedPaths(args []string) Option
  • func WithExcludedPathsRegexs(args []string) Option
• type Options

Variables

var (
	DefaultExcludedExtentions = NewExcludedExtensions([]string{
		".png", ".gif", ".jpeg", ".jpg",
	})
	DefaultOptions = &Options{
		ExcludedExtensions: DefaultExcludedExtentions,
	}
)

Functions

func Minify

func Minify(options ...Option) gin.HandlerFunc

Types

type ExcludedExtensions

type ExcludedExtensions map[string]bool

Using map for better lookup performance

func NewExcludedExtensions

func NewExcludedExtensions(extensions []string) ExcludedExtensions

func (ExcludedExtensions) Contains

func (e ExcludedExtensions) Contains(target string) bool

type ExcludedPathesRegexs

type ExcludedPathesRegexs []*regexp.Regexp

func NewExcludedPathesRegexs

func NewExcludedPathesRegexs(regexs []string) ExcludedPathesRegexs

func (ExcludedPathesRegexs) Contains

func (e ExcludedPathesRegexs) Contains(requestURI string) bool

type ExcludedPaths

type ExcludedPaths []string

func NewExcludedPaths

func NewExcludedPaths(paths []string) ExcludedPaths

func (ExcludedPaths) Contains

func (e ExcludedPaths) Contains(requestURI string) bool

type Option

type Option func(*Options)

func IgnoreCSS

func IgnoreCSS() Option

func IgnoreHTML

func IgnoreHTML() Option

func IgnoreJS

func IgnoreJS() Option

func IgnoreJSON

func IgnoreJSON() Option

func IgnoreSVG

func IgnoreSVG() Option

func IgnoreXML

func IgnoreXML() Option

func WithExcludedExtensions

func WithExcludedExtensions(args []string) Option

func WithExcludedPaths

func WithExcludedPaths(args []string) Option

func WithExcludedPathsRegexs

func WithExcludedPathsRegexs(args []string) Option

type Options

type Options struct {
	ExcludedExtensions   ExcludedExtensions
	ExcludedPaths        ExcludedPaths
	ExcludedPathesRegexs ExcludedPathesRegexs
	IgnoreHTML           bool
	IgnoreCSS            bool
	IgnoreJS             bool
	IgnoreJSON           bool
	IgnoreSVG            bool
	IgnoreXML            bool
}