itee-validators 6.0.0 → 6.1.0

package/.tasks/_refresh-gulpfile.task.mjs

@@ -1,65 +0,0 @@
-import colors                   from 'ansi-colors'
-import log                      from 'fancy-log'
-import { writeFileSync }        from 'fs'
-import { glob }                 from 'glob'
-import {
-    join,
-    normalize,
-    relative
-}                               from 'path'
-import { packageRootDirectory } from './_utils.mjs'
-
-const {
-          blue,
-          green,
-          magenta,
-          cyan
-      }            = colors
-const gulpfilePath = join( packageRootDirectory, 'gulpfile.mjs' )
-const taskFiles    = glob.sync( join( packageRootDirectory, '.tasks/{.*.task.mjs,*.task.mjs,.**/*.task.mjs,.**/**/*.task.mjs}' ) )
-                         .map( filePath => normalize( filePath ) )
-
-/**
- * @method gulp refresh
- * @global
- * @description Will regenerate the gulpfile accordingly to existing task under .tasks folder
- */
-const _refreshGulpfileTask       = async ( done ) => {
-
-    let gulpfileContent = '' +
-        '/**\n' +
-        ' * This file is auto-generated by internal gulp command.\n' +
-        ' * If you want to customize the available gulp tasks, create your own in .tasks folder\n' +
-        ' * and run "gulp refresh"\n' +
-        ' */\n\n'
-
-    for ( const taskFile of taskFiles ) {
-        const module = await import(taskFile)
-
-        const exportStrings = []
-        for ( const moduleKey in module ) {
-            const task         = module[ moduleKey ]
-            const name         = task.name ?? null
-            const displayName  = task.displayName ?? null
-            const fullName     = ( moduleKey !== name ) ? `${ blue( moduleKey ) }( ${ magenta( name ) } )` : `${ blue( name ) }`
-            const exportAs     = ( displayName ) ? ` as ${ cyan( displayName ) }` : ''
-            const exportString = fullName + exportAs
-            exportStrings.push( exportString )
-        }
-
-        const relativeTaskFile = relative( packageRootDirectory, taskFile )
-        log( 'Found', green( relativeTaskFile ), 'with', exportStrings.join( ', ' ) )
-        gulpfileContent += `export * from './${ relativeTaskFile }'\n`
-    }
-
-    log( 'Refreshing', green( gulpfilePath ) )
-    writeFileSync( gulpfilePath, gulpfileContent )
-
-    done()
-
-}
-_refreshGulpfileTask.displayName = 'refresh'
-_refreshGulpfileTask.description = 'Will regenerate gulpfile.mjs with tasks in .tasks folder and sub-folders'
-_refreshGulpfileTask.flags       = null
-
-export { _refreshGulpfileTask }

package/.tasks/_utils.mjs

