cleanwind 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +46 -12
  2. package/dist/index.js +1 -1
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -14,25 +14,59 @@ pnpm add -D cleanwind
14
14
 
15
15
  ## Usage
16
16
 
17
+ For a local project install, run cleanwind through your package manager:
18
+
17
19
  ```sh
20
+ npx cleanwind check
21
+ npx cleanwind fix
22
+ npx cleanwind fix --staged
23
+ ```
24
+
25
+ Or with npm/pnpm/yarn/bun:
26
+
27
+ ```sh
28
+ npm exec cleanwind check
18
29
  pnpm cleanwind check
19
- pnpm cleanwind fix
20
- pnpm cleanwind fix --staged
30
+ yarn cleanwind check
31
+ bunx cleanwind check
32
+ ```
33
+
34
+ You can also add scripts to your project:
35
+
36
+ ```json
37
+ {
38
+ "scripts": {
39
+ "cleanwind:check": "cleanwind check",
40
+ "cleanwind:fix": "cleanwind fix",
41
+ "cleanwind:staged": "cleanwind fix --staged"
42
+ }
43
+ }
44
+ ```
45
+
46
+ Then run:
47
+
48
+ ```sh
49
+ npm run cleanwind:check
50
+ npm run cleanwind:fix
21
51
  ```
22
52
 
23
53
  ## CLI
24
54
 
55
+ When installed locally, use `npx cleanwind`, `npm exec cleanwind`, or a package
56
+ script. The bare `cleanwind` command is available inside package scripts or
57
+ after a global install.
58
+
25
59
  ```sh
26
- cleanwind check
27
- cleanwind check --cwd ./apps/web
28
- cleanwind check --config ./cleanwind.config.ts
29
- cleanwind check --write
30
- cleanwind check --verbose
31
-
32
- cleanwind fix
33
- cleanwind fix --staged
34
- cleanwind fix --check
35
- cleanwind fix --cwd ./apps/web --verbose
60
+ npx cleanwind check
61
+ npx cleanwind check --cwd ./apps/web
62
+ npx cleanwind check --config ./cleanwind.config.ts
63
+ npx cleanwind check --write
64
+ npx cleanwind check --verbose
65
+
66
+ npx cleanwind fix
67
+ npx cleanwind fix --staged
68
+ npx cleanwind fix --check
69
+ npx cleanwind fix --cwd ./apps/web --verbose
36
70
  ```
37
71
 
38
72
  ## Package
package/dist/index.js CHANGED
@@ -629,7 +629,7 @@ function runCleaner(cleaner, mode, context) {
629
629
 
630
630
  // src/index.ts
631
631
  var program = new Command();
632
- program.name("cleanwind").description("Clean imports and Tailwind CSS class names.").version("0.1.2");
632
+ program.name("cleanwind").description("Clean imports and Tailwind CSS class names.").version("0.1.3");
633
633
  program.command("check").description("Check files without writing changes.").option("--cwd <path>", "Working directory").option("--config <path>", "Path to cleanwind config").option("--write", "Write fixes while running check").option("--check", "Force check mode", true).option("--verbose", "Print detailed diagnostics").action(async (options) => {
634
634
  const runOptions = toRunOptions(options);
635
635
  if (options.write) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "cleanwind",
3
- "version": "0.1.2",
3
+ "version": "0.1.3",
4
4
  "description": "Clean imports and Tailwind CSS class names from the command line.",
5
5
  "type": "module",
6
6
  "license": "MIT",