@sequencemedia/gulp-cli 1.0.0

package/lib/run-gulp-tasks-tree.mjs

@@ -0,0 +1,16 @@
+import ansi from './ansi.mjs'
+import tildify from './tildify.mjs'
+
+import logTasks from './log/tasks.mjs'
+import getTask from './get-task.mjs'
+
+export default function runGulpTasksTree (gulp, cliProps, envProps, configProps) {
+  const tree = gulp.tree({ deep: true })
+  if (configProps.description && typeof configProps.description === 'string') {
+    tree.label = configProps.description
+  } else {
+    tree.label = `Tasks for ${ansi.magenta(tildify(envProps.configPath))}`
+  }
+
+  return logTasks(tree, cliProps, getTask(gulp))
+}

package/lib/run-gulp-tasks.mjs

@@ -0,0 +1,46 @@
+import log from 'gulplog'
+
+import ansi from './ansi.mjs'
+import exit from './exit.mjs'
+import tildify from './tildify.mjs'
+
+import runGulpTasksListTree from './run-gulp-tasks-list-tree.mjs'
+import runGulpTasksTree from './run-gulp-tasks-tree.mjs'
+import runGulpTasksJsonTree from './run-gulp-tasks-json-tree.mjs'
+
+function getMethodFromCliProps ({ series = false }) {
+  return series ? 'series' : 'parallel'
+}
+
+function getTasksFromCliProps ({ _: tasks = [] }) {
+  return (
+    tasks.length ? [...tasks] : ['default']
+  )
+}
+
+export default function runGulpTasks (gulp, cliProps, envProps, configProps) {
+  if (cliProps.tasksList) return runGulpTasksListTree(gulp)
+
+  if (cliProps.tasks) return runGulpTasksTree(gulp, cliProps, envProps, configProps)
+
+  if (cliProps.tasksJson) return runGulpTasksJsonTree(gulp, cliProps, envProps, configProps)
+
+  try {
+    const {
+      configPath
+    } = envProps
+
+    log.info(`Using gulpfile ${ansi.magenta(tildify(configPath))}`)
+
+    const method = getMethodFromCliProps(cliProps)
+    const tasks = getTasksFromCliProps(cliProps)
+
+    return (
+      gulp[method](tasks)((e) => e && exit(1))
+    )
+  } catch ({ message }) {
+    log.error(ansi.red(message))
+    log.error('To list available tasks run: gulp --tasks')
+    exit(1)
+  }
+}

package/lib/run-verify.mjs

@@ -0,0 +1,56 @@
+import path from 'node:path'
+
+import {
+  readFile
+} from 'node:fs/promises'
+
+import log from 'gulplog'
+
+import ansi from './ansi.mjs'
+import exit from './exit.mjs'
+import tildify from './tildify.mjs'
+
+import getBlacklist from './get-blacklist.mjs'
+import getPackageBlacklist from './get-package-blacklist.mjs'
+
+function getPackagePath (envProps, cliProps) {
+  let packagePath = cliProps.verify !== true ? cliProps.verify : './package.json'
+
+  if (path.resolve(packagePath) !== path.normalize(packagePath)) {
+    packagePath = path.join(path.normalize(envProps.cwd), packagePath)
+  }
+
+  return packagePath
+}
+
+async function getPackageJson (packagePath) {
+  const fileData = await readFile(packagePath)
+  return JSON.parse(fileData.toString())
+}
+
+export default async function runVerify (envProps, cliProps) {
+  const packagePath = getPackagePath(envProps, cliProps)
+
+  log.info(`Verifying dependencies in ${ansi.magenta(tildify(packagePath))}`)
+  try {
+    const blacklistJson = await getBlacklist()
+    const packageJson = await getPackageJson(packagePath)
+    const packageBlacklist = getPackageBlacklist(packageJson, blacklistJson)
+
+    const dependencies = Object.entries(packageBlacklist)
+    if (dependencies.length) {
+      log.warn(ansi.red('Blacklisted dependencies in this project:'))
+      dependencies
+        .forEach(([name, reason]) => {
+          log.warn(`${ansi.bgred(name)}: ${reason}`)
+        })
+      exit(1)
+    }
+
+    log.info(ansi.green('There are no blacklisted dependencies in this project'))
+    exit(0)
+  } catch ({ message }) {
+    log.error(`${ansi.red('Failed to verify dependencies.')} Could not get blacklist - ${message}`)
+    exit(1)
+  }
+}

