/**
* @author [Tristan Valcke]{@link https://github.com/Itee}
* @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}
*
* @module configs/Rollup
* @description The file manage the rollup configuration for build the library using differents arguments. It allow to build with two type of environment (dev and prod), and differents output format.
* Use npm run help to display all available build options.
*
* @requires {@link module: [rollup-plugin-commonjs]{@link https://github.com/rollup/rollup-plugin-commonjs}}
* @requires {@link module: [path]{@link https://nodejs.org/api/path.html}}
* @requires {@link module: [rollup-plugin-re]{@link https://github.com/jetiny/rollup-plugin-re}}
* @requires {@link module: [rollup-plugin-node-resolve]{@link https://github.com/rollup/rollup-plugin-node-resolve}}
* @requires {@link module: [rollup-plugin-terser]{@link https://github.com/TrySound/rollup-plugin-terser}}
*/
const packageInfos = require( '../package' )
const path = require( 'path' )
const commonjs = require( '@rollup/plugin-commonjs' )
const { nodeResolve } = require( '@rollup/plugin-node-resolve' )
const terser = require( 'rollup-plugin-terser' ).terser
const replace = require( 'rollup-plugin-re' )
const figlet = require( 'figlet' )
function getPrettyPackageName() {
let packageName = ''
const nameSplits = packageInfos.name.split( '-' )
for ( const nameSplit of nameSplits ) {
packageName += nameSplit.charAt( 0 ).toUpperCase() + nameSplit.slice( 1 ) + '.'
}
packageName = packageName.slice( 0, -1 )
return packageName
}
function getPrettyPackageVersion() {
return 'v' + packageInfos.version
}
function getPrettyFormatForBanner( format ) {
let prettyFormat = ''
switch ( format ) {
case 'cjs':
prettyFormat = 'CommonJs'
break
case 'esm':
prettyFormat = 'EsModule'
break
case 'iife':
prettyFormat = 'Standalone'
break
case 'umd':
prettyFormat = 'Universal'
break
default:
throw new RangeError( `Invalid switch parameter: ${ format }` )
}
return prettyFormat
}
function _commentarize( banner ) {
let bannerCommented = '/**\n'
bannerCommented += ' * '
bannerCommented += banner.replaceAll( '\n', '\n * ' )
bannerCommented += '\n'
bannerCommented += ` * @desc ${ packageInfos.description }\n`
bannerCommented += ' * @author [Tristan Valcke]{@link https://github.com/Itee}\n'
bannerCommented += ' * @license [BSD-3-Clause]{@link https://opensource.org/licenses/BSD-3-Clause}\n'
bannerCommented += ' * \n'
bannerCommented += ' */'
return bannerCommented
}
function _computeBanner( format ) {
const packageName = getPrettyPackageName()
const packageVersion = getPrettyPackageVersion()
const prettyFormat = getPrettyFormatForBanner( format )
const figText = figlet.textSync(
`${ packageName } ${ packageVersion } - ${ prettyFormat }`,
{
font: 'Tmplr',
horizontalLayout: 'default',
verticalLayout: 'default',
whitespaceBreak: true,
}
)
return _commentarize( figText )
}
/**
* Will create an appropriate configuration object for rollup, related to the given arguments.
*
* @generator
* @param options
* @return {Array.<json>} An array of rollup configuration
*/
function CreateRollupConfigs( options ) {
'use strict'
const {
input,
output,
formats,
envs,
treeshake
} = options
const name = getPrettyPackageName()
const fileName = path.basename( input, '.js' )
const configs = []
for ( let formatIndex = 0, numberOfFormats = formats.length ; formatIndex < numberOfFormats ; ++formatIndex ) {
for ( let envIndex = 0, numberOfEnvs = envs.length ; envIndex < numberOfEnvs ; envIndex++ ) {
const env = envs[ envIndex ]
const isProd = ( env.includes( 'prod' ) )
const format = formats[ formatIndex ]
const outputPath = ( isProd ) ? path.join( output, `${ fileName }.${ format }.min.js` ) : path.join( output, `${ fileName }.${ format }.js` )
configs.push( {
input: input,
external: ( ['esm','cjs'].includes(format) ) ? [ 'fs', 'path', 'itee-validators' ] : [ 'itee-validators' ],
plugins: [
replace( {
defines: {
IS_KEEP_ON_BUILD: false,
IS_BACKEND_SPECIFIC: ( ['esm','cjs'].includes(format) ),
IS_FRONTEND_SPECIFIC: ( ['esm','iife'].includes(format) ),
}
} ),
commonjs( {
include: 'node_modules/**'
} ),
nodeResolve( {
preferBuiltins: true
} ),
isProd && terser()
],
onwarn: ( {
loc,
frame,
message
} ) => {
// Ignore some errors
if ( message.includes( 'Circular dependency' ) ) { return }
if ( message.includes( 'plugin uglify is deprecated' ) ) { return }
if ( loc ) {
process.stderr.write( `/!\\ ${ loc.file } (${ loc.line }:${ loc.column }) ${ frame } ${ message }\n` )
} else {
process.stderr.write( `/!\\ ${ message }\n` )
}
},
treeshake: treeshake,
output: {
// core options
file: outputPath,
format: format,
name: name,
globals: {
'itee-validators': 'Itee.Validators'
},
// advanced options
paths: {},
banner: ( isProd ) ? '' : _computeBanner( format ),
footer: '',
intro: ( format === 'iife' && !isProd ) ? 'if( iteeValidators === undefined ) { throw new Error(\'Itee.Utils need Itee.Validators to be defined first. Please check your scripts loading order.\') }' : '',
outro: '',
sourcemap: !isProd,
interop: true,
// danger zone
exports: 'auto',
amd: {},
indent: '\t',
strict: true
}
} )
}
}
return configs
}
module.exports = CreateRollupConfigs