@weapp-tailwindcss/init 1.0.16 → 2.0.1

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.
package/README.md CHANGED
@@ -2,7 +2,11 @@
2
2
 
3
3
  > English | [简体中文](./README.zh-CN.md)
4
4
 
5
- This package initializes weapp-tailwindcss related project configuration, including Tailwind, PostCSS, dependency versions, and required setup files.
5
+ This package initializes `weapp-tailwindcss` project configuration.
6
+
7
+ The default mode targets Tailwind CSS 4 and `weapp-tailwindcss` 5: it updates `package.json` and creates the CSS-first `src/app.css` entry without writing `postcss.config.*`, `tailwind.config.*`, `@tailwindcss/postcss`, or `autoprefixer`.
8
+
9
+ Use `mode: 'legacy'` explicitly when maintaining a Tailwind 3 project that still needs the old PostCSS and Tailwind configuration files.
6
10
 
7
11
  ## Website
8
12
 
package/README.zh-CN.md CHANGED
@@ -2,7 +2,17 @@
2
2
 
3
3
  > [English](./README.md) | 简体中文
4
4
 
5
- 这个包负责初始化 weapp-tailwindcss 相关配置,会帮助项目写入 Tailwind、PostCSS 和依赖版本等接入所需文件。
5
+ 这个包负责初始化 `weapp-tailwindcss` 相关配置。
6
+
7
+ 默认模式面向 Tailwind CSS 4 / `weapp-tailwindcss` 5:只更新 `package.json` 并创建 CSS-first 入口 `src/app.css`,不会写入 `postcss.config.*`、`tailwind.config.*`,也不会添加 `@tailwindcss/postcss` 或 `autoprefixer`。
8
+
9
+ ```ts
10
+ import { init } from '@weapp-tailwindcss/init'
11
+
12
+ await init({ cwd: process.cwd() })
13
+ ```
14
+
15
+ 需要维护旧版 Tailwind 3 项目时,显式传入 `mode: 'legacy'`,初始化器才会生成旧式 PostCSS 与 Tailwind 配置。
6
16
 
7
17
  ## 官网
8
18
 
package/dist/index.cjs CHANGED
@@ -46,19 +46,24 @@ async function getLatestVersionInRange(packageName, versionRange, options) {
46
46
  }
47
47
  const defaultDevDeps = {
48
48
  "tailwindcss": "4",
49
+ "weapp-tailwindcss": "5"
50
+ };
51
+ const legacyDevDeps = {
52
+ "tailwindcss": "3",
49
53
  "postcss": "8",
50
54
  "autoprefixer": "10",
51
55
  "weapp-tailwindcss": "4"
52
56
  };
