itee-validators 5.6.0 → 6.0.0

package/.tasks/configs/build.conf.mjs

@@ -0,0 +1,354 @@
+/**
+ * @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 commonjs    from '@rollup/plugin-commonjs'
+import nodeResolve from '@rollup/plugin-node-resolve'
+import terser      from '@rollup/plugin-terser'
+import figlet      from 'figlet'
+import {
+    basename,
+    join
+}                  from 'path'
+import cleanup     from 'rollup-plugin-cleanup'
+import replace     from 'rollup-plugin-re'
+import {
+    getPrettyPackageName,
+    getPrettyPackageVersion,
+    packageBuildsDirectory,
+    packageDescription,
+    packageName,
+    packageSourcesDirectory
+}                  from '../_utils.mjs'
+
+// Utils
+
+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    ${ packageDescription }\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 )
+
+}
+
+function _computeIntro() {
+
+    return ''
+
+}
+
+/**
+ * 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 = 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 ) ? join( output, `${ fileName }.${ format }.min.js` ) : join( output, `${ fileName }.${ format }.js` )
+
+            configs.push( {
+                input:     input,
+                external:  ( format === 'cjs' ) ? [
+                    'fs'
+                ] : [],
+                plugins:   [
+                    replace( {
+                        defines: {
+                            IS_REMOVE_ON_BUILD:  false,
+                            IS_BACKEND_SPECIFIC: ( format === 'cjs' )
+                        }
+                    } ),
+                    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: {},
+
+                    // advanced options
+                    paths:     {},
+                    banner:    ( isProd ) ? '' : _computeBanner( format ),
+                    footer:    '',
+                    intro:     ( !isProd && format === 'iife' ) ? _computeIntro() : '',
+                    outro:     '',
+                    sourcemap: !isProd,
+                    interop:   'auto',
+
+                    // danger zone
+                    exports: 'auto',
+                    amd:     {},
+                    indent:  '\t',
+                    strict:  true
+                }
+            } )
+
+        }
+
+    }
+
+    return configs
+
+}
+
+// Configs
+
+const configs = {
+    'build':                                _createRollupConfigs( {
+        input:     join( packageSourcesDirectory, `${ packageName }.js` ),
+        output:    packageBuildsDirectory,
+        formats:   [ 'esm', 'cjs', 'iife' ],
+        envs:      [ 'dev', 'prod' ],
+        sourcemap: true,
+        treeshake: true
+    } ),
+    'check-bundling-from-esm-build-import': {
+        input:     null,
+        external:  [ '' ],
+        plugins:   [
+            nodeResolve( {
+                preferBuiltins: true
+            } ),
+            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:   null
+        }
+    },
+    'check-bundling-from-esm-files-import': {
+        input:     null,
+        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:   null
+        }
+    },
+    'check-bundling-from-esm-files-direct': {
+        input:     null,
+        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:   null
+        }
+    },
+}
+
+function getRollupConfigurationFor( bundleName ) {
+
+    return configs[ bundleName ]
+
+}
+
+export {
+    getRollupConfigurationFor
+}

package/.tasks/configs/check-bundling.conf.mjs

@@ -0,0 +1,26 @@
+import { glob } from 'glob'
+import {
+    basename,
+    join,
+    normalize
+}           from 'path'
+import {
+    packageName,
+    packageSourcesDirectory
+}           from '../_utils.mjs'
+
+const filePathsToIgnore = [
+    `${ packageName }.js`
+]
+
+const sourcesFiles = glob.sync( join( packageSourcesDirectory, '**' ) )
+                         .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
+                         } )
+
+export { sourcesFiles }

package/.tasks/configs/clean.conf.mjs

@@ -0,0 +1,9 @@
+const cleanConf = [
+    './builds',
+    './tests/units/builds',
+    './tests/benchmarks/builds',
+    './tests/bundles',
+    './docs'
+]
+
+export { cleanConf }

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

@@ -0,0 +1,28 @@
+import { glob } from 'glob'
+import {
+    basename,
+    join,
+    normalize
+}           from 'path'
+import {
+    packageName,
+    packageSourcesDirectory
+}           from '../_utils.mjs'
+
+
+const filePathsToIgnore = [
+    `${ packageName }.js`,
+    'isTestUnitGenerator.js'
+]
+
+const sourcesFiles = glob.sync( join( packageSourcesDirectory, '**' ) )
+                         .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
+                         } )
+
+export { sourcesFiles }

package/.tasks/configs/compute-unit-tests.conf.mjs

@@ -0,0 +1,27 @@
+import { glob } from 'glob'
+import {
+    basename,
+    join,
+    normalize
+}           from 'path'
+import {
+    packageName,
+    packageSourcesDirectory
+}           from '../_utils.mjs'
+
+
+const filePathsToIgnore = [
+    `${ packageName }.js`
+]
+
+const sourcesFiles = glob.sync( join( packageSourcesDirectory, '**' ) )
+                         .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
+                         } )
+
+export { sourcesFiles }

package/.tasks/configs/doc.conf.json

@@ -0,0 +1,50 @@
+{
+  "tags":         {
+    "allowUnknownTags": false,
+    "dictionaries":     [
+      "jsdoc",
+      "closure"
+    ]
+  },
+  "source":       {
+    "include":        [
+      "README.md",
+      "gulpfile.mjs",
+      "./sources"
+    ],
+    "includePattern": ".+\\.(js|mjs|jsx)?$",
+    "excludePattern": "(node_modules|docs|builds)",
+    "exclude":        []
+  },
+  "sourceType":   "module",
+  "plugins":      [],
+  "recurseDepth": 5,
+  "opts":         {
+    "template":    "./node_modules/ink-docstrap/template",
+    "access":      "all",
+    "debug":       false,
+    "encoding":    "utf8",
+    "destination": "docs",
+    "recurse":     true,
+    "verbose":     true,
+    "private":     true
+  },
+  "templates":    {
+    "cleverLinks":       false,
+    "monospaceLinks":    false,
+    "navType":           "inline",
+    "theme":             "cyborg",
+    "syntaxTheme":       "dark",
+    "linenums":          true,
+    "collapseSymbols":   false,
+    "sort":              "longname, version, since",
+    "search":            true,
+    "systemName":        "Itee-Validators",
+    "footer":            "",
+    "copyright":         "Copyright 2015-Present <a href=\"https://github.com/Itee\">Itee</a> (Tristan Valcke)",
+    "includeDate":       false,
+    "inverseNav":        false,
+    "outputSourceFiles": true,
+    "outputSourcePath":  true
+  }
+}

package/.tasks/configs/eslint.conf.mjs

@@ -0,0 +1,121 @@
+import js      from '@eslint/js'
+import mocha   from 'eslint-plugin-mocha'
+import {
+    defineConfig,
+    globalIgnores
+}              from 'eslint/config'
+import globals from 'globals'
+
+
+export default defineConfig( [
+    globalIgnores( [
+        '.github',
+        '.idea',
+        'builds',
+        'docs',
+        'sources/cores/tests/*.js'
+    ] ),
+    {
+        linterOptions: {
+            noInlineConfig:                false,
+            reportUnusedDisableDirectives: 'error',
+            reportUnusedInlineConfigs:     'error'
+        }
+    },
+    {
+        name:    'sources/common',
+        files:   [ 'sources/**/*.js' ],
+        ignores: [
+            'sources/dom/',
+            'sources/file-system/**'
+        ],
+        plugins: { js },
+        extends: [ 'js/recommended' ],
+        rules:   {
+            'no-multiple-empty-lines':  [
+                'error',
+                {
+                    'max': 2
+                }
+            ],
+            'no-mixed-spaces-and-tabs': 'error',
+            'no-console':               'warn',
+            'no-unused-vars':           'error',
+            'no-multi-spaces':          [
+                'error',
+                {
+                    'exceptions': {
+                        'Property':             true,
+                        'ImportDeclaration':    true,
+                        'VariableDeclarator':   true,
+                        'AssignmentExpression': true
+                    }
+                }
+            ],
+            'key-spacing':              [
+                'error',
+                {
+                    'align': {
+                        'beforeColon': false,
+                        'afterColon':  true,
+                        'on':          'value'
+                    }
+                }
+            ]
+        }
+    },
+    {
+        name:            'sources/frontend',
+        files:           [ 'sources/dom/*' ],
+        ignores:         [ 'sources/file-system/**' ],
+        plugins:         { js },
+        extends:         [ 'js/recommended' ],
+        languageOptions: { globals: globals.browser }
+    },
+    {
+        name:            'sources/backend',
+        files:           [ 'sources/file-system/**' ],
+        ignores:         [ 'sources/dom/*' ],
+        plugins:         { js },
+        extends:         [ 'js/recommended' ],
+        languageOptions: { globals: globals.node }
+    },
+    {
+        name:    'tests/benchmarks',
+        files:   [ 'tests/benchmarks/**/*.js' ],
+        ignores: [ 'tests/benchmarks/builds/*' ],
+        plugins: { js },
+        extends: [ 'js/recommended' ],
+        languageOptions: {
+            globals: {
+                Benchmark: 'readonly'
+            },
+        }
+    },
+    {
+        name:            'tests/units',
+        files:           [ 'tests/units/**/*.mjs' ],
+        ignores:         [ 'tests/units/builds/*' ],
+        plugins:         { js },
+        extends:         [ 'js/recommended' ],
+        languageOptions: {
+            globals: {
+                describe: 'readonly',
+                it: 'readonly',
+            },
+        }
+    },
+    {
+        files:   [ 'tests/units/**/*.mjs' ],
+        ignores: [ 'tests/units/builds/*' ],
+        ...mocha.configs.recommended,
+    },
+    // Todo: fix
+    {
+        name:  'to/fix',
+        files: [ 'tests/units/cores/tests/isTestUnitGenerator.unit.js' ],
+        rules: {
+            'no-unused-vars': 'warn',
+        }
+    },
+] )

package/.tasks/configs/units.conf.mjs

@@ -0,0 +1,27 @@
+import { playwrightLauncher } from '@web/test-runner-playwright'
+import { iteeReporter }       from '../itee-reporter.mjs'
+
+export default {
+    files:       [
+        // 'tests/units/builds/itee-validators.units.esm.js',
+        // OR
+        // 'tests/units/cores/arrays/*.unit.mjs',
+        // OR very slow
+        'tests/units/**/*.unit.mjs',
+        '!tests/units/builds/**',
+        '!tests/units/file-system/**',
+    ],
+    debug:       false,
+    nodeResolve: true,
+    browsers:    [
+        playwrightLauncher( { product: 'chromium' } ),
+        playwrightLauncher( { product: 'webkit' } ),
+        playwrightLauncher( { product: 'firefox' } ),
+    ],
+    // reporters:   [
+    //     iteeReporter( {
+    //         reportResults:  false,
+    //         reportProgress: false
+    //     } )
+    // ]
+}