itee-validators 5.6.0 → 6.0.0

package/.github/workflows/node.js.yml

@@ -16,7 +16,7 @@ jobs:
       MOZ_HEADLESS: 1
     strategy:
       matrix:
-        node-version: [ 18.x, 20.x, 22.x ]
+        node-version: [ 20.x, 22.x, 24.x ]
         firefox: [ 'latest' ]
     steps:
       - name: Use Node.js ${{ matrix.node-version }}
@@ -32,7 +32,7 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Release
-        run: npm run lint && npm run build && npm run build-test && npm run test
+        run: npm run build && npm run tests:build && npm run lint && npm run tests:run
 
   publish:
     needs: build

package/.releaserc.mjs

@@ -0,0 +1,94 @@
+import { execSync } from 'node:child_process'
+
+// Git utils
+
+function getLocalRepoUrl() {
+    const topLevelDir = execSync( 'git rev-parse --show-toplevel' )
+        .toString()
+        .trim()
+
+    return `file://${ topLevelDir }/.git`
+}
+
+function getCurrentBranch() {
+    return execSync( 'git rev-parse --abbrev-ref HEAD' )
+        .toString()
+        .trim()
+}
+
+// Plugins sub-configs
+
+function getGitmojiPlugin() {
+    return [
+        'semantic-release-gitmoji', {
+            'releaseRules': {
+                'major': [
+                    ':boom:'
+                ],
+                'minor': [
+                    ':sparkles:'
+                ],
+                'patch': [
+                    ':art:', ':zap:', ':fire:', ':bug:', ':ambulance:', ':pencil:', ':rocket:', ':lipstick:', ':white_check_mark:', ':lock:', ':apple:', ':penguin:', ':checkered_flag:', ':robot:',
+                    ':green_apple:', ':rotating_light:', ':green_heart:', ':arrow_down:', ':pushpin:', ':construction_worker:', ':chart_with_upwards_trend:', ':recycle:', ':whale:',
+                    ':heavy_plus_sign:', ':heavy_minus_sign:', ':wrench:', ':globe_with_meridians:', ':pencil2:', ':poop:', ':rewind:', ':package:', ':alien:', ':truck:', ':page_facing_up:',
+                    ':bento:', ':ok_hand:', ':wheelchair:', ':bulb:', ':beers:', ':speech_balloon:', ':card_file_box:', ':loud_sound:', ':mute:', ':busts_in_silhouette:', ':children_crossing:',
+                    ':building_construction:', ':iphone:', ':clown_face:', ':see_no_evil:', ':camera_flash:', ':alembic:', ':mag:', ':wheel_of_dharma:', ':label:', ':seedling:', ':dizzy:',
+                    ':wastebasket:', ':passport_control:', ':adhesive_bandage:', ':monocle_face:', ':coffin:', ':test_tube:', ':necktie:', ':stethoscope:', ':bricks:', ':technologist:'
+                ]
+            }
+        }
+    ]
+}
+
+function getChangelogPlugin() {
+    return '@semantic-release/changelog'
+}
+
+function getNpmPlugin() {
+    return '@semantic-release/npm'
+}
+
+function getGithubPlugin() {
+    return '@semantic-release/github'
+}
+
+function getGitPlugin() {
+    return [
+        '@semantic-release/git', {
+            'assets':  [
+                'builds/**', 'docs/**', 'package.json', 'CHANGELOG.md'
+            ],
+            'message': 'chore(release): v${nextRelease.version}'
+        }
+    ]
+}
+
+// Configuration selection
+
+function isDryRun() {
+    return process.argv.includes( '--dry-run' )
+}
+
+function getDryRunConfig() {
+    return {
+        repositoryUrl: getLocalRepoUrl(),
+        branches:      getCurrentBranch(),
+        plugins:       [
+            getGitmojiPlugin()
+        ],
+    }
+}
+
+function getCIConfig() {
+    return {
+        branch:  'master',
+        plugins: [
+            getGitmojiPlugin(), getChangelogPlugin(), getNpmPlugin(), getGithubPlugin(), getGitPlugin()
+        ]
+    }
+}
+
+// Module
+
+export default isDryRun() ? getDryRunConfig() : getCIConfig()

package/.tasks/.builds/build-benchmarks.task.mjs

@@ -0,0 +1,16 @@
+import { series }                     from 'gulp'
+import { buildBenchmarksBackendTask } from '../.tests/benchmarks/build-benchmarks-backend.task.mjs'
+import { computeBenchmarksTask }      from '../.tests/benchmarks/compute-benchmarks.task.mjs'
+
+/**
+ * @description Will compute and generate bundle for benchmarks
+ */
+const buildBenchmarksTask       = series(
+    computeBenchmarksTask,
+    buildBenchmarksBackendTask,
+)
+buildBenchmarksTask.displayName = 'build-benchmarks'
+buildBenchmarksTask.description = 'Will compute and generate bundle for benchmarks.'
+buildBenchmarksTask.flags       = null
+
+export { buildBenchmarksTask }