53
- async function getDevDepsVersions(options) {
54
- return Object.fromEntries(await Promise.all(Object.entries(defaultDevDeps).map(async (x) => {
57
+ async function getDevDepsVersions(options, mode = "v4") {
58
+ const deps = mode === "legacy" ? legacyDevDeps : defaultDevDeps;
59
+ return Object.fromEntries(await Promise.all(Object.entries(deps).map(async (x) => {
55
60
  return [x[0], `^${await getLatestVersionInRange(...x, options)}`];
56
61
  })));
57
62
  }
58
63
  //#endregion
59
64
  //#region src/index.ts
60
65
  async function createContext(options) {
61
- const { cwd, pkgJsonBasename, postcssConfigBasename, tailwindConfigBasename, fetchOptions } = options;
66
+ const { cwd, pkgJsonBasename, postcssConfigBasename, tailwindConfigBasename, cssEntryBasename, sourceGlob, mode, fetchOptions } = options;
62
67
  const pkgJsonPath = pathe.default.resolve(cwd, pkgJsonBasename);
63
68
  if (await fs_extra.default.exists(pkgJsonPath)) {
64
69
  const pkgJson = await fs_extra.default.readJson(pkgJsonPath);
@@ -66,19 +71,27 @@ async function createContext(options) {
66
71
  pkgJson,
67
72
  pkgJsonPath,
68
73
  cwd,
69
- versions: await getDevDepsVersions(fetchOptions),
74
+ versions: await getDevDepsVersions(fetchOptions, mode),
70
75
  postcssConfigBasename,
71
76
  tailwindConfigBasename,
77
+ cssEntryBasename,
78
+ sourceGlob,
79
+ mode,
72
80
  get type() {
73
81
  return pkgJson.type;
74
82
  }
75
83
  };
76
- } else _weapp_tailwindcss_logger.logger.warn("当前目录下不存在 `package.json` 文件,初始化脚本将被跳过,请执行 `npm init` 或手动创建 `package.json` 后重试 ");
84
+ } else _weapp_tailwindcss_logger.logger.warn("当前目录下不存在 `package.json` 文件,初始化脚本将被跳过,请执行 `pnpm init` 或手动创建 `package.json` 后重试 ");
77
85
  }
78
86
  async function updatePackageJson(ctx) {
79
87
  for (const [key, value] of Object.entries(ctx.versions)) (0, _weapp_tailwindcss_shared.setValue)(ctx.pkgJson, `devDependencies.${key}`, value);
80
88
  await fs_extra.default.writeJSON(ctx.pkgJsonPath, ctx.pkgJson, { spaces: 2 });
81
89
  }
90
+ async function writeIfMissing(file, data) {
91
+ if (await fs_extra.default.exists(file)) return false;
92
+ await fs_extra.default.outputFile(file, data);
93
+ return true;
94
+ }
82
95
  async function touchPostcssConfig(ctx) {
83
96
  const data = `${ctx.type === "module" ? "export default " : "module.exports = "}{
84
97
  plugins: {
@@ -88,7 +101,7 @@ async function touchPostcssConfig(ctx) {
88
101
  },
89
102
  }
90
103
  `;
91
- await fs_extra.default.writeFile(pathe.default.resolve(ctx.cwd, ctx.postcssConfigBasename), data);
104
+ return await writeIfMissing(pathe.default.resolve(ctx.cwd, ctx.postcssConfigBasename), data);
92
105
  }
93
106
  async function touchTailwindConfig(ctx) {
94
107
  const data = `/** @type {import('tailwindcss').Config} */
@@ -105,14 +118,23 @@ ${ctx.type === "module" ? "export default " : "module.exports = "}{
105
118
  },
106
119
  }
107
120
  `;
108
- await fs_extra.default.writeFile(pathe.default.resolve(ctx.cwd, ctx.tailwindConfigBasename), data);
121
+ return await writeIfMissing(pathe.default.resolve(ctx.cwd, ctx.tailwindConfigBasename), data);
122
+ }
123
+ async function touchCssEntry(ctx) {
124
+ const data = `@import "tailwindcss";
125
+ @source "${ctx.sourceGlob}";
126
+ `;
127
+ return await writeIfMissing(pathe.default.resolve(ctx.cwd, ctx.cssEntryBasename), data);
109
128
  }
110
129
  function getInitDefaults() {
111
130
  return {
112
131
  cwd: node_process.default.cwd(),
113
132
  postcssConfigBasename: "postcss.config.js",
114
133
  tailwindConfigBasename: "tailwind.config.js",
115
- pkgJsonBasename: "package.json"
134
+ cssEntryBasename: "src/app.css",
135
+ sourceGlob: "./**/*.{html,js,ts,jsx,tsx,vue,wxml}",
136
+ pkgJsonBasename: "package.json",
137
+ mode: "v4"
116
138
  };
117
139
  }
118
140
  async function init(options) {
@@ -120,17 +142,21 @@ async function init(options) {
120
142
  if (ctx) {
121
143
  await updatePackageJson(ctx);
122
144
  _weapp_tailwindcss_logger.logger.success("`package.json` 文件修改完成!");
123
- await touchPostcssConfig(ctx);
124
- _weapp_tailwindcss_logger.logger.success("`postcss.config.js` 文件创建完成!");
125
- await touchTailwindConfig(ctx);
126
- _weapp_tailwindcss_logger.logger.success("`tailwind.config.js` 文件创建完成!");
127
- _weapp_tailwindcss_logger.logger.success("`weapp-tailwindcss` 初始化完成!请根据你自定义的需求,更改对应的配置文件(比如 `tailwind.config.js` 中的 `content` 配置)");
145
+ if (ctx.mode === "legacy") {
146
+ if (await touchPostcssConfig(ctx)) _weapp_tailwindcss_logger.logger.success("`postcss.config.js` 文件创建完成!");
147
+ if (await touchTailwindConfig(ctx)) _weapp_tailwindcss_logger.logger.success("`tailwind.config.js` 文件创建完成!");
148
+ _weapp_tailwindcss_logger.logger.success("`weapp-tailwindcss` 旧版初始化完成!");
149
+ return;
150
+ }
151
+ if (await touchCssEntry(ctx)) _weapp_tailwindcss_logger.logger.success(`\`${ctx.cssEntryBasename}\` 文件创建完成!`);
152
+ _weapp_tailwindcss_logger.logger.success("`weapp-tailwindcss` v5 初始化完成!请将 WeappTailwindcss() 注册到项目构建器,并确认入口 CSS 被实际引入。");
128
153
  }
129
154
  }
130
155
  //#endregion
131
156
  exports.createContext = createContext;
132
157
  exports.getInitDefaults = getInitDefaults;
133
158
  exports.init = init;
159
+ exports.touchCssEntry = touchCssEntry;
134
160
  exports.touchPostcssConfig = touchPostcssConfig;
135
161
  exports.touchTailwindConfig = touchTailwindConfig;
136
162
  exports.updatePackageJson = updatePackageJson;
package/dist/index.d.ts CHANGED
@@ -1,7 +1,5 @@
1
1
  import { Options } from "npm-registry-fetch";
2
- //#region ../../node_modules/.pnpm/pkg-types@2.3.1/node_modules/pkg-types/dist/index.d.mts
3
- //#endregion
4
- //#region src/packagejson/types.d.ts
2
+ //#region ../../node_modules/.pnpm/pkg-types@2.3.3/node_modules/pkg-types/dist/index.d.mts
5
3
  interface PackageJson {
6
4
  /**
7
5
  * The name is what your thing is called.
@@ -299,20 +297,27 @@ type PackageJsonExports = string | PackageJsonExportsObject | Array<string | Pac
299
297
  //#endregion
300
298
  //#region src/npm.d.ts
301
299
  type FetchOptions = Options;
300
+ type InitMode = 'v4' | 'legacy';
302
301
  //#endregion
303
302
  //#region src/index.d.ts
304
- interface CreateContextOptions {
303
+ export interface CreateContextOptions {
305
304
  cwd: string;
306
305
  pkgJsonBasename?: string;
307
306
  postcssConfigBasename?: string;
308
307
  tailwindConfigBasename?: string;
308
+ cssEntryBasename?: string;
309
+ sourceGlob?: string;
310
+ mode?: InitMode;
309
311
  fetchOptions?: FetchOptions;
310
312
  }
311
- declare function createContext(options: Required<CreateContextOptions>): Promise<{
313
+ export declare function createContext(options: Required<CreateContextOptions>): Promise<{
312
314
  pkgJson: PackageJson;
313
315
  pkgJsonPath: string;
314
316
  cwd: string;
315
317
  versions: {
318
+ tailwindcss: string;
319
+ 'weapp-tailwindcss': string;
320
+ } | {
316
321
  tailwindcss: string;
317
322
  postcss: string;
318
323
  autoprefixer: string;
@@ -320,18 +325,24 @@ declare function createContext(options: Required<CreateContextOptions>): Promise
320
325
  };
321
326
  postcssConfigBasename: string;
322
327
  tailwindConfigBasename: string;
328
+ cssEntryBasename: string;
329
+ sourceGlob: string;
330
+ mode: InitMode;
323
331
  readonly type: "module" | "commonjs" | undefined;
324
332
  } | undefined>;
325
- type Context = Exclude<Awaited<ReturnType<typeof createContext>>, undefined>;
326
- declare function updatePackageJson(ctx: Context): Promise<void>;
327
- declare function touchPostcssConfig(ctx: Context): Promise<void>;
328
- declare function touchTailwindConfig(ctx: Context): Promise<void>;
329
- declare function getInitDefaults(): {
333
+ export type Context = Exclude<Awaited<ReturnType<typeof createContext>>, undefined>;
334
+ export declare function updatePackageJson(ctx: Context): Promise<void>;
335
+ export declare function touchPostcssConfig(ctx: Context): Promise<boolean>;
336
+ export declare function touchTailwindConfig(ctx: Context): Promise<boolean>;
337
+ export declare function touchCssEntry(ctx: Context): Promise<boolean>;
338
+ export declare function getInitDefaults(): {
330
339
  cwd: string;
331
340
  postcssConfigBasename: string;
332
341
  tailwindConfigBasename: string;
342
+ cssEntryBasename: string;
343
+ sourceGlob: string;
333
344
  pkgJsonBasename: string;
345
+ mode: InitMode;
334
346
  };
335
- declare function init(options?: CreateContextOptions): Promise<void>;
336
- //#endregion
337
- export { Context, CreateContextOptions, createContext, getInitDefaults, init, touchPostcssConfig, touchTailwindConfig, updatePackageJson };
347
+ export declare function init(options?: CreateContextOptions): Promise<void>;
348
+ //#endregion
package/dist/index.js CHANGED
@@ -20,19 +20,24 @@ async function getLatestVersionInRange(packageName, versionRange, options) {
20
20
  }
21
21
  const defaultDevDeps = {
22
22
  "tailwindcss": "4",
23
+ "weapp-tailwindcss": "5"
24
+ };
25
+ const legacyDevDeps = {
26
+ "tailwindcss": "3",
23
27
  "postcss": "8",
24
28
  "autoprefixer": "10",
25
29
  "weapp-tailwindcss": "4"
26
30
  };
27
- async function getDevDepsVersions(options) {
28
- return Object.fromEntries(await Promise.all(Object.entries(defaultDevDeps).map(async (x) => {
31
+ async function getDevDepsVersions(options, mode = "v4") {
32
+ const deps = mode === "legacy" ? legacyDevDeps : defaultDevDeps;
33
+ return Object.fromEntries(await Promise.all(Object.entries(deps).map(async (x) => {
29
34
  return [x[0], `^${await getLatestVersionInRange(...x, options)}`];
30
35
  })));
31
36
  }
32
37
  //#endregion
33
38
  //#region src/index.ts
34
39
  async function createContext(options) {
35
- const { cwd, pkgJsonBasename, postcssConfigBasename, tailwindConfigBasename, fetchOptions } = options;
40
+ const { cwd, pkgJsonBasename, postcssConfigBasename, tailwindConfigBasename, cssEntryBasename, sourceGlob, mode, fetchOptions } = options;
36
41
  const pkgJsonPath = path.resolve(cwd, pkgJsonBasename);
37
42
  if (await fs.exists(pkgJsonPath)) {
38
43
  const pkgJson = await fs.readJson(pkgJsonPath);
@@ -40,19 +45,27 @@ async function createContext(options) {
40
45
  pkgJson,
41
46
  pkgJsonPath,
42
47
  cwd,
43
- versions: await getDevDepsVersions(fetchOptions),
48
+ versions: await getDevDepsVersions(fetchOptions, mode),
44
49
  postcssConfigBasename,
45
50
  tailwindConfigBasename,
51
+ cssEntryBasename,
52
+ sourceGlob,
53
+ mode,
46
54
  get type() {
47
55
  return pkgJson.type;
48
56
  }
49
57
  };
50
- } else logger.warn("当前目录下不存在 `package.json` 文件,初始化脚本将被跳过,请执行 `npm init` 或手动创建 `package.json` 后重试 ");
58
+ } else logger.warn("当前目录下不存在 `package.json` 文件,初始化脚本将被跳过,请执行 `pnpm init` 或手动创建 `package.json` 后重试 ");
51
59
  }
52
60
  async function updatePackageJson(ctx) {
53
61
  for (const [key, value] of Object.entries(ctx.versions)) setValue(ctx.pkgJson, `devDependencies.${key}`, value);
54
62
  await fs.writeJSON(ctx.pkgJsonPath, ctx.pkgJson, { spaces: 2 });
55
63
  }
64
+ async function writeIfMissing(file, data) {
65
+ if (await fs.exists(file)) return false;
66
+ await fs.outputFile(file, data);
67
+ return true;
68
+ }
56
69
  async function touchPostcssConfig(ctx) {
57
70
  const data = `${ctx.type === "module" ? "export default " : "module.exports = "}{
58
71
  plugins: {
@@ -62,7 +75,7 @@ async function touchPostcssConfig(ctx) {
62
75
  },
63
76
  }
64
77
  `;
65
- await fs.writeFile(path.resolve(ctx.cwd, ctx.postcssConfigBasename), data);
78
+ return await writeIfMissing(path.resolve(ctx.cwd, ctx.postcssConfigBasename), data);
66
79
  }
67
80
  async function touchTailwindConfig(ctx) {
68
81
  const data = `/** @type {import('tailwindcss').Config} */
@@ -79,14 +92,23 @@ ${ctx.type === "module" ? "export default " : "module.exports = "}{
79
92
  },
80
93
  }
81
94
  `;
82
- await fs.writeFile(path.resolve(ctx.cwd, ctx.tailwindConfigBasename), data);
95
+ return await writeIfMissing(path.resolve(ctx.cwd, ctx.tailwindConfigBasename), data);
96
+ }
97
+ async function touchCssEntry(ctx) {
98
+ const data = `@import "tailwindcss";
99
+ @source "${ctx.sourceGlob}";
100
+ `;
101
+ return await writeIfMissing(path.resolve(ctx.cwd, ctx.cssEntryBasename), data);
83
102
  }
84
103
  function getInitDefaults() {
85
104
  return {
86
105
  cwd: process.cwd(),
87
106
  postcssConfigBasename: "postcss.config.js",
88
107
  tailwindConfigBasename: "tailwind.config.js",
89
- pkgJsonBasename: "package.json"
108
+ cssEntryBasename: "src/app.css",
109
+ sourceGlob: "./**/*.{html,js,ts,jsx,tsx,vue,wxml}",
110
+ pkgJsonBasename: "package.json",
111
+ mode: "v4"
90
112
  };
91
113
  }
92
114
  async function init(options) {
@@ -94,12 +116,15 @@ async function init(options) {
94
116
  if (ctx) {
95
117
  await updatePackageJson(ctx);
96
118
  logger.success("`package.json` 文件修改完成!");
97
- await touchPostcssConfig(ctx);
98
- logger.success("`postcss.config.js` 文件创建完成!");
99
- await touchTailwindConfig(ctx);
100
- logger.success("`tailwind.config.js` 文件创建完成!");
101
- logger.success("`weapp-tailwindcss` 初始化完成!请根据你自定义的需求,更改对应的配置文件(比如 `tailwind.config.js` 中的 `content` 配置)");
119
+ if (ctx.mode === "legacy") {
120
+ if (await touchPostcssConfig(ctx)) logger.success("`postcss.config.js` 文件创建完成!");
121
+ if (await touchTailwindConfig(ctx)) logger.success("`tailwind.config.js` 文件创建完成!");
122
+ logger.success("`weapp-tailwindcss` 旧版初始化完成!");
123
+ return;
124
+ }
125
+ if (await touchCssEntry(ctx)) logger.success(`\`${ctx.cssEntryBasename}\` 文件创建完成!`);
126
+ logger.success("`weapp-tailwindcss` v5 初始化完成!请将 WeappTailwindcss() 注册到项目构建器,并确认入口 CSS 被实际引入。");
102
127
  }
103
128
  }
104
129
  //#endregion
105
- export { createContext, getInitDefaults, init, touchPostcssConfig, touchTailwindConfig, updatePackageJson };
130
+ export { createContext, getInitDefaults, init, touchCssEntry, touchPostcssConfig, touchTailwindConfig, updatePackageJson };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@weapp-tailwindcss/init",
3
3
  "type": "module",
4
- "version": "1.0.16",
4
+ "version": "2.0.1",
5
5
  "description": "Project initializer for cross-platform Tailwind CSS with weapp-tailwindcss. 用于初始化跨端 Tailwind CSS 项目的 weapp-tailwindcss 工具。",
6
6
  "author": "ice breaker <1324318532@qq.com>",
7
7
  "license": "MIT",
@@ -35,7 +35,7 @@
35
35
  "dependencies": {
36
36
  "@weapp-tailwindcss/logger": "2.0.3",
37
37
  "@weapp-tailwindcss/shared": "2.0.3",
38
- "fs-extra": "^11.4.0",
38
+ "fs-extra": "^11.4.1",
39
39
  "npm-registry-fetch": "^20.0.1",
40
40
  "pathe": "^2.0.3"
41
41
  },