itee-validators 5.6.0 → 6.0.0

package/.tasks/helps/help.mjs

@@ -1,195 +0,0 @@
-import childProcess from 'child_process'
-import log          from 'fancy-log'
-import colors       from 'ansi-colors'
-import {
-    packageInfos,
-    Indenter
-}                   from '../_utils.mjs'
-
-const {
-          red,
-          green,
-          blue,
-          cyan,
-          yellow,
-          magenta,
-          unstyle
-      } = colors
-
-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 getPrettyNodeVersion() {
-
-    let nodeVersion = 'vX.x.ₓ'
-
-    try {
-        nodeVersion = childProcess.execFileSync( 'node', [ '--version' ] )
-                                  .toString()
-                                  .replace( /(\r\n|\n|\r)/gm, '' )
-    } catch ( e ) {
-        log( red( e ) )
-
-        if ( e.message.includes( 'ENOENT' ) ) {
-            nodeVersion += yellow( ' Not seems to be accessible from the path environment.' )
-        }
-    }
-
-    return ' node: ' + nodeVersion
-
-}
-
-function getPrettyNpmVersion() {
-
-    let npmVersion = 'X.x.ₓ'
-
-    try {
-        npmVersion = childProcess.execFileSync( 'npm', [ '--version' ] )
-                                 .toString()
-                                 .replace( /(\r\n|\n|\r)/gm, '' )
-    } catch ( e ) {
-        log( red( e ) )
-
-        if ( e.message.includes( 'ENOENT' ) ) {
-            npmVersion += yellow( ' Not seems to be accessible from the path environment.' )
-        }
-    }
-
-    return ' npm:  v' + npmVersion
-
-}
-
-function alignTextCenter( text, width ) {
-
-    const unstyledText = unstyle( text.repeat( 1 ) )
-    const marginLength = ( width - unstyledText.length ) / 2
-
-    let leftMargin, rightMargin
-    if ( Number.isInteger( marginLength ) ) {
-        leftMargin  = marginLength
-        rightMargin = marginLength
-    } else {
-        const flooredMargin = Math.floor( marginLength )
-        leftMargin          = flooredMargin
-        rightMargin         = flooredMargin + 1
-    }
-
-    return ' '.repeat( leftMargin ) + text + ' '.repeat( rightMargin )
-
-}
-
-function alignTextLeft( text, width ) {
-
-    const unstyledText = unstyle( text.repeat( 1 ) )
-    let repeatTime     = width - unstyledText.length
-    repeatTime         = ( repeatTime > 0 ) ? repeatTime : 0
-
-    return text + ' '.repeat( repeatTime )
-
-}
-
-function alignTextRight( text, width ) {
-
-    const unstyledText = unstyle( text.repeat( 1 ) )
-    let repeatTime     = width - unstyledText.length
-    repeatTime         = ( repeatTime > 0 ) ? repeatTime : 0
-
-    return ' '.repeat( repeatTime ) + text
-
-}
-
-function help( done ) {
-
-    const bannerWidth          = 70
-    const prettyPackageName    = getPrettyPackageName()
-    const prettyPackageVersion = getPrettyPackageVersion()
-    const prettyNodeVersion    = getPrettyNodeVersion()
-    const prettyNpmVersion     = getPrettyNpmVersion()
-
-    const tableCharset = {
-        topLeftCorner:       '┏',
-        topRightCorner:      '┓',
-        bottomRightCorner:   '┛',
-        bottomLeftCorner:    '┗',
-        horizontalBorder:    '━',
-        horizontalSeparator: '─',
-        leftJoinSeparator:   '┠',
-        rightJoinSeparator:  '┨',
-        verticalBorder:      '┃',
-        verticalSeparator:   '',
-    }
-
-    const mainBorder     = tableCharset.horizontalBorder.repeat( bannerWidth )
-    const thinBorder     = tableCharset.horizontalSeparator.repeat( bannerWidth )
-    const tableTop       = `${ tableCharset.topLeftCorner }${ mainBorder }${ tableCharset.topRightCorner }`
-    const tableSeparator = `${ tableCharset.leftJoinSeparator }${ thinBorder }${ tableCharset.rightJoinSeparator }`
-    const tableBottom    = `${ tableCharset.bottomLeftCorner }${ mainBorder }${ tableCharset.bottomRightCorner }`
-    const tableLine      = ( innerText ) => `${ tableCharset.verticalBorder }${ innerText }${ tableCharset.verticalBorder }`
-
-    const I      = new Indenter( '  ', 5 )
-    const npmRun = blue( 'npm run' )
-
-    log( '' )
-    log( tableTop )
-    log( tableLine( alignTextCenter( 'HELP', bannerWidth ) ) )
-    log( tableLine( alignTextCenter( prettyPackageName, bannerWidth ) ) )
-    log( tableLine( alignTextCenter( prettyPackageVersion, bannerWidth ) ) )
-    log( tableSeparator )
-    log( tableLine( alignTextLeft( prettyNodeVersion, bannerWidth ) ) )
-    log( tableLine( alignTextLeft( prettyNpmVersion, bannerWidth ) ) )
-    log( tableBottom )
-    log( I._, 'Available commands are:' )
-    log( I.__, npmRun, cyan( 'help' ), '- Display this help.' )
-    log( I.__, npmRun, cyan( 'patch' ), '- Will apply some patch/replacements in dependencies.', red( '(Apply only once after run "npm install")' ) )
-    log( I.__, npmRun, cyan( 'clean' ), '- Will delete builds and temporary folders.' )
-    log( I.__, npmRun, cyan( 'lint' ), '- Will run the eslint in pedantic mode with auto fix when possible.' )
-    log( I.__, npmRun, cyan( 'doc' ), '- Will run jsdoc, and create documentation under `documentation` folder, using the docdash theme' )
-    log( I.__, npmRun, cyan( 'test' ), '- Will run the test framworks (unit and bench), and create reports under `documentation/report` folder, using the mochawesome theme' )
-    log( I.__, npmRun, cyan( 'unit' ), '- Will run the karma server for unit tests.' )
-    log( I.__, npmRun, cyan( 'bench' ), '- Will run the karma server for benchmarks.' )
-    log( I.__, npmRun, cyan( 'build' ), yellow( '--' ), green( '<options>' ), '- Will build the application for development and/or production environments.' )
-    log( I.___, yellow( 'Note: The two dash are only required if you provide options !' ) )
-    log( I.___, 'The available', green( '<options>' ), 'are:' )
-    log( I.____, green( '-i' ), 'or', green( '--input' ), '- The main file path to build', cyan( '[Default: "sources/main.js"]' ), '.' )
-    log( I.____, green( '-o' ), 'or', green( '--output' ), '- The folder where output the build', cyan( '[Default: "builds"]' ), '.' )
-    log(
-        I.____,
-        green( '-f:' ),
-        magenta( '<format>' ),
-        'or',
-        green( '--format:' ),
-        magenta( '<format>' ),
-        ' - to specify the output build type. Where format could be any of:', magenta( 'cjs, esm, iife, umd' ), '.'
-    )
-    log( I.____, green( '-e:' ), magenta( '<env>' ), 'or', green( '--env:' ), magenta( '<env>' ), ' - to specify the build environment. Where env could be any of:', magenta(
-        'dev' ), magenta( 'prod' ), cyan( '[Default: "dev"]' ), '.' )
-    log( I.____, green( '-s' ), 'or', green( '--sourcemap' ), ' - to build with related source map', cyan( '[Default: true]' ), '.' )
-    log( I.____, green( '-t' ), 'or', green( '--treeshake' ), ' - allow to perform treeshaking when building', cyan( '[Default: true]' ), '.' )
-    log( I.__, npmRun, cyan( 'release' ), '- Will run all the lint, test stuff, and if succeed will build the application.' )
-    log( '' )
-    log( I._, 'In case you have', blue( 'gulp' ), 'installed globally, you could use also:' )
-    log( I.__, blue( 'gulp' ), cyan( 'command' ), '- It will perform the command like using "npm run" but with less characters to type... Because you\'re a developer, right ?' )
-    log( '' )
-
-    done()
-
-}
-
-export { help }