@@ -1,192 +0,0 @@
-import colors            from 'ansi-colors'
-import childProcess      from 'child_process'
-import log               from 'fancy-log'
-import { readFileSync }  from 'fs'
-import {
-    dirname,
-    join
-}                        from 'path'
-import { fileURLToPath } from 'url'
-
-const red    = colors.red
-const yellow = colors.yellow
-
-function getDirname() {
-
-    let __dirname
-
-    if ( import.meta.dirname ) {
-        __dirname = import.meta.dirname
-    } else if ( import.meta.filename ) {
-        __dirname = dirname( import.meta.filename )
-    } else if ( import.meta.url ) {
-        const __filename = fileURLToPath( import.meta.url )
-        __dirname        = dirname( __filename )
-    } else {
-        throw new Error( 'Unable to retrieve module dirname.' )
-    }
-
-    return __dirname
-
-}
-
-function getPackageRootDirectory() {
-
-    const __dirname = getDirname()
-    return join( __dirname, '..' )
-
-}
-
-const packageRootDirectory            = getPackageRootDirectory()
-const packageJsonPath                 = join( packageRootDirectory, 'package.json' )
-const nodeModulesDirectory            = join( packageRootDirectory, 'node_modules' )
-const packageBuildsDirectory          = join( packageRootDirectory, 'builds' )
-const packageSourcesDirectory         = join( packageRootDirectory, 'sources' )
-const packageSourcesBackendDirectory  = join( packageSourcesDirectory, 'backend' )
-const packageSourcesCommonDirectory   = join( packageSourcesDirectory, 'common' )
-const packageSourcesFrontendDirectory = join( packageSourcesDirectory, 'frontend' )
-const packageTestsDirectory           = join( packageRootDirectory, 'tests' )
-const packageTestsBenchmarksDirectory = join( packageTestsDirectory, 'benchmarks' )
-const packageTestsBundlesDirectory    = join( packageTestsDirectory, 'bundles' )
-const packageTestsUnitsDirectory      = join( packageTestsDirectory, 'units' )
-const packageDocsDirectory            = join( packageRootDirectory, 'docs' )
-const packageTutorialsDirectory       = join( packageRootDirectory, 'tutorials' )
-
-function getPackageJson() {
-
-    const packageData = readFileSync( packageJsonPath )
-    return JSON.parse( packageData )
-
-}
-
-const packageJson        = getPackageJson()
-const packageName        = packageJson.name
-const packageVersion     = packageJson.version
-const packageDescription = packageJson.description
-
-function getPrettyPackageName( separator = ' ' ) {
-
-    let prettyPackageName = ''
-
-    const nameSplits = packageName.split( '-' )
-    for ( const nameSplit of nameSplits ) {
-        prettyPackageName += nameSplit.charAt( 0 ).toUpperCase() + nameSplit.slice( 1 ) + separator
-    }
-    prettyPackageName = prettyPackageName.slice( 0, -1 )
-
-    return prettyPackageName
-
-}
-
-function getPrettyPackageVersion() {
-
-    return 'v' + packageVersion
-
-}
-
-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 IndenterFactory( indentationChar = '\t', indentationLevel = 5 ) {
-
-    const indentationLevels = {}
-    let currentProperty     = 'I_'
-    for ( let currentIndentationLevel = 1 ; currentIndentationLevel <= indentationLevel ; currentIndentationLevel++ ) {
-        indentationLevels[ currentProperty ] = indentationChar.repeat( currentIndentationLevel )
-        currentProperty += '_'
-    }
-
-    return {
-        I: new Indenter( indentationChar ),
-        ...indentationLevels
-    }
-
-}
-
-class Indenter {
-
-    constructor( indentationChar = '\t' ) {
-
-        this.indentationChar         = indentationChar
-        this.currentIndentationLevel = 0
-
-    }
-
-    _( indentationLevel = null ) {
-        return this.indentationChar.repeat( indentationLevel ?? this.currentIndentationLevel )
-    }
-
-    deeper( level = 1 ) {
-        this.currentIndentationLevel += level
-    }
-
-    shallower( level = 1 ) {
-        this.currentIndentationLevel -= level
-    }
-
-}
-
-export {
-    packageRootDirectory,
-    packageJsonPath,
-    packageBuildsDirectory,
-    packageSourcesDirectory,
-    packageSourcesBackendDirectory,
-    packageSourcesCommonDirectory,
-    packageSourcesFrontendDirectory,
-    packageTestsDirectory,
-    packageTestsBenchmarksDirectory,
-    packageTestsBundlesDirectory,
-    packageTestsUnitsDirectory,
-    packageDocsDirectory,
-    packageTutorialsDirectory,
-    nodeModulesDirectory,
-
-    packageJson,
-    packageName,
-    packageVersion,
-    packageDescription,
-    getPrettyPackageName,
-    getPrettyPackageVersion,
-    getPrettyNodeVersion,
-    getPrettyNpmVersion,
-
-    IndenterFactory as Indenter
-}

package/.tasks/configs/benchmarks.conf.mjs

