Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/josee9988/minifyallcli

📦 A lightweight, simple and easy npm tool to 𝗺𝗶𝗻𝗶𝗳𝘆 JSON/C, HTML and CSS! Also known as MinifyAll core! ⭐ Usable as 𝑪𝑳𝑰 tool or 𝒊𝒎𝒑𝒐𝒓𝒕𝒂𝒃𝒍𝒆 in TS/JS as a 𝑴𝑶𝑫𝑼𝑳𝑬 🥰
https://github.com/josee9988/minifyallcli

cli cli-app client-project client-side css html json minification minifier minifier-css minifiers minify minify-css minify-html minify-json minifying minimization npm-module npm-package npmjs

Last synced: about 1 month ago
JSON representation

📦 A lightweight, simple and easy npm tool to 𝗺𝗶𝗻𝗶𝗳𝘆 JSON/C, HTML and CSS! Also known as MinifyAll core! ⭐ Usable as 𝑪𝑳𝑰 tool or 𝒊𝒎𝒑𝒐𝒓𝒕𝒂𝒃𝒍𝒆 in TS/JS as a 𝑴𝑶𝑫𝑼𝑳𝑬 🥰

Host: GitHub
URL: https://github.com/josee9988/minifyallcli
Owner: Josee9988
License: bsd-3-clause
Created: 2020-05-12T16:04:09.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2023-02-03T11:23:26.000Z (almost 2 years ago)
Last Synced: 2024-10-12T08:03:51.723Z (about 1 month ago)
Topics: cli, cli-app, client-project, client-side, css, html, json, minification, minifier, minifier-css, minifiers, minify, minify-css, minify-html, minify-json, minifying, minimization, npm-module, npm-package, npmjs
Language: TypeScript
Homepage: https://minifyall.jgracia.es/
Size: 1.14 MB
Stars: 25
Watchers: 2
Forks: 5
Open Issues: 15
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md

Awesome Lists containing this project

README

        # **MinifyAll CLI**

A simple package to minify your web **code**, _you will love its simplicity_!

With MinifyAll you will be able to minify **.html**, **.css**, **.json** and **.jsonc** directly from the CLI.

It also supports **minifying an entire directory recursively** (finding the available file extensions),

you could also change the **suffix** of the new minified file (by default "-min"),

toggle the minimization of **RGB**/**HEX** values, preserve license comments and _much more_! 

Use it as a **CLI command** or as a **normal package**!

MinifyAll uses **regex** as its main and only minimization tool, that will lead to **impressive minify times** compared to other minifiers that deeply analyze the code.

Check the **[website](https://minifyall.jgracia.es/)** or the original **[VSCode extension](https://github.com/Josee9988/MinifyAll)**.

[![Version](https://badge.fury.io/js/%40josee9988%2Fminifyall.svg)](https://www.npmjs.com/package/@josee9988/minifyall)

[![Downloads](https://img.shields.io/npm/dt/@josee9988/minifyall.svg)](https://www.npmjs.com/package/@josee9988/minifyall)

[![Vulnerabilities](https://img.shields.io/snyk/vulnerabilities/npm/@josee9988/minifyall)](https://www.npmjs.com/package/@josee9988/minifyall)

[![npm bundle size (scoped version)](https://img.shields.io/bundlephobia/minzip/@josee9988/minifyall/1.0.0)](https://www.npmjs.com/package/@josee9988/minifyall)

[![DeepScan grade](https://deepscan.io/api/teams/9121/projects/11596/branches/173509/badge/grade.svg)](https://deepscan.io/dashboard/#view=project&tid=9121&pid=11596&bid=173509)

[![Node.js CI](https://github.com/Josee9988/MinifyAllCli/workflows/Node.js%20CI/badge.svg)](https://github.com/Josee9988/MinifyAllCli/actions)

---

## **Languages available** 🧪🔥

- **HTML**

- **CSS**

- **JSON**

- **JSONC**

---

## **Installation**

  ### **Global installation**

```bash

npm i -g @josee9988/minifyall # install the package globally

```

  ### **Package installation**

  

  ```bash

  npm i @josee9988/minifyall --save # install the package in your project

  ```

---

## **Usage**

### **CLI usage**

  

**`minifyall --help`** or **`minifyall --help`** will output:

  

  ```

MinifyAllCli v1.2.2

Usage: minifyall [file] [options]

Global options:

  -h, --help              Output usage information. (will ignore any other arguments)

  -v, --version           Output package version. (will ignore any other arguments)

  -m, --minify-hex                Will minify the hexadecimal color values. (default = false)

  -s, --suffix            Append a suffix string to the minified filename

  -o, --output            The new output file (will ignore "--suffix" argument)

  -d, --dir               Will recursively look for HTML/CSS/JSON files inside a directory and will minify every one (will ignore "--output" argument)

Examples of use:

  minifyall --help

  minifyall --version

  minifyall myFile.css

  minifyall pathToMyFile/dirs/myFile.css

  minifyall myFile.css -m -s .min

  minifyall myFile.css --minify-hex -s -minified

  minifyall myFile.css --output someFolder/myNewFile.css

  minifyall --dir myFolder/

For more information visit: https://github.com/Josee9988/MinifyAllCli

  ```

### **Package usage**

  

1. Import the package.

  

      ```typescript

    import {MinifyAllClass} from '@josee9988/minifyall'; // import it

      ```

2. Initialize the minifier.

  

    ```typescript

    const minifyall: MinifyAllClass = new MinifyAllClass(false); // initialize the class (true for minifying color values such as HEXADECIMAL/RGB/RGBA)

    ```

    

3. Use the minifier by passing the function your array of strings (: string[]) with your non minified code.

    

    ```typescript

    const minifiedHtmlCode: string = minifyall.minifyHtml(HTMLNotMinified); // html

    const minifiedCssCode: string = minifyall.minifyCssScssLessSass(CSSNotMinified); // css

    const minifiedJsonCode: string = minifyall.minifyJsonJsonc(JSONNotMinified); // json/c

    ```

---

## **Built with**

* [WebStorm](https://www.jetbrains.com/webstorm/)

* [TypeScript](https://www.typescriptlang.org/)

* [npm](https://www.npmjs.com/)

* [Github](https://github.com/Josee9988)

---

## **Contributing**

This project is actively looking for new contributors to develop new functions, maintain and improve the project.

If you are interested make sure to fork the project and pull-request your improvements to be added as a contributor!

---

_Made with a lot of ❤️❤️ by **[@Josee9988](https://github.com/Josee9988)**_