@weapp-core/init 6.0.0 → 6.0.1

package/README.md

@@ -0,0 +1,39 @@
+# @weapp-core/init
+
+## 简介
+
+`@weapp-core/init` 用于初始化 weapp-vite 项目的基础配置文件，包含 `project.config`、`package.json`、`.gitignore`，并在需要时生成 `vite.config` 与 TypeScript 相关文件。
+
+## 特性
+
+- 初始化/更新小程序项目配置
+- 自动写入 `package.json` 与 `.gitignore`
+- 可根据命令类型生成 `vite.config` 与 `tsconfig` 系列文件
+
+## 安装
+
+```bash
+pnpm add @weapp-core/init
+```
+
+## 使用
+
+```ts
+import { initConfig } from '@weapp-core/init'
+
+await initConfig({
+  root: process.cwd(),
+  command: 'weapp-vite',
+})
+```
+
+## 配置
+
+`initConfig(options)` 选项：
+
+- `root`：项目根目录（默认 `process.cwd()`）
+- `command`：当为 `weapp-vite` 时会额外生成 `vite.config` 与 TS 配置文件
+
+## 相关链接
+
+- 仓库：https://github.com/weapp-vite/weapp-vite

package/dist/index.d.ts

@@ -1,22 +1,37 @@
 import { PackageJson, TSConfig } from 'pkg-types';
 import { set } from '@weapp-core/shared';
 
+/**
+ * @description set-value 的写入方法签名
+ */
 interface SetMethod {
     (path: set.InputType, value: any, options?: set.Options): void;
 }
+/**
+ * @description 共享更新参数
+ */
 interface SharedUpdateOptions {
     root: string;
     dest?: string;
     write?: boolean;
     cb?: (set: SetMethod) => void;
 }
+/**
+ * @description project.config 更新参数
+ */
 interface UpdateProjectConfigOptions extends SharedUpdateOptions {
     filename?: string;
 }
+/**
+ * @description package.json 更新参数
+ */
 interface UpdatePackageJsonOptions extends SharedUpdateOptions {
     command?: 'weapp-vite';
     filename?: string;
 }
+/**
+ * @description project.config.json 的核心字段类型
+ */
 interface ProjectConfig {
     miniprogramRoot?: string;
     srcMiniprogramRoot?: string;
@@ -29,11 +44,17 @@ interface ProjectConfig {
     };
 }
 
+/**
+ * @description init 过程中单个文件的上下文结构
+ */
 interface ContextDocument<T> {
     name: string;
     path: string;
     value: T | null;
 }
+/**
+ * @description init 过程的上下文容器
+ */
 interface Context {
     projectConfig: ContextDocument<ProjectConfig>;
     packageJson: ContextDocument<PackageJson>;
@@ -110,12 +131,24 @@ declare function initTsJsonFiles(options: SharedUpdateOptions): Promise<{
     };
 }>;
 
+/**
+ * @description 创建或更新 package.json
+ */
 declare function createOrUpdatePackageJson(options: UpdatePackageJsonOptions): Promise<PackageJson>;
 
+/**
+ * @description 创建或更新 project.config.json
+ */
 declare function createOrUpdateProjectConfig(options: UpdateProjectConfigOptions): Promise<ProjectConfig>;
 
+/**
+ * @description 重置全局上下文
+ */
 declare function resetContext(): void;
 
+/**
+ * @description 初始化项目配置（project.config、package.json、tsconfig、vite.config 等）
+ */
 declare function initConfig(options: {
     root?: string;
     command?: 'weapp-vite';

package/dist/index.js

@@ -716,7 +716,7 @@ import logger2 from "@weapp-core/logger";
 import { defu, get, set } from "@weapp-core/shared";
 
 // ../../packages/weapp-vite/package.json
-var version = "6.2.0";
+var version = "6.5.1";
 
 // src/npm.ts
 import https from "https";
@@ -974,6 +974,7 @@ yarn-error.log*
 dist
 dist-plugin
 dist-web
+dist/web
 vite.config.ts.timestamp-*.mjs`;
 function normalizeLineEndings(value) {
   return value.replace(/\r\n/g, "\n");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@weapp-core/init",
   "type": "module",
-  "version": "6.0.0",
+  "version": "6.0.1",
   "description": "@weapp-core/init",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -40,8 +40,8 @@
   },
   "dependencies": {
     "fs-extra": "^11.3.3",
-    "@weapp-core/logger": "^3.0.0",
-    "@weapp-core/shared": "^3.0.0"
+    "@weapp-core/logger": "^3.0.3",
+    "@weapp-core/shared": "^3.0.1"
   },
   "scripts": {
     "dev": "tsup --watch --sourcemap",