VSCode中如何開發(fā)uni-app?下面本篇文章給大家分享一下VSCode中開發(fā)uni-app的教程,這可能是最好、最詳細(xì)的教程了??靵砜纯?!
我們將使用VSCode寫uni-app
,不同于Hbuilder X
,用VSCode是通過腳手架來創(chuàng)建項目,為什么我要用VSCode寫呢?可能還是不太習(xí)慣Hbuilder X等等原因,還有就是不想換開發(fā)工具,覺得開發(fā)前端一個VSCode就夠了,也不用去比較兩者誰好誰壞,自己喜歡哪個用哪個,這里就不過多贅述了?!就扑]學(xué)習(xí):《vscode入門教程》】
自己也用VSCode做了幾個uni-app
項目了,主要是寫小程序,總體體驗下來還是非常不錯的。
簡述一下這個教程能給VSCode開發(fā) uni-app
帶來的體驗
- 增強(qiáng)
pages.json
和manifest.json
開發(fā)體驗(語法提示、顏色塊、寫注釋) - 一鍵創(chuàng)建頁面、組件、分包
- 完善的
API
,組件,uni.scss語法提示 - 條件編譯注釋高亮
可以說,VSCode開發(fā)uni-app
的槽點基本上都解決了,有很多地方我覺得體驗還更好。
文章比較長,寫的也比較詳細(xì),小白也能看懂。
初始化項目
我們使用 vue2 創(chuàng)建工程作為示例,uni-app中Vue2版的組件庫和插件也比較多,穩(wěn)定、問題少,可以先參考下官方文檔:工程化
既然是使用vue腳手架,那肯定要全局安裝@vue/cli
,已安裝的可以跳過。
注意:Vue2創(chuàng)建的項目,腳手架版本要用@4的版本,用@5的版本運(yùn)行項目會報錯,這里推薦 @4.5.15
npm install -g @vue/cli
創(chuàng)建項目,后面是你的項目名字。
vue create -p dcloudio/uni-preset-vue uni_vue2_cli
這里我們選擇默認(rèn)模板。
在VSCode打開這個項目,可以看看整個項目項目結(jié)構(gòu),src
下項目結(jié)構(gòu)跟HbuilderX
創(chuàng)建的根目錄基本一樣,說明兩種項目轉(zhuǎn)換還是比較方便的。
提示:既然是Vue2項目,有
scss
文件,那肯定要裝vetur
和sass
這兩個插件吧,不會有人還沒有裝吧。
tsconfig.json報錯問題
創(chuàng)建tsconfig.json配置文件時,VSCode會自動檢測當(dāng)前項目當(dāng)中是否有ts文件,若沒有則報錯,提示用戶需要創(chuàng)建一個ts文件后,再去使用typescript。其實即使報紅,但運(yùn)行項目是沒有問題的,但有強(qiáng)迫癥的人肯定受不了,不可能一直看著報錯吧。
解決方案很簡單,就是在項目根目錄下,隨便建一個ts
文件,不用寫任何東西,然后在tsconfig.json
配置 files
這個就好了。
我們在項目根目錄下新建一個puppet.ts
,puppet:傀儡的意思,哈哈,這里名字可以自己隨便起。
tsconfig.json
:
{ "compilerOptions": { "types": ["@dcloudio/types", "miniprogram-api-typings", "mini-types"] }, "files": ["puppet.ts"] }
增強(qiáng)pages.json和manifest.json開發(fā)體驗
json文件寫注釋
我們打開pages.json
和manifest.json
,發(fā)現(xiàn)會報紅,這是因為在json
中是不能寫注釋的,而在jsonc
是可以寫注釋的。
解決方案:我們把pages.json
和manifest.json
這兩個文件關(guān)聯(lián)到jsonc
中,然后就以寫注釋了。在設(shè)置中打開settings.json
,添加:
千萬不要把所有json
文件都關(guān)聯(lián)到jsonc
中,你感覺在json
中都能寫注釋了,覺得更好用了,其實不然,json就是json,jsonc就是jsonc,這兩個是不一樣的,例如,你在package.json
寫注釋VSCode是不報錯了,但編譯的時候還是會報錯的,因為package.json
就是不能寫注釋的。
語法提示
很多人剛開始使用VSCode
寫uni-app
時,因為pages.json
沒有任何語法提示,直接被勸退了,當(dāng)初我也差點被勸退了,不過經(jīng)過我的不懈努力,終于解決了。
其實現(xiàn)在VSCode已經(jīng)有第三方插件提供語法提示和簡單的校驗了,體驗也是相當(dāng)?shù)牟诲e。
而且鼠標(biāo)懸浮還有提示,相當(dāng)?shù)馁N心了。
顏色塊顯示
VSCode在json
文件是不顯示像css
中一樣的顏色塊
,但有個插件可以幫我們做到。
當(dāng)然,我們要對這個插件進(jìn)行相關(guān)的配置,以便更好的使用。
"color-highlight.enable": true, // 開啟插件 // 顏色塊的樣式,這里我選擇了跟VSCode中css差不多樣子的顏色塊,自己選擇喜歡的就行 "color-highlight.markerType": "dot-before", // 這個插件起效果的語言,這里設(shè)置只在jsonc起作用 "color-highlight.languages": ["jsonc"], // 是否在旁邊的滾條顯示顏色,個人覺得不好看,關(guān)了 "color-highlight.markRuler": false, // 是否匹配單詞,如white,black "color-highlight.matchWords": false,
一鍵創(chuàng)建頁面、組件、分包
然后就是怎么快速創(chuàng)建頁面、組件、分包,那就要推薦以下這款插件了,支持一鍵創(chuàng)建,并且添加到paegs,json
中。
條件編譯注釋高亮
在Hubilder X條件注釋是有高亮的,以便區(qū)分開普通注釋,在VSCode也有對應(yīng)的插件可以實現(xiàn),不得不說,VSCode的生態(tài)真的太好了,要啥插件都有。
這個插件可以定制化我們的注釋,比如顏色、加粗、斜體,怎么好看怎么來。
"better-comments.tags":[ { "tag": "#", "color": "#18b566", "strikethrough": false, "underline": false, "backgroundColor": "transparent", "bold": true, "italic": false }, ]
API,組件,uni.scss語法提示
API語法提示
用Vue2創(chuàng)建的uni-app
的cli項目默認(rèn)是已經(jīng)安裝對應(yīng)的Api
語法提示,并且默認(rèn)已經(jīng)在tscongfig.json
配置好了,有三個:
- @dcloudio/types,
uni
語法提示 - miniprogram-api-typings,微信小程序
wx
語法提示 - mini-types,支付寶小程序
my
語法提示
組件提示
接下來就是組件語法提示,如<view>
、<button>
等uni-app原生組件,這個需要我們手動安裝對應(yīng)的依賴包。
npm i @dcloudio/uni-helper-json
如果你覺得還不夠好用,你還可以安裝第三方插件來提供和Hbuilder X一樣的代碼塊
,推薦插件:uniapp小程序擴(kuò)展、uni-app-snippets
uni.scss變量提示
注意:cli創(chuàng)建的uni-app項目,跟web項目一樣,需要安裝對應(yīng)的sass模塊,才能寫scss。安裝sass-loader,建議版本@10,否則可能會導(dǎo)致vue與sass的兼容問題而報錯。
npm i sass sass-loader@10 -D
安裝SCSS IntelliSense
插件,就可以提示你項目中scss
文件中定義的變量了。
運(yùn)行、發(fā)布項目
對應(yīng)的命令在package.json
,中,可以自行查看。
- npm run dev:%PLATFORM%
- npm run build:%PLATFORM%
發(fā)現(xiàn)命令還是比較長的,其實有更簡便的方式,VSCode支持一鍵運(yùn)行npm
腳本,我們以微信小程序為例。
VSCode
跟Hbuilder x
不同的是,VSCode不會自動在微信開發(fā)者工具導(dǎo)入項目并打開,我們需要手動導(dǎo)入項目,只需要導(dǎo)入一次就行了,以后直接打開微信開發(fā)者工具就行了。
需要注意的是,需要在manifest.json
配置微信小程序appid
,不然微信開發(fā)者工具會報錯。
在微信開發(fā)者工具導(dǎo)入打包出來的文件夾。
然后,就可以愉快的寫代碼了。不管是運(yùn)行項目,還是差量化編譯速度還是非??斓?。
使用 vue3 創(chuàng)建工程
尤雨溪宣布Vue 3 在 2022 年 2 月 7 日成為新的默認(rèn)版本,但目前uni-app對應(yīng)的Vue3版的組件庫和插件還是有點少了。
使用Vue3創(chuàng)建項目跟Vue2有點區(qū)別,Vue3創(chuàng)建的項目采用的是vite
,有一說一,vite
是真的快,初始化項目的時候遇到了一些坑,這里說一下。
我一開始也卡住了,訪問倉庫失敗,官方文檔也說了解決方案,看了下,就是去更新下@dcloudio/uvm
。
npx @dcloudio/uvm
然后再試一下就沒問題了,這里以javascript
模板為例
npx degit dcloudio/uni-preset-vue#vite uni_vue3_cli
還有一個坑,就是Vue3創(chuàng)建的項目默認(rèn)不安裝API
語法提示依賴,所以要我們手動去安裝一下,然后去tsconfig.json
配置一下。
npm i @dcloudio/types miniprogram-api-typings mini-types -D
VSCode有尤雨溪團(tuán)隊專門為Vue3
打造的插件Volar,寫Vue3就用 Volar
,再配合Vite
,開發(fā)體驗真的很nice,這里就不過多講了。
DCloud插件市場的使用
VSCode不能像Hbuilder X一樣一鍵導(dǎo)入插件,一般用cli創(chuàng)建的項目要使用插件,一般有兩種方式,第一種是支持npm
安裝的,那就用npm
最好,如uViewUI
,另一種不支持npm
安裝的,那就下載對應(yīng)的zip壓縮包
,放到項目中,這種一般會有兩個版本,我們選擇非uni_modules版本,如uCharts
。
這點確實沒有Hbuilder X方便,不過導(dǎo)入第三方插件這種事情不是經(jīng)常做,這還是可以接受的。
插件推薦
然后順手推薦幾個非常實用的插件,幫助我們提高開發(fā)效率。
- Image preview
- Path Intellisense
鼠標(biāo)懸停可以預(yù)覽圖片。
"gutterpreview.showImagePreviewOnGutter": false,// 關(guān)閉在行號中顯示縮列圖
這個插件可以幫助我們配置路徑別名,路徑智能感知。
"path-intellisense.mappings": { "@": "${workspaceRoot}/src/", "static": "${workspaceRoot}/src/static" },
還有兩個是組件庫語法提示、代碼塊的插件,自己根據(jù)需要去安裝,這里就不過多贅述了。
- uniapp小程序擴(kuò)展
- uni-ui-snippets
結(jié)語
我在github倉庫里建了一個模板項目,可以參考一下:uni-vscode-template。
總的來說,配置起來還是比較麻煩的,插件也比較多,但最終獲得體驗也是非常不錯的。
因為uni-app
項目跟其他前端項目差異較大,我還是比較推薦為uni-app
項目單獨(dú)做個VSCode工作區(qū)。對于VSCode工作區(qū)概念,可以看看我的這篇文章:VSCode工作區(qū)指南:回歸輕量,打造全能編輯器。
或者說,為每個項目單獨(dú)做一個settings.json
。
原文地址:https://juejin.cn/post/7090532271257714695
作者:小染Jun