package/.tasks/lints/lint.mjs

@@ -1,33 +0,0 @@
-import { getGulpConfigForTask } from '../../configs/gulp.conf.mjs'
-import gulp                     from 'gulp'
-import eslint                   from 'gulp-eslint'
-import log                      from 'fancy-log'
-
-function lint( done ) {
-
-    const filesToLint = getGulpConfigForTask( 'lint' )
-
-    for ( let fileIndex = 0, numberOfFiles = filesToLint.length ; fileIndex < numberOfFiles ; fileIndex++ ) {
-        log( `[${ fileIndex + 1 }/${ numberOfFiles }] Lint ${ filesToLint[ fileIndex ] }` )
-    }
-
-    return gulp.src( filesToLint, { base: './' } )
-               .pipe( eslint( {
-                   allowInlineConfig: true,
-                   globals:           [],
-                   fix:               true,
-                   quiet:             false,
-                   envs:              [],
-                   configFile:        './configs/eslint.conf.js',
-                   parserOptions:     {},
-                   plugins:           [],
-                   rules:             {},
-                   useEslintrc:       false
-               } ) )
-               .pipe( eslint.format( 'stylish' ) )
-               .pipe( gulp.dest( '.' ) )
-               .pipe( eslint.failAfterError() )
-
-}
-
-export { lint }

