Giter Club home page Giter Club logo

zumerbox-build's Introduction

@zumerbox/build

The Zumerbox build tool is a command-line utility designed to bundle and compile JavaScript and SCSS files into distributable formats. It leverages the esbuild library for efficient bundling and minification, providing developers with a streamlined workflow for frontend development.

Refer to the ZumerBox bundle for more information and tools.

Installation

npm install @zumerbox/build --save-dev

Usage:

npx @zumerbox/build --name <bundler_name> --js <path_to_js_file> --scss <path_to_scss_file> [options]

Options:

  • --name (-n): Specifies the name of the bundler. If not provided, it will attempt to use the name from the package.json file. If the name is not available in package.json, it will default to "MyBundler".
  • --js (-j): Specifies the path to the JavaScript file (optional).
  • --scss (-s): Specifies the path to the SCSS file (optional).
  • --minify (-m): Generates minified output files (JavaScript and CSS) if enabled.
  • --outdir (-d): Specifies the destination folder for the output files. Default is "dist".
  • --platform (-p): Specifies the target platform for esBuild. Default is "browser".
  • --help (-h): Displays the help message.

Functionality:

  • Input files: Specify the JavaScript and SCSS files to be bundled using the command-line options.
  • Bundling: The tool utilizes esbuild to bundle the provided JavaScript and SCSS files into distributable formats.
  • Minification: Optionally, the tool can minify the output files by setting the '--minify' flag.
  • Package information: The tool reads package.json from the project directory to extract metadata such as name, version, author, and license. This information is included as a banner in the output files.
  • Output directory: Output files are saved to the specified output directory ('dist' by default).
  • Error handling: The tool gracefully handles errors during the bundling process and exits with an error code if an error occurs.

Credits:

This tools is powered by esbuild (https://esbuild.github.io/)

zumerbox-build's People

Contributors

tinchox5 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.