jsx-add-data-test-id v1.0.12

Add data-testid attribute to your JSX elements

Your JSX after processing

import React, {Fragment} from "react";

const X = ({x, children}) => <div data-testid="iFg6lbU1">Hello {x} and {children}</div>;

export const A = ({a}) => {
    return (
        <Fragment data-testid="S77PPbTM">
            <X x="x" data-testid="wpKMLXrM" />
            <X x="x" data-testid="kQXys89s">z</X>
            <X
                x="x"
                wow={<div data-testid="gQdhqdQZ">wow</div>}
                data-testid="evg2cFxK"
            />
            <X
                x="x"
                wow={() => <div data-testid="jx8IjU65">wow</div>}
                data-testid="7P78ztIK"
            >
                z
            </X>
        </Fragment>
    );
};

You can hide attribute values using Inline Fold extension for Visual Studio Code with a configuration like this

{
    "inlineFold.regex": "(data-testid=\"[0-9A-Za-z]*\")",
    "inlineFold.regexFlags": "g",
    "inlineFold.regexGroup": 1,
    "inlineFold.maskChar": "data-testid",
    "inlineFold.maskColor": "#A0A0A0",
    "inlineFold.unfoldOnLineSelect": false
}

Your JSX in Visual Studio Code editor after hiding

import React, {Fragment} from "react";

const X = ({x, children}) => <div data-testid>Hello {x} and {children}</div>;

export const A = ({a}) => {
    return (
        <Fragment data-testid>
            <X x="x" data-testid />
            <X x="x" data-testid>z</X>
            <X
                x="x"
                wow={<div data-testid>wow</div>}
                data-testid
            />
            <X
                x="x"
                wow={() => <div data-testid>wow</div>}
                data-testid
            >
                z
            </X>
        </Fragment>
    );
};

Installation

npm i -D jsx-add-data-test-id

Usage

With options

npx jsx-add-data-test-id -i src/js -e src/js/icons -n data-testid

With config file

npx jsx-add-data-test-id -c .jsx-add-data-test-id-config.json

Options:

• c, config - default - .jsx-add-data-test-id-config.json
• i, include-dirs - for example src/js
• f, include-files - for example test/script.js
• e, exclude-dirs - for example src/js/icons
• n, id-name - default - data-testid
• extensions - js
• indentation - tab or number of spaces, default - tab
• quotes - double or single, default - double
• cache - default - .jsx-add-data-test-id-cache.json
• disable-cache - disable cache
• allow-duplicates - allow duplicate attribute values
• disable-modification - prohibit file modification
• disable-insertion - prohibit attribute insertion (only empty attributes will be updated)
• id-generator - nanoid or uuid4, default - nanoid
• include-elements - only specified elements will be processed instead of all
• exclude-elements - exclude specified elements from processing, default - Fragment
• expected-attributes - only elements with specified attributes will be processed instead of all (for example, you can specify onChange and onClick)
• always-update-empty-attributes - include-elements, exclude-elements, and expected-attributes options will have no effect on empty attributes

JSON config file example

{
    "includeDirs": ["src/js"],
    "includeFiles": [],
    "excludeDirs": ["src/js/icons"],
    "idName": "data-testid",
    "extensions": ["js"],
    "indentation": "tab",
    "quotes": "double",
    "cache": ".jsx-add-data-test-id-cache.json",
    "disableCache": false,
    "allowDuplicates": false,
    "disableModification": false,
    "disableInsertion": false,
    "idGenerator": "nanoid",
    "includeElements": [],
    "excludeElements": ["Fragment"],
    "expectedAttributes": [],
    "alwaysUpdateEmptyAttributes": false
}

JS config file example

module.exports = {
    includeDirs: ["src/js"],
    includeFiles: [],
    excludeDirs: ["src/js/icons"],
    idName: "data-testid",
    extensions: ["js"],
    indentation: "tab",
    quotes: "double",
    cache: ".jsx-add-data-test-id-cache.json",
    disableCache: false,
    allowDuplicates: false,
    disableModification: false,
    disableInsertion: false,
    idGenerator: "nanoid",
    includeElements: [],
    excludeElements: ["Fragment"],
    expectedAttributes: [],
    alwaysUpdateEmptyAttributes: false
};

Pipeline:

• user writes code
• user executes jsx-add-data-test-id
• user clears duplicates if required and executes jsx-add-data-test-id again
• user makes commit

Alternative pipeline:

• user writes code
• user executes jsx-add-data-test-id with disable-modification option
• user clears duplicates if required and executes jsx-add-data-test-id again
• user makes commit
• CI tool executes jsx-add-data-test-id without disable-modification option and makes commit