From 8c7b59e1e6fb261aff08ec2762ca81c06f0e3130 Mon Sep 17 00:00:00 2001 From: yutent Date: Thu, 17 Feb 2022 13:17:47 +0800 Subject: [PATCH] update readme --- CHANGELOG.md | 3 +++ README.md | 24 ++++++++++++++++++++++++ package.json | 8 ++++---- 3 files changed, 31 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6fe0812..68f1efe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,5 @@ # 更新日志(Changed Logs) +### v1.0.0 +- 支持微信小程序, vue项目的引入 +- 以项目目录为根目录 \ No newline at end of file diff --git a/README.md b/README.md index 3379ffe..a0e4845 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,27 @@ [![Build Status](https://travis-ci.org/yutent/auto-path.svg?branch=master)](https://travis-ci.org/yutent/auto-path) +## 概念说明 + +- **根目录`/`** +> 这里的根目录不是系统的根目录, 而是当前vscode打开的项目的目录。 + + + + +## 支持情况 + +1. 小程序项目(微信) +> 打开项目时, 自动判断根目录中是否有`app.json`文件, 如果有, 则进一步判断是否有`pages`字段或`subPackages`, 有则识别当前项目为 小程序项目。 + - 当输入 `./` 开头时, 读取当前目录下的文件。 + - 当输入 `/`开头时, 只读取`pages`或`subPackages`中的路径。 + +2. vue项目 +> 判断根目录是否有 `vue.config.js`或`vite.config.js`, 有则认为是vue项目。 + - 当输入 `./` 开头时, 读取当前目录下的文件。 + - 当输入 `@/`开头时, 只读取`src/`中的路径。 + - 当输入 `/`开头时, 读取根目录的文件。 + +3. 常规项目 + - 当输入 `./` 开头时, 读取当前目录下的文件。 + - 当输入 `/`开头时, 读取根目录的文件。 \ No newline at end of file diff --git a/package.json b/package.json index 197e522..6245355 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,8 @@ { - "name": "auth-path", - "displayName": "auth-path", + "name": "auto-path", + "displayName": "auto-path", "description": "🔥 自动提示文件路径, 方便引入项目为的文件", - "version": "0.1.0", + "version": "1.0.0", "publisher": "yutent", "author": "Yutent [@yutent]", "icon": "logo.png", @@ -15,7 +15,7 @@ "contributes": {}, "repository": { "type": "git", - "url": "https://github.com/yutent/auth-path.git" + "url": "https://github.com/yutent/auto-path.git" }, "keywords": [ "autofile",