🌐 Language

# prettier-plugin-classnames A Prettier plugin that wraps verbose class name based on the `printWidth` option. ![A use case for this plugin.](.github/banner.png) ## Installation[^1] ```sh npm install -D prettier prettier-plugin-classnames ``` [^1]: If your version of `prettier-plugin-classnames` is less than `0.4.0`, you will also need to install `@prettier/sync`. ## Configuration JSON example: ```json { "plugins": ["prettier-plugin-classnames"] } ``` JS example (CommonJS module): ```javascript module.exports = { plugins: ['prettier-plugin-classnames'], customAttributes: ['myClassProp'], customFunctions: ['clsx'], }; ``` JS example (ES module): ```javascript export default { plugins: ['prettier-plugin-classnames'], endingPosition: 'absolute', }; ``` ### Markdown/MDX Override This plugin does not support Markdown and MDX, but if this plugin supports a language inside code blocks (e.g. Vue), unintended formatting may occur inside the code blocks. To prevent unintended formatting, you can use configuration overrides for Markdown and MDX. JSON example: ```json { "plugins": ["prettier-plugin-classnames"], "customFunctions": ["clsx"], "overrides": [ { "files": ["*.md", "*.mdx"], "options": { "plugins": [] } } ] } ``` ## Options ### Custom Attributes List of attributes that enclosing class names.
The `class` and `className` attributes are always supported, even if no options are specified. Default | CLI Override | API Override --- | --- | --- `[]` | `--custom-attributes ` | `customAttributes: [""]` ### Custom Functions List of functions that enclosing class names.
The `classNames` function is always supported, even if no options are specified. Default | CLI Override | API Override --- | --- | --- `[]` | `--custom-functions ` | `customFunctions: [""]` ### Ending Position First available in v0.5.0.
`absolute-with-indent` was added in v0.6.0.
`absolute-with-indent` was removed in v0.8.0, but you can get the same output with `absolute`.
Default value changed from `relative` to `absolute` in v0.8.0. This is the criterion for ending the class name on each line when replacing the original class name with a multi-line class name. - `absolute` example: ``` ------------------------------------------------------------| printWidth=60 export function Callout({ children }) { return (

{children}

); } ``` - `relative` example: ``` ------------------------------------------------------------| printWidth=60 export function Callout({ children }) { return (

{children}

); } ``` Default | CLI Override | API Override --- | --- | --- `"absolute"` | `--ending-position ` | `endingPosition: ""` ### Syntax Transformation First available in v0.7.7. If a line wrapping occurs in a class name written in non-expression syntax, it is transformed into expression syntax. This transformation does not support reversible formatting. Default | CLI Override | API Override --- | --- | --- `false` | `--syntax-transformation` | `syntaxTransformation: ` ### Classnames Print Width First available in v0.10.0. Specify the print width of the class name. If no value is provided, the `printWidth` value is used as default. Default | CLI Override | API Override --- | --- | --- `undefined` | `--classnames-print-width ` | `classnamesPrintWidth: ` ## Version correlation with sibling plugins Starting with `0.6.0`, when there is a minor release on one side, I plan to reflect that change on the other side as well if possible. ![Version correlation.](.github/correlation.png) ## Compatibility with other Prettier plugins If more than one Prettier plugin can handle the text you want to format, Prettier will only use the last of those plugins. In this case, you can configure it as follows by adding [prettier-plugin-merge](https://github.com/ony3000/prettier-plugin-merge) to apply those plugins sequentially. JSON example: ```json { "plugins": [ "prettier-plugin-tailwindcss", "prettier-plugin-classnames", "prettier-plugin-merge" ] } ``` ## Stargazers over time [![Stargazers over time](https://starchart.cc/ony3000/prettier-plugin-classnames.svg?variant=adaptive)](https://starchart.cc/ony3000/prettier-plugin-classnames)