@uxf/scripts

@uxf/scripts

uxf-release

UXF release helper
Usage:
  uxf-release [options]

Environment variables:
  GITLAB_TOKEN      - required
  CI_SERVER_URL     - required - setting by GitLab CI
  CI_PROJECT_ID     - required - setting by GitLab CI
  SLACK_WEBHOOK_URL - optional

Options
  -p, --project-id  GitLab project id (or use environment variable
                    CI_PROJECT_ID)                                      [number]
  -d, --dry-run     Skip publishing and sending slack notification     [boolean]
  -h, --help        Show help                                          [boolean]

Options:
      --version  Show version number                                   [boolean]

How to use in gitlab pipeline .gitlab-ci.yml

set environment variable GITLAB_TOKEN in GitLab CI configuration and create .gitlab-ci.yml

# .gitlab-ci.yml
stages:
  - release

release:
  image: node:12-buster-slim
  stage: release
  before_script:
    - yarn global add @uxf/release
  script:
    # ... deploy project ...
    - uxf-release

uxf-push-notifier

stages:
  - notify

notify-push:
    image: node:20
    stage: notify
    except: [schedules]
    only:
        - develop # default branch
    script:
        - yarn global add @uxf/scripts # uxf scripts are installed in uxf docker images by default
        - uxf-push-notifier --google-chat-webhook-url=$GOOGLE_CHAT_WEBHOOK

uxf-dependencies-check

All-in-one dependency health check for projects using @uxf/* packages. Runs two checks:

1. Version conflict detection — parses the lock file and reports dependencies of @uxf/* packages that resolve to multiple versions
2. Peer dependency check — verifies that all peerDependencies of installed @uxf/* packages are present and version-matched

Supports yarn, npm, pnpm, and bun. The package manager is auto-detected from the lock file.

Usage:
  uxf-dependencies-check [options]

Options:
  --fix           Auto-install missing/mismatched peer dependencies
  --dry-run       Show what would be installed without changes
  -e, --exclude   Packages to ignore in conflict check              [array]
  -h, --help      Show help                                        [boolean]

Build-time dependencies (yargs, fast-glob) are automatically ignored in the conflict check.

Examples

# Run both checks (exits with code 1 if issues found)
npx uxf-dependencies-check

# Auto-install missing peer deps
npx uxf-dependencies-check --fix

# Preview what would be installed
npx uxf-dependencies-check --dry-run

# Ignore specific packages in conflict check
npx uxf-dependencies-check --exclude lodash dayjs

Ignoring known conflicts

Some version conflicts are caused by third-party packages and cannot be resolved (e.g. @udecode/plate-floating pulling an old @floating-ui/react). Each @uxf/* package can declare known conflicts in its own package.json:

{
  "name": "@uxf/wysiwyg",
  "uxf": {
    "ignoredConflicts": ["@floating-ui/react"]
  }
}

Ignored conflicts are still printed as informational output but do not cause a non-zero exit code. The --exclude CLI flag hides packages completely (not printed at all).

What it checks

• Parses the lock file (yarn.lock / package-lock.json / pnpm-lock.yaml / bun.lock) to detect version conflicts
• Scans all @uxf/* packages in your dependencies / devDependencies
• Reads each package's peerDependencies from node_modules
• Skips @uxf/*, react, react-dom, and next (you manage these yourself)
• Reports missing dependencies and version mismatches
• Distinguishes between prod and dev dependencies — peer deps required only by devDependencies are installed with -D
• With --fix, auto-installs missing peer deps using the detected package manager

uxf-lunch

UXF lunch
Usage:
  uxf-lunch [options]

Environment variables:
  SLACK_TOKEN - required

Options
      --slack-channel  Slack channel                                    [string]
  -h, --help           Show help                                       [boolean]

Options:
      --version  Show version number