package/.tasks/patches/patch.mjs

@@ -1,9 +0,0 @@
-
-
-function patch( done ) {
-
-    done()
-
-}
-
-export { patch }

package/.tasks/tests/benchmarks/bundle-benchmarks.mjs

@@ -1,33 +0,0 @@
-import rollupBenchesConfigurator from '../../../configs/rollup.benchs.conf.js'
-import log                       from 'fancy-log'
-import { rollup }                from 'rollup'
-import colors                    from 'ansi-colors'
-
-const red = colors.red
-
-async function bundleBenchmarks( done ) {
-
-    const configs = rollupBenchesConfigurator()
-
-    for ( let config of configs ) {
-
-        log( `Building ${ config.output.file }` )
-
-        try {
-
-            const bundle = await rollup( config )
-            await bundle.write( config.output )
-
-        } catch ( error ) {
-
-            log( red( error ) )
-
-        }
-
-    }
-
-    done()
-
-}
-
-export { bundleBenchmarks }

package/.tasks/tests/benchmarks/run-benchmarks-for-backend.mjs

@@ -1,24 +0,0 @@
-import path from 'path'
-import childProcess from 'child_process'
-import {
-    getDirname,
-    packageInfos
-} from '../../_utils.mjs'
-
-
-function runBenchmarksForBackend( done ) {
-
-    const projectDir = getDirname()
-    const benchsPath = path.join( projectDir, `tests/benchmarks/builds/${ packageInfos.name }.benchs.cjs.js` )
-    const benchmark  = childProcess.spawn( 'node', [ benchsPath ], { stdio: 'inherit' } )
-    benchmark.on( 'close', ( code ) => {
-
-        ( code === 0 )
-        ? done()
-        : done( `benchmark exited with code ${ code }` )
-
-    } )
-
-}
-
-export { runBenchmarksForBackend }

package/.tasks/tests/benchmarks/run-benchmarks-for-frontend.mjs

