@sequencemedia/gulp-cli 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Blaine Bublitz, Eric Schoffstall and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,13 @@
+<p align="center">
+  <a href="http://gulpjs.com">
+    <img width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
+  </a>
+</p>
+
+# @sequencemedia/gulp-cli
+
+This project is a fork of Gulp CLI `v2.3.0` refactored in ESM and updated with latest dependencies
+
+## Documentation
+
+Refer to [documentation at the Gulp website](https://gulpjs.com/docs/en/getting-started/quick-start)

package/bin/gulp.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import gulpCli from '#gulp-cli'
+
+export default gulpCli()

package/completion/README.md

@@ -0,0 +1,20 @@
+# Completion for gulp
+> Thanks to the grunt team, specifically Tyler Kellen
+
+To enable tasks auto-completion in shell you should add `eval "$(gulp --completion=shell)"` in your `.shellrc` file.
+
+## Bash
+
+Add `eval "$(gulp --completion=bash)"` to `~/.bashrc`.
+
+## Zsh
+
+Add `eval "$(gulp --completion=zsh)"` to `~/.zshrc`.
+
+## Powershell
+
+Add `Invoke-Expression ((gulp --completion=powershell) -join [System.Environment]::NewLine)` to `$PROFILE`.
+
+## Fish
+
+Add `gulp --completion=fish | source` to `~/.config/fish/config.fish`.

package/completion/bash

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+# Borrowed from grunt-cli
+# http://gruntjs.com/
+#
+# Copyright (c) 2012 Tyler Kellen, contributors
+# Licensed under the MIT license.
+# https://github.com/gruntjs/grunt/blob/master/LICENSE-MIT
+
+# Usage:
+#
+# To enable bash <tab> completion for gulp, add the following line (minus the
+# leading #, which is the bash comment character) to your ~/.bashrc file:
+#
+# eval "$(gulp --completion=bash)"
+
+# Enable bash autocompletion.
+function _gulp_completions() {
+  # The currently-being-completed word.
+  local cur="${COMP_WORDS[COMP_CWORD]}"
+  #Grab tasks
+  local compls=$(gulp --tasks-list)
+  # Tell complete what stuff to show.
+  COMPREPLY=($(compgen -W "$compls" -- "$cur"))
+}
+
+complete -o default -F _gulp_completions gulp

package/completion/fish

@@ -0,0 +1,10 @@
+#!/usr/bin/env fish
+
+# Usage:
+#
+# To enable fish <tab> completion for gulp, add the following line to
+# your ~/.config/fish/config.fish file:
+#
+# gulp --completion=fish | source
+
+complete -c gulp -a "(gulp --tasks-list)" -f

package/completion/powershell

@@ -0,0 +1,61 @@
+# Copyright (c) 2014 Jason Jarrett
+#
+# Tab completion for the `gulp`
+#
+# Usage:
+#
+# To enable powershell <tab> completion for gulp you need to be running
+# at least PowerShell v3 or greater and add the below to your $PROFILE
+#
+#     Invoke-Expression ((gulp --completion=powershell) -join [System.Environment]::NewLine)
+#
+#
+
+$gulp_completion_Process = {
+    param($commandName, $parameterName, $wordToComplete, $commandAst, $fakeBoundParameter)
+
+
+	# Load up an assembly to read the gulpfile's sha1
+	if(-not $global:GulpSHA1Managed) {
+		[Reflection.Assembly]::LoadWithPartialName("System.Security") | out-null
+		$global:GulpSHA1Managed = new-Object System.Security.Cryptography.SHA1Managed
+	}
+
+	# setup a global (in-memory) cache
+	if(-not $global:GulpfileShaCache) {
+		$global:GulpfileShaCache = @{};
+	}
+
+	$cache = $global:GulpfileShaCache;
+
+	# Get the gulpfile's sha1
+	$sha1gulpFile = (resolve-path gulpfile.js -ErrorAction Ignore | %{
+		$file = [System.IO.File]::Open($_.Path, "open", "read")
+		[string]::join('', ($global:GulpSHA1Managed.ComputeHash($file) | %{ $_.ToString("x2") }))
+		$file.Dispose()
+	})
+
+	# lookup the sha1 for previously cached task lists.
+	if($cache.ContainsKey($sha1gulpFile)){
+		$tasks = $cache[$sha1gulpFile];
+	} else {
+		$tasks = (gulp --tasks-list).split("`n");
+		$cache[$sha1gulpFile] = $tasks;
+	}
+
+
+    $tasks |
+        where { $_.startswith($commandName) }
+        Sort-Object |
+        foreach { New-Object System.Management.Automation.CompletionResult $_, $_, 'ParameterValue', ('{0}' -f $_) }
+}
+
+if (-not $global:options) {
+    $global:options = @{
+        CustomArgumentCompleters = @{};
+        NativeArgumentCompleters = @{}
+    }
+}
+
+$global:options['NativeArgumentCompleters']['gulp'] = $gulp_completion_Process
+$function:tabexpansion2 = $function:tabexpansion2 -replace 'End\r\n{','End { if ($null -ne $options) { $options += $global:options} else {$options = $global:options}'

package/completion/zsh

@@ -0,0 +1,25 @@
+#!/bin/zsh
+
+# Borrowed from grunt-cli
+# http://gruntjs.com/
+#
+# Copyright (c) 2012 Tyler Kellen, contributors
+# Licensed under the MIT license.
+# https://github.com/gruntjs/grunt/blob/master/LICENSE-MIT
+
+# Usage:
+#
+# To enable zsh <tab> completion for gulp, add the following line (minus the
+# leading #, which is the zsh comment character) to your ~/.zshrc file:
+#
+# eval "$(gulp --completion=zsh)"
+
+# Enable zsh autocompletion.
+function _gulp_completion() {
+  # Grab tasks
+  compls=$(gulp --tasks-list)
+  completions=(${=compls})
+  compadd -- $completions
+}
+
+compdef _gulp_completion gulp

package/gulp.1

@@ -0,0 +1,83 @@
+.TH "GULP" "" "April 2023" "" ""
+.SH "NAME"
+\fBgulp\fR
+.SS Usage
+.P
+\fBgulp [flags] <task> <task>\.\.\.\fP
+.SS Tasks
+.P
+The task(s) listed will be executed\.
+If more than one task is listed, Gulp will execute all of them
+concurrently, that is, as if they had all been listed as dependencies of
+a single task\.
+.P
+By default, Gulp does not serialize tasks listed on the command line\. If you would like to execute tasks serially, you must specify the \fB\-\-series\fP flag\. e\.g\. \fBgulp clean build \-\-series\fP
+.P
+Just running \fBgulp\fP will execute the task \fBdefault\fP\|\. If there is no
+\fBdefault\fP task, gulp will error\.
+.SS Compilers
+.P
+You can find a list of supported languages at https:// \fIhttps://github\.com/gulpjs/interpret\fR\|\. If you would like to add support for a new language, send pull requests/open issues on that project\.
+.SS Environment
+.P
+The CLI adds process\.env\.INIT_CWD which is the original cwd it was launched from\.
+.SS Flags
+.P
+gulp has very few flags to know about\. All other flags are for tasks to use if needed\.
+.P
+\fBSome flags only work with gulp 4 and will be ignored when invoked against gulp 3\.\fR
+.P
+\fB\-\-help\fR, \fB\-h\fR
+    Show the help\.
+.P
+\fB\-\-version\fR, \fB\-v\fR
+    Print the global and local gulp versions\.
+.P
+\fB\-\-require\fR [path]
+    Will require a module before running the gulpfile\. This is useful for transpilers but also has other applications\.
+.P
+\fB\-\-gulpfile\fR [path], \fB\-f\fR [path]
+    Manually set path of gulpfile\. Useful if you have multiple gulpfiles\. This will set the CWD to the gulpfile directory as well\.
+.P
+\fB\-\-cwd\fR [path]
+    Manually set the CWD\. The search for the gulpfile, as well as the relativity of all requires will be from here\.
+.P
+\fB\-\-verify\fR [path (optional)]
+    Will verify plugins referenced in project's package\.json against the plugins blacklist\.
+.P
+\fB\-\-tasks\fR, \fB\-T\fR
+    Print the task dependency tree for the loaded gulpfile\.
+.P
+\fB\-\-tasks\-simple\fR
+    Print a plaintext list of tasks for the loaded gulpfile\.
+.P
+\fB\-\-tasks\-json\fR [path]
+    Print the task dependency tree, in JSON format, for the loaded gulpfile\. The [path] argument is optional, and if given writes the JSON to the path\.
+.P
+\fB\-\-tasks\-depth\fR [number]
+    Specify the depth of the task dependency tree to print\. This flag can be used with \-\-tasks or \-\-tasks\-json\. (This flag was named \-\-depth before but is deprecated\.)
+.P
+\fB\-\-compact\-tasks\fR
+    Reduce the output of task dependency tree by printing only top tasks and their child tasks\. This flag can be used with \-\-tasks or \-\-tasks\-json\.
+.P
+\fB\-\-sort\-tasks\fR
+    Will sort top tasks of task dependency tree\. This flag can be used with \-\-tasks\.
+.P
+\fB\-\-color\fR
+    Will force gulp and gulp plugins to display colors, even when no color support is detected\.
+.P
+\fB\-\-no\-color\fR
+    Will force gulp and gulp plugins to not display colors, even when color support is detected\.
+.P
+\fB\-\-silent\fR, \fB\-S\fR
+    Suppress all gulp logging\.
+.P
+\fB\-\-continue\fR
+    Continue execution of tasks upon failure\.
+.P
+\fB\-\-series\fR
+    Run tasks given on the CLI in series (the default is parallel)\.
+.P
+\fB\-\-log\-level\fR, \fB\-L\fR
+    Set the loglevel\. \-L for least verbose and \-LLLL for most verbose\. \-LLL is default\.
+

package/index.mjs

@@ -0,0 +1,140 @@
+
+import path from 'node:path'
+import log from 'gulplog'
+import yargs from 'yargs'
+import {
+  hideBin
+} from 'yargs/helpers'
+import Liftoff from '@sequencemedia/liftoff'
+import interpret from 'interpret'
+import v8flags from 'v8flags'
+
+import ansi from './lib/ansi.mjs'
+import exit from './lib/exit.mjs'
+import tildify from './lib/tildify.mjs'
+import getProcessTitle from './lib/get-process-title.mjs'
+import cliOptions from './lib/cli-options.mjs'
+import getCompletion from './lib/get-completion.mjs'
+
+import listenForLevelEvents from './lib/log/listen-for-level-events.mjs'
+
+import loadConfigFiles from './lib/config/load-files.mjs'
+import mergeConfigToCliFlags from './lib/config/cli-flags.mjs'
+import mergeConfigToEnvFlags from './lib/config/env-flags.mjs'
+
+import runVersion from './lib/run-version.mjs'
+import runVerify from './lib/run-verify.mjs'
+import run from './lib/index.mjs'
+
+// Set env var for ORIGINAL cwd
+// before anything touches it
+const INIT_CWD = process.cwd()
+process.env.INIT_CWD = INIT_CWD
+
+const cli = new Liftoff({
+  name: 'gulp',
+  configName: 'gulpfile',
+  moduleName: '@sequencemedia/gulp',
+  processTitle: getProcessTitle(process.argv.slice(2)),
+  completions: getCompletion,
+  extensions: interpret.jsVariants,
+  v8flags,
+  configFiles: {
+    '.gulp': {
+      home: {
+        path: '~',
+        extensions: interpret.extensions
+      },
+      cwd: {
+        path: '.',
+        extensions: interpret.extensions
+      }
+    }
+  }
+})
+
+let {
+  argv: cliProps
+} = (
+  yargs(hideBin(process.argv))
+    .version(false)
+    .usage(`${ansi.bold('Usage')}: $0 ${ansi.blue('[options]')} tasks`)
+    .options(cliOptions)
+)
+
+cli.on('require', (name) => {
+  // This is needed because interpret needs to stub the .mjs extension
+  // Without the .mjs require hook, rechoir blows up
+  // However, we don't want to show the mjs-stub loader in the logs
+  if (path.basename(name, '.js') !== 'mjs-stub') {
+    log.info('Loading external module', ansi.magenta(name))
+  }
+})
+
+cli.on('requireFail', (name, error) => {
+  log.warn(`${ansi.yellow('Failed to load external module')} ${ansi.magenta(name)}`)
+
+  if (error) {
+    log.warn(ansi.yellow(error.toString()))
+  }
+})
+
+cli.on('respawn', (nodeFlags, { pid }) => {
+  log.info(`Node flags detected: ${ansi.magenta(nodeFlags.join(', '))}`)
+  log.info(`Respawned to PID: ${ansi.magenta(pid)}`)
+})
+
+function execute (envProps, cliProps, configProps) {
+  /**
+   * Does not depend on Gulp
+   */
+  if (cliProps.version) return runVersion(envProps, cliProps)
+
+  /**
+   * Does not depend on Gulp
+   */
+  if (cliProps.verify) return runVerify(envProps, cliProps)
+
+  /**
+   * Depends on Gulp
+   */
+  const GULP_CWD = path.normalize(envProps.cwd)
+  process.env.GULP_CWD = GULP_CWD
+
+  if (!envProps.modulePath) {
+    log.error(`${ansi.red('Gulp not found')} in ${ansi.magenta(tildify(GULP_CWD))}`)
+    exit(1)
+  }
+
+  if (!envProps.configPath) {
+    log.error(`${ansi.red('Gulpfile not found')} in ${ansi.magenta(tildify(GULP_CWD))}`)
+    exit(1)
+  }
+
+  if (cliProps.continue) process.env.UNDERTAKER_SETTLE = 'true'
+
+  if (INIT_CWD !== GULP_CWD) process.chdir(GULP_CWD)
+
+  return (
+    run(cliProps, envProps, configProps)
+  )
+}
+
+export default function prepare () {
+  cli.prepare({
+    cwd: cliProps.cwd,
+    configPath: cliProps.gulpfile,
+    require: cliProps.require,
+    completion: cliProps.completion
+  }, async (envProps) => {
+    const configProps = await loadConfigFiles(envProps.configFiles['.gulp'], ['home', 'cwd'])
+
+    cliProps = mergeConfigToCliFlags(cliProps, configProps)
+    envProps = mergeConfigToEnvFlags(envProps, configProps, cliProps)
+
+    // Set up log level event listeners
+    listenForLevelEvents(cliProps)
+
+    cli.execute(envProps, envProps.nodeFlags, (envProps) => execute(envProps, cliProps, configProps))
+  })
+}

package/lib/ansi.mjs

@@ -0,0 +1,46 @@
+import ansiColors from 'ansi-colors'
+import colorSupport from 'color-support'
+
+const HAS_NO_COLOR = process.argv.includes('--no-color')
+const HAS_COLOR = process.argv.includes('--color')
+const HAS_COLOR_SUPPORT = hasColorSupport(colorSupport())
+
+function hasColorSupport ({ hasBasic, has256, has16m }) {
+  return (
+    hasBasic ||
+    has256 ||
+    has16m
+  )
+}
+
+function hasColor () {
+  if (HAS_NO_COLOR) {
+    return false
+  }
+
+  return (
+    HAS_COLOR ||
+    HAS_COLOR_SUPPORT
+  )
+}
+
+function noColor (message) {
+  return message
+}
+
+export default (
+  hasColor()
+    ? ansiColors
+    : {
+        red: noColor,
+        green: noColor,
+        blue: noColor,
+        magenta: noColor,
+        cyan: noColor,
+        white: noColor,
+        gray: noColor,
+        bgred: noColor,
+        bold: noColor,
+        yellow: noColor
+      }
+)

package/lib/cli-options.mjs

@@ -0,0 +1,120 @@
+import ansi from './ansi.mjs'
+
+export default {
+  help: {
+    alias: 'h',
+    type: 'boolean',
+    desc: ansi.gray(
+      'Show this help.')
+  },
+  version: {
+    alias: 'v',
+    type: 'boolean',
+    desc: ansi.gray(
+      'Print the global and local gulp versions.')
+  },
+  require: {
+    type: 'string',
+    requiresArg: true,
+    desc: ansi.gray(
+      'Will require a module before running the gulpfile. ' +
+      'This is useful for transpilers but also has other applications.')
+  },
+  gulpfile: {
+    alias: 'f',
+    type: 'string',
+    requiresArg: true,
+    desc: ansi.gray(
+      'Manually set path of gulpfile. Useful if you have multiple gulpfiles. ' +
+      'This will set the CWD to the gulpfile directory as well.')
+  },
+  cwd: {
+    type: 'string',
+    requiresArg: true,
+    desc: ansi.gray(
+      'Manually set the CWD. The search for the gulpfile, ' +
+      'as well as the relativity of all requires will be from here.')
+  },
+  verify: {
+    desc: ansi.gray(
+      'Will verify plugins referenced in project\'s package.json against ' +
+      'the plugins blacklist.')
+  },
+  tasks: {
+    alias: 'T',
+    type: 'boolean',
+    desc: ansi.gray(
+      'Print the task dependency tree for the loaded gulpfile.')
+  },
+  'tasks-list': {
+    type: 'boolean',
+    desc: ansi.gray(
+      'Print a list of tasks for the loaded gulpfile.')
+  },
+  'tasks-json': {
+    desc: ansi.gray(
+      'Print the task dependency tree, ' +
+      'in JSON format, for the loaded gulpfile.')
+  },
+  'tasks-depth': {
+    alias: 'depth',
+    type: 'number',
+    requiresArg: true,
+    default: undefined, // To detect if this cli option is specified.
+    desc: ansi.gray(
+      'Specify the depth of the task dependency tree.')
+  },
+  'compact-tasks': {
+    type: 'boolean',
+    default: undefined, // To detect if this cli option is specified.
+    desc: ansi.gray(
+      'Reduce the output of task dependency tree by printing ' +
+      'only top tasks and their child tasks.')
+  },
+  'sort-tasks': {
+    type: 'boolean',
+    default: undefined, // To detect if this cli option is specified.
+    desc: ansi.gray(
+      'Will sort top tasks of task dependency tree.')
+  },
+  color: {
+    type: 'boolean',
+    desc: ansi.gray(
+      'Will force gulp and gulp plugins to display colors, ' +
+      'even when no color support is detected.')
+  },
+  'no-color': {
+    type: 'boolean',
+    desc: ansi.gray(
+      'Will force gulp and gulp plugins to not display colors, ' +
+      'even when color support is detected.')
+  },
+  silent: {
+    alias: 'S',
+    type: 'boolean',
+    default: undefined, // To detect if this cli option is specified.
+    desc: ansi.gray(
+      'Suppress all gulp logging.')
+  },
+  continue: {
+    type: 'boolean',
+    default: undefined, // To detect if this cli option is specified.
+    desc: ansi.gray(
+      'Continue execution of tasks upon failure.')
+  },
+  series: {
+    type: 'boolean',
+    default: undefined, // To detect if this cli option is specified.
+    desc: ansi.gray(
+      'Run tasks given on the CLI in series (the default is parallel).')
+  },
+  'log-level': {
+    alias: 'L',
+    // Type isn't needed because count acts as a boolean
+    count: true,
+    default: undefined, // To detect if this cli option is specified.
+    desc: ansi.gray(
+      'Set the loglevel. -L for least verbose and -LLLL for most verbose. ' +
+      '-LLL is default.')
+  }
+}

package/lib/config/cli-flags.mjs

@@ -0,0 +1,21 @@
+import copyProps from 'copy-props'
+
+const fromTo = {
+  'flags.silent': 'silent',
+  'flags.continue': 'continue',
+  'flags.series': 'series',
+  'flags.logLevel': 'logLevel',
+  'flags.compactTasks': 'compactTasks',
+  'flags.tasksDepth': 'tasksDepth',
+  'flags.sortTasks': 'sortTasks'
+}
+
+export default function mergeConfigToCliFlags (cliProps, configProps) {
+  return (
+    copyProps(configProps, cliProps, fromTo, (configProps, cliProps) => {
+      if (cliProps.value === undefined) {
+        return configProps.value
+      }
+    })
+  )
+}

package/lib/config/env-flags.mjs

@@ -0,0 +1,41 @@
+import path from 'node:path'
+import copyProps from 'copy-props'
+
+const toFrom = {
+  configPath: 'flags.gulpfile',
+  configBase: 'flags.gulpfile',
+  require: 'flags.require',
+  nodeFlags: 'flags.nodeFlags'
+}
+
+function getConvert (cliProps) {
+  return function convert (config, env) {
+    if (env.keyChain === 'configBase') {
+      if (cliProps.gulpfile === undefined) {
+        return path.dirname(config.value)
+      }
+      return
+    }
+
+    if (env.keyChain === 'configPath') {
+      if (cliProps.gulpfile === undefined) {
+        return config.value
+      }
+      return
+    }
+
+    if (env.keyChain === 'require') {
+      return [].concat(env.value, config.value)
+    }
+
+    if (env.keyChain === 'nodeFlags') {
+      return [].concat(config.value || [])
+    }
+  }
+}
+
+export default function mergeConfigToEnvFlags (envProps, configProps, cliProps) {
+  return (
+    copyProps(envProps, configProps, toFrom, getConvert(cliProps), true) // This must reverse because `flags.gulpfile` determines 2 different properties
+  )
+}