https://github.com/jacobbogers/rollup-plugin-jsx-remove-attributes

rollup & vite plugin to remove jsx attributes
https://github.com/jacobbogers/rollup-plugin-jsx-remove-attributes

Last synced: about 1 month ago
JSON representation

rollup & vite plugin to remove jsx attributes

• Host: GitHub
• URL: https://github.com/jacobbogers/rollup-plugin-jsx-remove-attributes
• Owner: jacobbogers
• License: mit
• Created: 2023-03-18T11:29:21.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-05T19:53:59.000Z (2 months ago)
• Last Synced: 2024-04-14T07:19:31.009Z (2 months ago)
• Language: TypeScript
• Size: 57.6 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Lists

• awesome-vite - vite-jsx-remove-attributes - Remove the `data-testid` (configurable) from production builds. (Get Started / Templates)

README

        
# rollup-plugin-jsx-remove-attributes

rollup & vite plugin to remove jsx attributes

This plugin can be used in vite or rollup.

The initial motivation was to remove `data-testid` attributes from jsx (react, etc) components.

It can be generally used to remove any attribute.

The plugin only runs when `NODE_ENV` is equal to `production`.

## Installation

```bash

npm i -D rollup-plugin-jsx-remove-attributes

```

## Usage with Vite

Example:

```typescript

import { defineConfig } from 'vite';

import react from '@vitejs/plugin-react';

import removeTestIdAttribute from 'rollup-plugin-jsx-remove-attributes';

export default defineConfig({

    build: { sourcemap: true },

    plugins: [

        react(),

        removeTestIdAttribute({

             include: [/\.[tj]sx$/], //default

             exclude: ['**/node_modules/**'], // default

             attributes: ['data-testid'],  // remove test attributes from jsx

             usage: 'vite'  // Must specify 'vite'

        }),

        // other plugins

     ]

});

```

## Usage with Rollup

Example:

```typescript

import { rollup } from 'rollup';

import removeTestIdAttribute from 'rollup-plugin-jsx-remove-attributes';

// see below for details on these options

const inputOptions = {

    ...

    plugins:[

      removeTestIdAttribute({

             include: [/\.[tj]sx$/], //default

             exclude: ['**/node_modules/**'], // default

             attributes: ['data-testid'],  // remove test attributes from jsx

             usage: 'rollup'  // must specify rollup

        }),

    ]

};

const outputOptions = {...};

const bundle = await rollup.build(inputOptions);

await rollup.write(outputOptions);

```

## Options Object

-   `usage`: possible values are `vite` or `rollup`

-   `include`: will allow anything that matches the array of glob/regexp pattern, default`[/\.[tj]sx$/]`

-   `exclude`: will exclude anything matching the array of glob/regexp patterns, default `['**/node_modules/**']`

-   `attributes`: array of jsx attributes to be stripped if found, example `data-testid`