Skip to content
This repository was archived by the owner on Sep 25, 2026. It is now read-only.
BranchesTags

Repository files navigation

npm version AI-Assisted

Warning

This repository is archived and the xlsform2lstsv npm package is deprecated. The converter now lives in @correlaid/formtransform as the xlsform2lstsv pipeline. Use formtransform xlsform2lstsv survey.xlsx -o survey.tsv instead.

xlsform2lstsv

Convert XLSForm surveys to LimeSurvey TSV format.

[!WARNING]

  • This package is still WIP and not all features of xlsform have been implemented and verified.
  • While importing is tested in an automated fashion (see scripts/test-compatibility-safe.ts), this only verifies whether all questions were successfully imported, but not if e.g. validation and relevance expressions were transformed correctly. To be safe, always use the "Survey logic view" in the LimeSurvey GUI.
  • To keep question and choice names unchanged after conversion, use short alphanumeric IDs (≤ 20 chars for questions, ≤ 5 chars for choices) without underscores or hyphens.

Installation

npm install xlsform2lstsv

Quick Start

The XFormParser provides direct XLS/XLSX file support:

import { XFormParser } from 'xlsform2lstsv';

// Parse XLS/XLSX file and convert to TSV
const tsv = await XFormParser.convertXLSFileToTSV('path/to/survey.xlsx');

// Or parse XLS/XLSX data directly
const xlsxData = fs.readFileSync('path/to/survey.xlsx');
const tsv = await XFormParser.convertXLSDataToTSV(xlsxData);

Methods:

  • convertXLSFileToTSV(filePath, config): Direct conversion from file
  • convertXLSDataToTSV(data, config): Direct conversion from buffer
  • parseXLSFile(filePath): Parse to structured arrays
  • parseXLSData(data): Parse buffer to structured arrays

Using Arrays

A different entry point accepts XLSForm data as JavaScript arrays:

import { XLSFormToTSVConverter } from 'xlsform2lstsv';

const converter = new XLSFormToTSVConverter();
const tsv = converter.convert(surveyData, choicesData, settingsData);

Parameters:

  • surveyData: Array of survey rows (questions, groups, etc.)
  • choicesData: Array of choice/option data
  • settingsData: Array of survey settings

Returns: TSV string suitable for LimeSurvey import

Configuration

Both XLSFormParser and XLSFormToTSVConverter accept an optional config object:

const tsv = await XLSFormParser.convertXLSFileToTSV('survey.xlsx', {
  handleRepeats: 'error',
  debugLogging: true,
  convertWelcomeNote: false,
  defaults: { language: 'de', surveyTitle: 'My Survey' },
});
Option Type Default Description
convertWelcomeNote boolean true Promote a note named welcome to LimeSurvey's survey welcome text.
convertEndNote boolean true Promote a note named end to LimeSurvey's survey end text.
convertOtherPattern boolean true Auto-detect the _other question pattern and set other=Y.
convertMarkdown boolean true Parse labels/hints as Markdown and convert to HTML.
hideNoAnswer boolean true Hide the "no answer" option on non-mandatory questions.

Implemented features

  • Question Types and Choices (see src/processors/TypeMapper.ts for how this library maps XLSForm types to LimeSurvey types)

    • everything but the types specified in UNIMPLEMENTED_TYPES in src/xlsformConverter.ts
    • record types ❌ (start, end, today, device_id, username, phonenumber, email)

  • "Other" Option Handling ✅

    • Explicit or_other modifier: Add or_other to question type (e.g., select_one colors or_other) to enable the "other" option
    • Automatic pattern detection: The converter automatically detects when you have:
      • A main question (single or multiple choice)
      • A follow-up question with the same name + _other suffix
      • The follow-up question has relevance targeting the "other" option of the main question
      • When this pattern is detected, the "other" choice is removed from the choices list and other=Y is set on the main question
    • Example pattern: 
      # Main question
type: select_one colors
name: favorite_color
label: What is your favorite color?

# Choices (including "other")
list_name: colors
name: red, label: Red
name: blue, label: Blue
name: other, label: Other

# Follow-up question for "other" specification
type: text
name: favorite_color_other  # Same name + "_other" suffix
label: Please specify your favorite color
relevant: ${favorite_color} = 'other'  # Targets the "other" option
    • Result: The "other" choice is automatically removed and other=Y is set on the main question

  • Settings sheet

    • -> LS Survey Global Parameters (only name of survey) ✅
    • -> Survey Language-Specific Parameters (default language is first row, other rows are extracted from label translations) ✅

  • Question Groups ✅

    • Group level relevance ✅
    • Nested groups: LimeSurvey does not support nested groups. Parent-only groups (groups that contain only child groups and no direct questions) are automatically flattened — their label is converted to a note question (type X) in the first child group.

  • Hints (normal) ✅

  • label and hint translations ✅

  • XPath -> ExpressionScript/EM 🟡

    • see src/converters/xpathTranspiler.ts for how operators and functions are mapped
    • its a complex task to ensure the transpiler covers everything and we currently cannot guarantee error free/complete transpiling

  • constraint_message ❌

  • XLSForms Calculation ✅ (calculate type → LimeSurvey Equation question *; ${var} references in labels/hints converted to EM {var} syntax)

  • XLSForms Trigger ❌

  • Repeats ❌

  • LimeSurvey Assessments ❌

  • LimeSurvey Quotas ❌

  • LimeSurvey Quota language settings ❌

  • LimeSurvey Quota members ❌

  • XLSForms Appearances 🟡

    • multiline on text questions → LimeSurvey type T (Long free text) ✅
    • likert on select_one → kept as L (no LimeSurvey visual equivalent) ✅
    • label/list-nolabel → LimeSurvey matrix question type F ✅
    • field-list on groups → each group becomes a separate page when style=pages is set (format=G); silently ignored otherwise ✅
    • Other appearances (e.g. minimal, compact, horizontal) trigger a warning and are ignored

  • Additional columns ❌

  • guidance_hint ❌