@@ -1,38 +0,0 @@
-import path           from 'path'
-import karma          from 'karma'
-import log            from 'fancy-log'
-import colors         from 'ansi-colors'
-import { getDirname } from '../../_utils.mjs'
-
-const {
-          red,
-          green,
-          blue,
-          cyan,
-          yellow,
-          magenta
-      } = colors
-
-
-async function runBenchmarksForFrontend( done ) {
-
-    const projectDir  = getDirname()
-    const configFile  = path.normalize( `${ projectDir }/configs/karma.benchs.conf.js` )
-    const karmaConfig = karma.config.parseConfig( configFile )
-    const karmaServer = new karma.Server( karmaConfig, ( exitCode ) => {
-        if ( exitCode === 0 ) {
-            log( `Karma server exit with code ${ exitCode }` )
-            done()
-        } else {
-            done( `Karma server exit with code ${ exitCode }` )
-        }
-    } )
-    karmaServer.on( 'browser_error', ( browser, error ) => {
-        log( red( error.message ) )
-    } )
-
-    await karmaServer.start()
-
-}
-
-export { runBenchmarksForFrontend }

package/.tasks/tests/bundling/check-bundling-from-esm-files-direct.mjs

@@ -1,129 +0,0 @@
-import {
-    join,
-    normalize,
-    basename,
-    extname,
-    dirname,
-    relative
-}                               from 'path'
-import {
-    existsSync,
-    rmSync,
-    mkdirSync,
-    writeFileSync
-}                               from 'fs'
-import glob                     from 'glob'
-import { nodeResolve }          from '@rollup/plugin-node-resolve'
-import cleanup                  from 'rollup-plugin-cleanup'
-import { rollup }               from 'rollup'
-import { getGulpConfigForTask } from '../../../configs/gulp.conf.mjs'
-import { getDirname }           from '../../_utils.mjs'
-import log                      from 'fancy-log'
-import colors                   from 'ansi-colors'
-
-const {
-          red,
-          green,
-          blue,
-          cyan,
-          yellow,
-          magenta
-      } = colors
-
-async function checkBundlingFromEsmFilesDirect( done ) {
-
-    const baseDir           = getDirname()
-    const sourcesDir        = join( baseDir, 'sources' )
-    const testsDir          = join( baseDir, 'tests' )
-    const bundlesDir        = join( testsDir, 'bundles' )
-    const outputDir         = join( bundlesDir, 'from_files_direct' )
-    const filePathsToIgnore = getGulpConfigForTask( 'check-bundling' )
-
-    if ( existsSync( outputDir ) ) {
-        log( 'Clean up', magenta( outputDir ) )
-        rmSync( outputDir, { recursive: true } )
-    }
-
-    const sourcesFiles = glob.sync( join( sourcesDir, '**' ) )
-                             .map( filePath => normalize( filePath ) )
-                             .filter( filePath => {
-                                 const fileName         = basename( filePath )
-                                 const isJsFile         = fileName.endsWith( '.js' )
-                                 const isNotPrivateFile = !fileName.startsWith( '_' )
-                                 const isNotIgnoredFile = !filePathsToIgnore.includes( fileName )
-                                 return isJsFile && isNotPrivateFile && isNotIgnoredFile
-                             } )
-
-    for ( let sourceFile of sourcesFiles ) {
-
-        const specificFilePath = sourceFile.replace( sourcesDir, '' )
-        const specificDir      = dirname( specificFilePath )
-        const fileName         = basename( sourceFile, extname( sourceFile ) )
-
-        const bundleFileName = `${ fileName }.bundle.js`
-        const bundleFilePath = join( outputDir, specificDir, bundleFileName )
-
-        const config = {
-            input:     sourceFile,
-            external:  [ '' ],
-            plugins:   [
-                nodeResolve( {
-                    preferBuiltins: true
-                } ),
-                cleanup( {
-                    comments: 'none'
-                } )
-            ],
-            onwarn:    ( {
-                loc,
-                frame,
-                message
-            } ) => {
-
-                // Ignore some errors
-                if ( message.includes( 'Circular dependency' ) ) { return }
-                if ( message.includes( 'Generated an empty chunk' ) ) { return }
-
-                if ( loc ) {
-                    process.stderr.write( `/!\\ ${ loc.file } (${ loc.line }:${ loc.column }) ${ frame } ${ message }\n` )
-                } else {
-                    process.stderr.write( `/!\\ ${ message }\n` )
-                }
-
-            },
-            treeshake: {
-                moduleSideEffects:                true,
-                annotations:                      true,
-                correctVarValueBeforeDeclaration: true,
-                propertyReadSideEffects:          true,
-                tryCatchDeoptimization:           true,
-                unknownGlobalSideEffects:         true
-            },
-            output:    {
-                indent: '\t',
-                format: 'esm',
-                file:   bundleFilePath
-            }
-        }
-
-        try {
-
-            log( `Bundling ${ config.output.file }` )
-
-            const bundle = await rollup( config )
-            await bundle.generate( config.output )
-            await bundle.write( config.output )
-
-        } catch ( error ) {
-
-            log( red( error.message ) )
-
-        }
-
-    }
-
-    done()
-
-}
-
-export { checkBundlingFromEsmFilesDirect }

