Back to Repositories

Testing JSON Code Highlight Generation in Parcel Bundler

This test suite validates the JSON code highlighting functionality in Parcel’s diagnostic system, focusing on proper generation of code highlights for JSON strings with associated messages and positions.

Test Coverage Overview

The test suite provides comprehensive coverage of the generateJSONCodeHighlights function, verifying its ability to process JSON strings and generate appropriate highlight positions.

Tests escaped string generation with multiple highlight types
Validates correct line and column position calculations
Covers key, value, and combined highlight scenarios

Implementation Analysis

The testing approach utilizes Jest’s describe/it structure combined with Node’s assert module for verification. The implementation focuses on precise position tracking and message association for JSON elements.

Uses strict-local Flow type checking
Implements deep equality assertions for position validation
Structures tests around JSON string processing

Technical Details

Testing Framework: Jest
Assertion Library: Node.js assert module
Type System: Flow strict-local
Test Structure: Describe/It blocks
Validation Method: deepEqual assertions

Best Practices Demonstrated

The test suite exemplifies clean testing practices with clear arrangement of test cases and explicit expected outcomes. It demonstrates proper isolation of test cases and thorough validation of component functionality.

Clear test case organization
Explicit input/output validation
Comprehensive position checking
Type-safe testing approach

parcel-bundler/parcel

packages/core/diagnostic/test/JSONCodeHighlights.test.js

            
// @flow strict-local
import assert from 'assert';

import {generateJSONCodeHighlights} from '../src/diagnostic';

describe('generateJSONCodeHighlights', () => {
  it('returns an escaped string 01', () => {
    let result = generateJSONCodeHighlights(
      `{
  "a": 1
}`,
      [
        {key: '/a', type: 'key', message: 'foo1'},
        {key: '/a', type: 'value', message: 'foo2'},
        {key: '/a', message: 'foo3'},
      ],
    );
    assert.deepEqual(result, [
      {
        start: {line: 2, column: 3},
        end: {line: 2, column: 5},
        message: 'foo1',
      },
      {
        start: {line: 2, column: 8},
        end: {line: 2, column: 8},
        message: 'foo2',
      },
      {
        start: {line: 2, column: 3},
        end: {line: 2, column: 8},
        message: 'foo3',
      },
    ]);
  });
});