package/.tasks/.builds/build-tests.task.mjs

@@ -0,0 +1,18 @@
+import { series }              from 'gulp'
+import { buildBenchmarksTask } from './build-benchmarks.task.mjs'
+import { buildUnitTestsTask }  from './build-unit-tests.task.mjs'
+
+/**
+ * @method npm run build-test
+ * @global
+ * @description Will build all tests.
+ */
+const buildTestsTask       = series(
+    buildBenchmarksTask,
+    buildUnitTestsTask,
+)
+buildTestsTask.displayName = 'build-tests'
+buildTestsTask.description = 'Will build all tests.'
+buildTestsTask.flags       = null
+
+export { buildTestsTask }

package/.tasks/.builds/build-unit-tests.task.mjs

@@ -0,0 +1,16 @@
+import { series }                    from 'gulp'
+import { buildUnitTestsBackendTask } from '../.tests/unit-tests/build-unit-tests-backend.task.mjs'
+import { computeUnitTestsTask }      from '../.tests/unit-tests/compute-unit-tests.task.mjs'
+
+/**
+ * @description Will compute and generate bundle for unit tests
+ */
+const buildUnitTestsTask       = series(
+    computeUnitTestsTask,
+    buildUnitTestsBackendTask,
+)
+buildUnitTestsTask.displayName = 'build-unit-tests'
+buildUnitTestsTask.description = 'Will compute and generate bundle for unit tests.'
+buildUnitTestsTask.flags       = null
+
+export { buildUnitTestsTask }

package/.tasks/.builds/build.task.mjs

@@ -0,0 +1,46 @@
+import colors                        from 'ansi-colors'
+import log                           from 'fancy-log'
+import { rollup }                    from 'rollup'
+import { getRollupConfigurationFor } from '../configs/build.conf.mjs'
+
+const {
+          red,
+          green,
+          yellow
+      } = colors
+
+const buildTask       = async ( done ) => {
+
+    const configs = getRollupConfigurationFor( 'build' )
+
+    for ( let config of configs ) {
+
+        if ( config === undefined || config === null || config.length === 0 ) {
+            log( yellow( 'Empty configuration object... Skip it!' ) )
+            continue
+        }
+
+        log( 'Building', green( config.output.file ) )
+
+        try {
+
+            const bundle = await rollup( config )
+            await bundle.write( config.output )
+
+        } catch ( error ) {
+
+            done( red( error.message ) )
+            return
+
+        }
+
+    }
+
+    done()
+
+}
+buildTask.displayName = 'build'
+buildTask.description = 'Todo...'
+buildTask.flags       = null
+
+export { buildTask }

package/.tasks/.cleans/clean.task.mjs

@@ -0,0 +1,23 @@
+import colors          from 'ansi-colors'
+import { deleteAsync } from 'del'
+import log             from 'fancy-log'
+import { cleanConf }   from '../configs/clean.conf.mjs'
+
+const red = colors.red
+
+/**
+ * @method npm run clean
+ * @global
+ * @description Will delete builds and temporary folders
+ */
+const cleanTask       = () => deleteAsync( cleanConf, {
+    onProgress: progress => {
+        const path = progress.path || 'Nothing to clean...'
+        log( `Delete [${ progress.deletedCount }/${ progress.totalCount }] (${ Math.round( progress.percent * 100 ) }%):`, red( path ) )
+    }
+} )
+cleanTask.displayName = 'clean'
+cleanTask.description = 'Will delete builds and temporary folders'
+cleanTask.flags       = null
+
+export { cleanTask }

package/.tasks/.docs/doc.task.mjs

@@ -0,0 +1,35 @@
+import colors        from 'ansi-colors'
+import log           from 'fancy-log'
+import child_process from 'node:child_process'
+import { promisify } from 'node:util'
+
+const execFile = promisify( child_process.execFile )
+const red      = colors.red
+
+/**
+ * @method npm run doc
+ * @global
+ * @description Will generate this documentation
+ */
+const docTask       = async ( done ) => {
+
+    try {
+        const { stdout } = await execFile(
+            './node_modules/.bin/jsdoc',
+            [
+                '--configure', './.tasks/configs/doc.conf.json',
+                '--destination', './docs'
+            ]
+        )
+        log( stdout )
+        done()
+    } catch ( error ) {
+        done( red( error.message ) )
+    }
+
+}
+docTask.displayName = 'doc'
+docTask.description = 'Will generate this documentation.'
+docTask.flags       = null
+
+export { docTask }

package/.tasks/.helps/help.task.mjs

@@ -0,0 +1,151 @@
+import colors from 'ansi-colors'
+import log    from 'fancy-log'
+import {
+    getPrettyNodeVersion,
+    getPrettyNpmVersion,
+    getPrettyPackageName,
+    getPrettyPackageVersion,
+    Indenter
+}             from '../_utils.mjs'
+
+const {
+          red,
+          green,
+          blue,
+          cyan,
+          yellow,
+          magenta,
+          unstyle
+      } = colors
+
+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
+
+}
+
+/**
+ * @method npm run help ( default )
+ * @global
+ * @description Will display the help in console
+ */
+const helpTask       = ( 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_,
+              I__,
+              I___,
+              I____,
+          } = new Indenter( '\t', 4 )
+
+    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()
+
+}
+helpTask.displayName = 'help'
+helpTask.description = 'Display the package help'
+helpTask.flags       = null
+
+export { helpTask }

package/.tasks/.lints/lint.task.mjs

@@ -0,0 +1,37 @@
+import colors        from 'ansi-colors'
+import log           from 'fancy-log'
+import child_process from 'node:child_process'
+import { promisify } from 'node:util'
+
+const execFile = promisify( child_process.execFile )
+const red      = colors.red
+
+/**
+ * @method npm run lint
+ * @global
+ * @description Will lint the sources files and try to fix the style when possible
+ */
+const lintTask       = async ( done ) => {
+
+    try {
+
+        const { stdout } = await execFile( 'npx', [ 'eslint', '--config', './.tasks/configs/eslint.conf.mjs', '--fix' ] )
+        if ( stdout !== '' ) {
+            log( stdout )
+        }
+
+        done()
+
+    } catch ( error ) {
+
+        log( error.stdout )
+        done( red( error.message ) )
+
+    }
+
+}
+lintTask.displayName = 'lint'
+lintTask.description = 'Will lint the sources files and try to fix the style when possible.'
+lintTask.flags       = null
+
+export { lintTask }

package/.tasks/.patches/patch.task.mjs

@@ -0,0 +1,13 @@
+/**
+ * @method npm run patch
+ * @global
+ * @description Will apply some patch/replacements in dependencies
+ */
+const patchTask       = ( done ) => {
+    done()
+}
+patchTask.displayName = 'patch'
+patchTask.description = 'Will apply some patch/replacements in dependencies'
+patchTask.flags       = null
+
+export { patchTask }

package/.tasks/.releases/release.task.mjs

@@ -0,0 +1,26 @@
+import { series }         from 'gulp'
+import { buildTestsTask } from '../.builds/build-tests.task.mjs'
+import { buildTask }      from '../.builds/build.task.mjs'
+import { cleanTask }      from '../.cleans/clean.task.mjs'
+import { docTask }        from '../.docs/doc.task.mjs'
+import { lintTask }       from '../.lints/lint.task.mjs'
+import { runTestsTask }   from '../.tests/run-tests.task.mjs'
+
+const releaseTask       = series(
+    cleanTask,
+    buildTask,
+    buildTestsTask,
+    lintTask,
+    runTestsTask,
+    docTask,
+)
+releaseTask.displayName = 'release'
+releaseTask.description = 'Will perform a complete release of the library including \'clean\', \'lint\', \'doc\', \'build-tests\', \'test\' and finally \'build\'.'
+releaseTask.flags       = null
+
+/**
+ * @method npm run release
+ * @global
+ * @description Will perform a complete release of the library including 'clean', 'lint', 'doc', 'build-tests', 'test' and finally 'build'.
+ */
+export { releaseTask }

package/.tasks/.tests/benchmarks/build-benchmarks-backend.task.mjs

@@ -0,0 +1,42 @@
+import colors                                     from 'ansi-colors'
+import log                                        from 'fancy-log'
+import { rollup }                                 from 'rollup'
+import { buildBenchmarksBackendConfig as config } from '../../configs/build-benchmarks-backend.conf.mjs'
+
+const {
+          red,
+          green
+      } = colors
+
+/**
+ * @description Will generate benchmarks bundles based on provided configs
+ */
+const buildBenchmarksBackendTask       = async ( done ) => {
+
+    if ( config === undefined || config === null || config.length === 0 ) {
+        done( red( 'Empty configuration!' ) )
+        return
+    }
+
+    log( 'Building', green( config.output.file ) )
+
+    try {
+
+        const bundle = await rollup( config )
+        await bundle.write( config.output )
+
+    } catch ( error ) {
+
+        done( red( error.message ) )
+        return
+
+    }
+
+    done()
+
+}
+buildBenchmarksBackendTask.displayName = 'build-benchmarks-backend'
+buildBenchmarksBackendTask.description = 'Will apply some patch/replacements in dependencies'
+buildBenchmarksBackendTask.flags       = null
+
+export { buildBenchmarksBackendTask }