package/lib/run-version.mjs

@@ -0,0 +1,26 @@
+import {
+  join
+} from 'node:path'
+
+import exit from './exit.mjs'
+
+import ROOT from '#where-am-i'
+
+async function getGulpCliVersion () {
+  const {
+    default: {
+      version
+    }
+  } = await import(join(ROOT, 'package.json'), { assert: { type: 'json' } })
+  return version
+}
+
+function getGulpVersion ({ modulePackage: { version = 'unknown' } = {} }) {
+  return version
+}
+
+export default async function runVersion (envProps) {
+  console.log(`Gulp CLI version: ${await getGulpCliVersion()}`)
+  console.log(`Gulp version: ${getGulpVersion(envProps)}`)
+  exit(0)
+}

package/lib/tildify.mjs

@@ -0,0 +1,5 @@
+import replaceHomedir from 'replace-homedir'
+
+export default function tildify (filePath) {
+  return replaceHomedir(filePath, '~')
+}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@sequencemedia/gulp-cli",
+  "version": "1.0.0",
+  "description": "Command line interface for gulp",
+  "keywords": [
+    "build",
+    "stream",
+    "system",
+    "make",
+    "tool",
+    "asset",
+    "pipeline"
+  ],
+  "main": "./index.mjs",
+  "type": "module",
+  "author": "Jonathan Perry for Sequence Media Limited <sequencemedia@sequencemedia.net>",
+  "contributors": [
+    "Gulp Team <team@gulpjs.com> (https://gulpjs.com/)"
+  ],
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.5.0"
+  },
+  "repository": "sequencemedia/gulp-cli",
+  "homepage": "https://gulpjs.com",
+  "scripts": {
+    "lint": "eslint . --ext .mjs --ext .cjs",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "NODE_OPTIONS=--no-warnings mocha -b --recursive test/gulp-cli",
+    "prepare": "husky install"
+  },
+  "bin": {
+    "gulp": "bin/gulp.mjs"
+  },
+  "dependencies": {
+    "@sequencemedia/liftoff": "1.0.0",
+    "ansi-colors": "^4.1.3",
+    "archy": "^1.0.0",
+    "array-sort": "^1.0.0",
+    "color-support": "^1.1.3",
+    "copy-props": "^4.0.0",
+    "fancy-log": "^2.0.0",
+    "gulplog": "^2.0.1",
+    "interpret": "^3.1.1",
+    "isobject": "^4.0.0",
+    "matchdep": "^2.0.0",
+    "mute-stdout": "^2.0.0",
+    "pretty-hrtime": "^1.0.3",
+    "replace-homedir": "^2.0.0",
+    "v8flags": "^4.0.0",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.5",
+    "@babel/eslint-parser": "^7.21.3",
+    "@babel/plugin-syntax-import-assertions": "^7.20.0",
+    "@babel/preset-env": "^7.21.5",
+    "chai": "^4.3.7",
+    "eslint": "^8.39.0",
+    "eslint-config-standard": "^17.0.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "expect": "^29.5.0",
+    "husky": "^8.0.3",
+    "mocha": "^10.2.0",
+    "rimraf": "^5.0.0",
+    "sinon": "^15.0.4"
+  },
+  "man": "gulp.1",
+  "files": [
+    "index.mjs",
+    "where-am-i.mjs",
+    "lib",
+    "bin",
+    "completion",
+    "gulp.1"
+  ],
+  "imports": {
+    "#gulp-cli/lib/*": "./lib/*.mjs",
+    "#gulp-cli": "./index.mjs",
+    "#where-am-i": "./where-am-i.mjs"
+  }
+}

package/where-am-i.mjs

@@ -0,0 +1,9 @@
+import {
+  fileURLToPath
+} from 'node:url'
+
+import {
+  dirname
+} from 'node:path'
+
+export default dirname(fileURLToPath(import.meta.url))