Code Monkey home page Code Monkey logo

byf's Introduction

Byf (bundle your files)

bundle your files.

Installation

use npm or yarn package manager to install byf.

# Using npm

$ npm install -g @FlamesX-128/byf
# Using yarn

$ yarn global add @FlamesX-128/byf

Usage

In order to use the package, use the 'bys' command.

$ byf

Configuration file

Byf should have a config file called 'byf.config.js' with the following:

interface Config {
  /** @type {string} - The main file. */
  entry: string,

  /**
   * If you want it to be imported in a different way.
   * - Must have a minimum and maximum of 2 containers.
   * - Basic structure: '/()('(.*)')/'
   * 
   * @type {string} - The main file.
   * @default /()('(.*)')/
   */
  importer?: RegExp,

  /** File creation options. */
  output?: {
    /**
     * @type {string | undefined} - File name.
     * @default 'bundle'
     */
    filename?: string,

    /**
     * Path where the file will be created.
     * This includes the console path.
     * 
     * @type {string | undefined}
     * @default console.cwd()
     */
    path?: string
  },
  
  /** Plugin options. */
  plugins?: {
    /**
     * Here you add the extensions that must go through this plugin.
     * @type {RegExp | undefined}
     */
    extention?: RegExp,

    /**
     * The plugin handler module or function.
     * @type {(string | ((doc: string) => string))[]}
     */
    use?: (string | ((doc: string) => string))[]
  }[]
}

Example

// byf.config.js

module.exports = {
  entry: 'main.js',
  output: {
    filename: 'bundle.js'
  }
}
// index.js
import('hello.js')
// hello.js

(function () {
  console.log('Hello world')
})()
// Output: bundle.js

(function () {
  console.log('Hello world')
})()

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

byf's People

Contributors

flamesx-128 avatar

Stargazers

 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.