package/.tasks/tests/bundling/check-bundling-from-esm-files-import.mjs

@@ -1,149 +0,0 @@
-import {
-    join,
-    normalize,
-    basename,
-    parse,
-    dirname,
-    relative
-}                               from 'path'
-import {
-    existsSync,
-    rmSync,
-    mkdirSync,
-    writeFileSync
-}                               from 'fs'
-import log                      from 'fancy-log'
-import glob                     from 'glob'
-import { nodeResolve }          from '@rollup/plugin-node-resolve'
-import cleanup                  from 'rollup-plugin-cleanup'
-import { rollup }               from 'rollup'
-import colors                   from 'ansi-colors'
-import { getGulpConfigForTask } from '../../../configs/gulp.conf.mjs'
-import { getDirname }           from '../../_utils.mjs'
-
-const {
-          red,
-          green,
-          blue,
-          cyan,
-          yellow,
-          magenta
-      } = colors
-
-async function checkBundlingFromEsmFilesImport( done ) {
-
-    const baseDir           = getDirname()
-    const sourcesDir        = join( baseDir, 'sources' )
-    const testsDir          = join( baseDir, 'tests' )
-    const bundleDir         = join( testsDir, 'bundles' )
-    const outputDir         = join( bundleDir, 'from_files_import' )
-    const temporariesDir    = join( outputDir, '.tmp' )
-    const filePathsToIgnore = getGulpConfigForTask( 'check-bundling' )
-
-    if ( existsSync( outputDir ) ) {
-        log( 'Clean up', magenta( outputDir ) )
-        rmSync( outputDir, { recursive: true } )
-    }
-
-    const sourcesFiles = glob.sync( join( sourcesDir, '/**' ) )
-                             .map( filePath => {
-                                 return normalize( filePath )
-                             } )
-                             .filter( filePath => {
-                                 const fileName         = basename( filePath )
-                                 const isJsFile         = fileName.endsWith( '.js' )
-                                 const isNotPrivateFile = !fileName.startsWith( '_' )
-                                 const isNotIgnoredFile = !filePathsToIgnore.includes( fileName )
-                                 return isJsFile && isNotPrivateFile && isNotIgnoredFile
-                             } )
-
-    for ( let sourceFile of sourcesFiles ) {
-
-        const {
-                  dir:  sourceDir,
-                  base: sourceBase,
-                  name: sourceName
-              }                = parse( sourceFile )
-        const specificFilePath = sourceFile.replace( sourcesDir, '' )
-        const specificDir      = dirname( specificFilePath )
-
-        // Create temp import file per file in package
-        const temporaryFileName = `${ sourceName }.import.js`
-        const temporaryDir      = join( temporariesDir, specificDir )
-        const temporaryFile     = join( temporaryDir, temporaryFileName )
-        const importDir         = relative( temporaryDir, sourceDir )
-        const importFile        = join( importDir, sourceBase )
-        const temporaryFileData = `import '${ importFile.replace( /\\/g, '/' ) }'`
-
-        // Bundle tmp file and check content for side effects
-        const bundleFileName = `${ sourceName }.bundle.js`
-        const bundleFilePath = join( outputDir, specificDir, bundleFileName )
-
-        const config = {
-            input:     temporaryFile,
-            plugins:   [
-                nodeResolve(),
-                cleanup( {
-                    comments: 'all' // else remove __PURE__ declaration... -_-'
-                } )
-            ],
-            onwarn:    ( {
-                loc,
-                frame,
-                message
-            } ) => {
-
-                // Ignore some errors
-                if ( message.includes( 'Circular dependency' ) ) { return }
-                if ( message.includes( 'Generated an empty chunk' ) ) { return }
-
-                if ( loc ) {
-                    process.stderr.write( `/!\\ ${ loc.file } (${ loc.line }:${ loc.column }) ${ frame } ${ message }\n` )
-                } else {
-                    process.stderr.write( `/!\\ ${ message }\n` )
-                }
-
-            },
-            treeshake: {
-                moduleSideEffects:                true,
-                annotations:                      true,
-                correctVarValueBeforeDeclaration: true,
-                propertyReadSideEffects:          true,
-                tryCatchDeoptimization:           true,
-                unknownGlobalSideEffects:         true
-            },
-            output:    {
-                indent: '\t',
-                format: 'esm',
-                file:   bundleFilePath
-            }
-        }
-
-        // create tmp file
-        try {
-
-            mkdirSync( temporaryDir, { recursive: true } )
-            writeFileSync( temporaryFile, temporaryFileData )
-
-            const bundle     = await rollup( config )
-            const { output } = await bundle.generate( config.output )
-
-            let code = output[ 0 ].code
-            if ( code.length > 1 ) {
-                log( red( `[${ specificFilePath }] contain side-effects !` ) )
-                await bundle.write( config.output )
-            } else {
-                log( green( `[${ specificFilePath }] is side-effect free.` ) )
-            }
-
-        } catch ( error ) {
-            log( red( error.message ) )
-        }
-
-    }
-
-    done()
-
-}
-
-export { checkBundlingFromEsmFilesImport }

