Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: rename to rsbuild-plugin-tailwindcss #11

Merged
merged 1 commit into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# @rsbuild/plugin-tailwindcss
# rsbuild-plugin-tailwindcss

An Rsbuild plugin to integrate with [Tailwind CSS](https://tailwindcss.com/) V3.

<p>
<a href="https://npmjs.com/package/@rsbuild/plugin-tailwindcss">
<img src="https://img.shields.io/npm/v/@rsbuild/plugin-tailwindcss?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
<a href="https://npmjs.com/package/rsbuild-plugin-tailwindcss">
<img src="https://img.shields.io/npm/v/rsbuild-plugin-tailwindcss?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
</a>
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
<a href="https://npmcharts.com/compare/@rsbuild/plugin-tailwindcss?minimal=true"><img src="https://img.shields.io/npm/dm/@rsbuild/plugin-tailwindcss.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
<a href="https://npmcharts.com/compare/rsbuild-plugin-tailwindcss?minimal=true"><img src="https://img.shields.io/npm/dm/rsbuild-plugin-tailwindcss.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
</p>

## Usage

Install:

```bash
npm add @rsbuild/plugin-tailwindcss -D
npm add rsbuild-plugin-tailwindcss -D
```

Add plugin to your `rsbuild.config.ts`:

```ts
// rsbuild.config.ts
import { pluginTailwindCSS } from "@rsbuild/plugin-tailwindcss";
import { pluginTailwindCSS } from "rsbuild-plugin-tailwindcss";

export default {
plugins: [pluginTailwindCSS()],
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@rsbuild/plugin-tailwindcss",
"name": "rsbuild-plugin-tailwindcss",
"version": "0.0.0",
"repository": "https://github.com/rspack-contrib/rsbuild-plugin-tailwindcss",
"license": "MIT",
Expand Down Expand Up @@ -40,7 +40,7 @@
"typescript": "^5.6.3"
},
"peerDependencies": {
"@rsbuild/core": "1.x",
"@rsbuild/core": "^1.1.0",
"tailwindcss": "^3"
},
"peerDependenciesMeta": {
Expand Down
6 changes: 3 additions & 3 deletions src/TailwindCSSRspackPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ interface TailwindRspackPluginOptions {
* import path from 'node:path'
* import { fileURLToPath } from 'node:url'
*
* import { TailwindRspackPlugin } from '@rsbuild/plugin-tailwindcss'
* import { TailwindRspackPlugin } from 'rsbuild-plugin-tailwindcss'
*
* const __dirname = path.dirname(fileURLToPath(import.meta.url))
*
Expand All @@ -43,7 +43,7 @@ interface TailwindRspackPluginOptions {
*
* ```js
* // rspack.config.js
* import { TailwindRspackPlugin } from '@rsbuild/plugin-tailwindcss'
* import { TailwindRspackPlugin } from 'rsbuild-plugin-tailwindcss'
*
* export default {
* plugins: [
Expand All @@ -65,7 +65,7 @@ interface TailwindRspackPluginOptions {
*
* ```js
* // rspack.config.js
* import { TailwindRspackPlugin } from '@rsbuild/plugin-tailwindcss'
* import { TailwindRspackPlugin } from 'rsbuild-plugin-tailwindcss'
*
* export default {
* plugins: [
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export type PluginTailwindCSSOptions = {
* import path from 'node:path'
* import { fileURLToPath } from 'node:url'
*
* import { pluginTailwindCSS } from '@rsbuild/plugin-tailwindcss'
* import { pluginTailwindCSS } from 'rsbuild-plugin-tailwindcss'
*
* const __dirname = path.dirname(fileURLToPath(import.meta.url))
*
Expand Down