Registry / devops / migration-builder

migration-builder

JSON →
library0.0.5jsnpmunverified

SFDX plugin to generate SFDX migration files from Excel (.xlsx) spreadsheets. Current stable version 0.0.5, low release cadence (initial release only). Differentiates by providing CLI commands to convert Excel sheets into structured migration files for Salesforce DX deployments, with options to merge mappings by object and specify starting sheet index.

devops
npm install migration-builder
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · MIGRATION-BUILDER
M
migration-builder
devopsjavascriptv0.0.5
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

run
✓ import { run } from '@oclif/core'
✗ const run = require('@oclif/core').run
ESM-style import; package uses oclif v2
SfdxCommand
✓ import { SfdxCommand } from '@salesforce/command'
✗ import { SfdxCommand } from 'sfdx-command'
From @salesforce/command package; part of SFDX toolbelt
XLSX
✓ import * as XLSX from 'xlsx'
For parsing Excel files; default export is a namespace

Install the SFDX plugin globally and run the migration:build command to generate migration files from an Excel spreadsheet.

// Install plugin globally // npm install -g migration-builder // Run build command // sfdx migration:build -s "/path/to/input.xlsx" -t /path/to/output -p 1 // Example with merge mappings flag // sfdx migration:build -s "input.xlsx" -t ./results -p 1 -m
Debug
Known issues
gotchaSheet index (-p flag) is 1-indexed; index 1 corresponds to first sheet in Excel
fix
Confirm your Excel sheet order and use 1 as the first sheet index
affects: >=0.0.0
gotchaSource file must be .xlsx format; older .xls not supported
fix
Save Excel file as .xlsx before using
affects: >=0.0.0
deprecatedPlugin uses oclif v1 style commands; future SFDX versions may drop support
fix
Watch for migration to @oclif/core v2
affects: >=0.0.0
Errors
Common errors & fixes
Error: Cannot find module '@oclif/core'
Missing dependency for oclif CLI framework or incorrect Node version
fix
Ensure Node >=14 and reinstall plugin with npm install -g migration-builder
Error: ENOENT: no such file or directory, open '...'
Specified source file path does not exist or is not accessible
fix
Provide absolute path to the .xlsx file and verify file permissions
Error: Sheet index out of range. The index 0 is not valid
Using 0-based index accidentally; flag -p expects 1-based index
fix
Set -p to 1 for first sheet, 2 for second, etc.
Upgrade
Version history
0.0.5latest on npm
Audit
Dependencies
@oclif/corerequiredCLI framework used by SFDX plugins
@salesforce/corerequiredCore Salesforce DX library
xlsxrequiredExcel file parsing
Agent activity
6 hits · last 30 days
node
4
Amazon
1
Resources
githubhttps://github.com/jesuRule/migration-builder ↗
packagemigration-builder ↗
homepagehttps://github.com/jesuRule/migration-builder ↗
migration-builder — npm install migration-builder · libregistry