package/.tasks/tests/unit-tests/bundle-unit-tests.mjs

@@ -1,33 +0,0 @@
-import rollupUnitTestsConfigurator from '../../../configs/rollup.units.conf.js'
-import log                         from 'fancy-log'
-import { rollup }                  from 'rollup'
-import colors                      from 'ansi-colors'
-
-const red = colors.red
-
-async function bundleUnitTests( done ) {
-
-    const configs = rollupUnitTestsConfigurator()
-
-    for ( let config of configs ) {
-
-        log( `Building ${ config.output.file }` )
-
-        try {
-
-            const bundle = await rollup( config )
-            await bundle.write( config.output )
-
-        } catch ( error ) {
-
-            log( red( error ) )
-
-        }
-
-    }
-
-    done()
-
-}
-
-export { bundleUnitTests }

package/.tasks/tests/unit-tests/run-unit-tests-for-backend.mjs

@@ -1,25 +0,0 @@
-import { join } from 'path'
-import { spawn } from 'child_process'
-import {
-    getDirname,
-    packageInfos
-} from '../../_utils.mjs'
-
-
-function runUnitTestsForBackend( done ) {
-
-    const projectDir = getDirname()
-    const mochaPath  = join( projectDir, 'node_modules/mocha/bin/mocha' )
-    const testsPath  = join( projectDir, `tests/units/builds/${ packageInfos.name }.units.cjs.js` )
-    const mocha      = spawn( 'node', [ mochaPath, testsPath ], { stdio: 'inherit' } )
-    mocha.on( 'close', ( code ) => {
-
-        ( code === 0 )
-        ? done()
-        : done( `mocha exited with code ${ code }` )
-
-    } )
-
-}
-
-export { runUnitTestsForBackend }