@renoirb/tools-bundling-helpers

Bundling helpers such as CLI utilities and packaging branding utilities

| Size | Dependencies | | ----------------------------------- | ------------------------------------------------------------------------ | | | |

Usage

CommandLineUtilities

Utility we can use in a package's bin script.

#!/usr/bin/env node
'use strict';

const { CommandLineUtilities } = require('@renoirb/tools-bundling-helpers');

# Example of a way to handle logic by existence of a shell environment variable
const isCI = CommandLineUtilities.hasEnvFlag('CI_SERVER');
if (isCI) {
  process.argv.push('--quiet');
} else {
  process.argv.push('--verbose');
}

createBannerInfo

An utility to help manage a package's top of the file "banner"

// const pkg = require('../package.json')
// Imagine package.json had the lines like below
const pkg = {
  name: 'assimilate',
  version: '436.0.1',
  author: {
    email: '[email protected]',
    name: 'Seven Of Nine',
  },
}
const branding = {
  firstYear: 1484,
  vendor: 'Borg Collective',
}
const bannerInfo = createBannerInfo(pkg, branding)
console.log(bannerInfo)

Would return

{
  "author": "Seven Of Nine <[email protected]>",
  "copyright": "Copyright (c) 1484-2020 Borg Collective",
  "license": "LicenseRef-LICENSE",
  "name": "assimilate",
  "vendor": "Borg Collective",
  "version": "436.0.1"
}

We can pass this to createBannerFooter and get a banner and footer string for bundling tools such as Rollup.

// From example above
const bannerInfo = createBannerInfo(pkg, branding)
const bannerFooter = createBannerFooter(bannerInfo)
console.log(bannerFooter.banner)

Would return

/**
 * assimilate v436.0.1
 *
 * Maintainer: Seven Of Nine <[email protected]>
 *
 * LicenseRef-LICENSE
 *
 * © 1484-2020 Borg Collective
 */