@@ -1,57 +0,0 @@
-import { playwrightLauncher }   from '@web/test-runner-playwright'
-import { packageRootDirectory } from '../_utils.mjs'
-import { iteeReporter }         from '../itee-reporter.mjs'
-
-export default {
-    files:          [
-        // 'tests/benchmarks/cores/arrays/isArray.bench.js',
-
-        // 'tests/benchmarks/cores/arrays/*.bench.js',
-        // 'tests/benchmarks/cores/booleans/*.bench.js',
-        // 'tests/benchmarks/cores/functions/*.bench.js',
-        // 'tests/benchmarks/cores/numbers/*.bench.js',
-        // 'tests/benchmarks/cores/objects/*.bench.js',
-        // 'tests/benchmarks/cores/strings/*.bench.js',
-        // 'tests/benchmarks/cores/symbols/*.bench.js',
-        // 'tests/benchmarks/cores/typed-arrays/*.bench.js',
-        // 'tests/benchmarks/cores/voids/*.bench.js',
-        // 'tests/benchmarks/cores/**',
-        // 'tests/benchmarks/dom/**',
-        // 'tests/benchmarks/physics/**',
-        // OR
-        // 'tests/benchmarks/builds/itee-validators.benchmarks.iife.js',
-        // OR
-        'tests/benchmarks/**/*.bench.js',
-        '!tests/benchmarks/builds/**',
-        '!tests/benchmarks/file-system/**',
-    ],
-    debug:          false,
-    nodeResolve:    true,
-    browsers:       [
-        playwrightLauncher( { product: 'chromium' } ),
-        playwrightLauncher( { product: 'webkit' } ),
-        playwrightLauncher( { product: 'firefox' } ),
-    ],
-    testFramework:  {
-        path:   packageRootDirectory + '/.tasks/itee-benchmarks-framework.js',
-        config: {
-            foo: 'bar'
-        }
-    },
-    testRunnerHtml: testFramework => `
-        <!DOCTYPE html>
-        <html>
-          <body>
-            <script type="module" src="node_modules/lodash/lodash.js"></script>
-            <script type="module" src="node_modules/platform/platform.js"></script>
-            <script type="module" src="node_modules/benchmark/benchmark.js"></script>
-            <script type="module" src="${ testFramework }"></script>
-          </body>
-        </html>
-    `,
-    reporters:      [
-        iteeReporter( {
-            reportProgress: true
-        } )
-    ]
-}

package/.tasks/configs/build-benchmarks-backend.conf.mjs

@@ -1,51 +0,0 @@
-/**
- * @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}}
- */
-import nodeResolve     from '@rollup/plugin-node-resolve'
-import cleanup         from 'rollup-plugin-cleanup'
-import replace         from 'rollup-plugin-re'
-import { packageName } from '../_utils.mjs'
-
-const buildBenchmarksBackendConfig = {
-    input:     `tests/benchmarks/${ packageName }.benchmarks.js`,
-    external:  [
-        // 'fs'
-    ],
-    plugins:   [
-        replace( {
-            // Even this variable are not used in this package, we need it because
-            // they are used in dependency package itee-utils that use them to focus some build stuff
-            // May be there is a better way to perform this specification than using global comment variable
-            // that need to be inherited in all children package
-            defines: {
-                IS_KEEP_ON_BUILD:     true,
-                IS_BACKEND_SPECIFIC:  true,
-                IS_FRONTEND_SPECIFIC: false,
-            }
-        } ),
-        nodeResolve(),
-        cleanup( {
-            comments: 'none'
-        } )
-    ],
-    treeshake: true,
-    output:    {
-        indent: '\t',
-        format: 'cjs',
-        intro:  () => 'var Benchmark = require(\'benchmark\')',
-        file:   `tests/benchmarks/builds/${ packageName }.benchmarks.cjs.js`
-    }
-}
-
-export { buildBenchmarksBackendConfig }

package/.tasks/configs/build-unit-tests-backend.conf.mjs

@@ -1,46 +0,0 @@
-/**
- * @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}}
- */
-import nodeResolve     from '@rollup/plugin-node-resolve'
-import cleanup         from 'rollup-plugin-cleanup'
-import replace         from 'rollup-plugin-re'
-import { packageName } from '../_utils.mjs'
-
-/**
- * @type {{input: string, external: string[], plugins: (Plugin<any>|{name: string, transform: function(*, *): (undefined|{code: *})})[], treeshake: boolean, output: {indent: string, format: string, file: string}}}
- */
-const buildUnitTestsBackendConfig = {
-    input:     `tests/units/${ packageName }.units.mjs`,
-    external:  [ 'itee-utils', 'mocha', 'chai', 'fs' ],
-    plugins:   [
-        nodeResolve(),
-        replace( {
-            replaces: {
-                'isEventTargetUnits.call': '//isEventTargetUnits.call',
-            }
-        } ),
-        cleanup( {
-            comments: 'none'
-        } )
-    ],
-    treeshake: true,
-    output:    {
-        indent: '\t',
-        format: 'cjs',
-        // inlineDynamicImports: true,
-        file: `tests/units/builds/${ packageName }.units.cjs.js`
-    }
-}
-
-export { buildUnitTestsBackendConfig }