Transformation defaults and limitations

XLSForm and LimeSurvey differ in how they model surveys. Some information is lost or transformed during conversion, and some defaults are applied:

  • Survey format: The output defaults to "All in one" mode (format=A), displaying all groups and questions on a single page. If the settings sheet has style=pages, the format is set to G (group by group), so each group with appearance=field-list becomes a separate page — matching XLSForm's multi-page behaviour.

  • Nested groups: LimeSurvey does not support nested groups. Parent-only groups (containing only child groups, no direct questions) are flattened — their label becomes a note question (type X) in the first child group.

  • Field name sanitization: LimeSurvey only allows alphanumeric question codes (max 20 characters) and answer codes (max 5 characters). Underscores and hyphens are stripped, then names are truncated to fit. If two fields end up with the same sanitized name, a numeric suffix is appended to the later one (e.g. fieldname1). Recommendation: to avoid renaming, use short IDs (≤ 20 chars for questions, ≤ 5 chars for choices) without underscores or hyphens — these will pass through unchanged.

  • Record/metadata types: XLSForm start, end, today, deviceid etc. are silently skipped — LimeSurvey handles these internally.

  • Reserved note names — welcome and end: A note question with name=welcome is promoted to the LimeSurvey survey welcome text (surveyls_welcometext) instead of appearing as a question. A note with name=end is promoted to the end text (surveyls_endtext). Both support multilingual labels. If either note is the sole content of a group, that wrapping group is silently suppressed (no group row is emitted). If the group also contains other questions, it is kept and the note is still promoted.

  • Appearances: Most XLSForm appearance values have no LimeSurvey equivalent and are ignored (a warning is logged). Supported appearances: multiline on text questions maps to type T (Long free text); likert on select_one is accepted silently (stays type L); label/list-nolabel is converted to LimeSurvey's matrix question type (F); field-list on groups is silently ignored in format=A mode, or becomes a page boundary in format=G mode (when style=pages is set).

  • Multilingual row ordering: Rows are grouped by language within each group (all base-language rows first, then translations) to work around a LimeSurvey TSV importer bug that resets question ordering counters on translation rows.

  • Lime survey soft mandatory doesnt work only mandatory or not

Development Setup

Prerequisites

  • see package.json
  • Docker and Docker Compose (for integration testing)
  • Python 3.9+ with uv package manager (for integration testing)

Initial Setup

# Clone repository
git clone https://github.com/CorrelAid/xlsform2lstsv.git
cd xlsform2lstsv

# Install Node.js dependencies
npm install

# Install Git hooks (automatic on npm install)
npx husky install

# Build the project
npm run build

Development Tools

  • TypeScript: Primary language
  • Vitest: Unit testing framework
  • ESLint: Code linting
  • Prettier: Code formatting
  • Husky: Git hooks management
  • Commitlint: Commit message validation

Development Workflow

Unit Testing

Running Tests:

# Run all unit tests
npm test

# Run tests with watch mode 
npm test -- --watch

# Run specific test file
npm test -- src/test/textTypes.test.ts

# Run tests with coverage report
npm test -- --coverage

# Debug specific test
npm test -- --debug src/test/numericTypes.test.ts

Integration Testing

Integration tests verify that generated TSV files can be successfully imported into LimeSurvey.

To test all versions specified in scripts/src/config/version.js:

npm run test-compatibility

To test specific versions, set the SPECIFIC_VERSIONS environment variable:

SPECIFIC_VERSIONS="6.16.4,6.17.0" npm run test-compatibility

To test with current specified version:

npm run test:integration

Commit Message Format

Follow Conventional Commits:

Releasing

Pushing a v* tag to GitHub triggers automatic npm publishing via GitHub Actions.

Steps

  1. Bump the version:

    npm version patch   # 0.1.0 → 0.1.1 (bug fixes)
npm version minor   # 0.1.0 → 0.2.0 (new features)
npm version major   # 0.1.0 → 1.0.0 (breaking changes)

    This updates package.json and package-lock.json, creates a commit, and creates a vX.Y.Z tag.

  2. Push the commit and tag:

    git push && git push origin vX.Y.Z

  3. GitHub Actions will build and publish the package to npm.

Requirements

  • NPM_TOKEN secret must be configured in the GitHub repository settings
  • Tags must follow the v* pattern (e.g., v0.2.0)

Limesurvey Resources

About

Converts xform to a .tsv that can be imported to LimeSurvey

Resources

Readme
MIT license
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages