From 900b744a5b852c47c32c218e0f7242620f9aade8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=A8=8B=E6=B2=9B=E6=9D=83?= Date: Tue, 15 Jun 2021 17:17:20 +0800 Subject: [PATCH] chore: update eslint rule --- .eslintrc.ts => .eslintrc.js | 13 ++---- package.json | 4 +- src/global.d.ts | 22 ++------- src/main.ts | 68 +++++++++++++++------------ src/modules/baidu.ts | 89 +++++++++++++++++++++--------------- src/modules/getVueVersion.ts | 50 ++++++++++---------- src/modules/pushBAIDU.ts | 43 +++++++++-------- src/types.ts | 14 ++++++ 8 files changed, 162 insertions(+), 141 deletions(-) rename .eslintrc.ts => .eslintrc.js (76%) create mode 100644 src/types.ts diff --git a/.eslintrc.ts b/.eslintrc.js similarity index 76% rename from .eslintrc.ts rename to .eslintrc.js index 6a2cc04..0a7e7fa 100644 --- a/.eslintrc.ts +++ b/.eslintrc.js @@ -4,20 +4,15 @@ module.exports = { node: true, browser: true, }, - extends: [ - 'eslint:recommended', - 'prettier', - ], + extends: ['eslint:recommended', 'prettier'], parser: '@typescript-eslint/parser', parserOptions: { ecmaVersion: 2020, }, - plugins: [ - '@typescript-eslint', - ], + plugins: ['@typescript-eslint', 'prettier'], rules: { 'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off', 'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off', 'prettier/prettier': 'warn', - } -}; + }, +} diff --git a/package.json b/package.json index c999364..3db7cdd 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,9 @@ "main": "dist/vue-baidu-analytics.min.js", "types": "vue-baidu-analytics.d.ts", "scripts": { - "build": "rollup -c rollup.config.ts" + "build": "rollup -c rollup.config.ts", + "lint": "eslint src --ext .js,.ts", + "prettier": "prettier --write src" }, "repository": { "type": "git", diff --git a/src/global.d.ts b/src/global.d.ts index d9bf99c..26d6f61 100644 --- a/src/global.d.ts +++ b/src/global.d.ts @@ -1,24 +1,8 @@ -import PushBAIDU from '@m/pushBAIDU' +/* eslint-disable no-unused-vars */ +export {} declare global { interface Window { - _hmt: any; - } - - interface Options { - router: any; - siteIdList: string[]; - isDebug: boolean; - } - - interface Vue { - prototype: any; - $pushBAIDU: PushBAIDU; - version: number | string; - config: any; - } - - interface To { - fullPath: string; + _hmt: any } } diff --git a/src/main.ts b/src/main.ts index ca2e523..863af85 100644 --- a/src/main.ts +++ b/src/main.ts @@ -1,11 +1,12 @@ import PushBAIDU from '@m/pushBAIDU' import getVueVersion from '@m/getVueVersion' +import type { Options, Vue } from '@/types' /** * 全局的数据 */ const __GLOBAL__ = { - pushBAIDU: {} as PushBAIDU + pushBAIDU: {} as PushBAIDU, } /** @@ -16,78 +17,89 @@ const __GLOBAL__ = { * const baidu = usePush(); * baidu.pv('/'); */ -export function usePush () { +export function usePush() { // 提交 pv - function pv (pageUrl: string) { - return __GLOBAL__.pushBAIDU.pv(pageUrl); + function pv(pageUrl: string) { + return __GLOBAL__.pushBAIDU.pv(pageUrl) } // 提交事件 - function event (category: string, action: string, label: string, value: number) { - return __GLOBAL__.pushBAIDU.event(category, action, label, value); + function event( + category: string, + action: string, + label: string, + value: number + ) { + return __GLOBAL__.pushBAIDU.event(category, action, label, value) } return { pv, - event + event, } } /** * 定义插件 */ -export default function install (Vue: Vue, { router, siteIdList, isDebug = false }: Partial) { - +export default function install( + Vue: Vue, + { router, siteIdList, isDebug = false }: Partial +) { /** * 一些环境和参数的检查 */ - if ( typeof document === 'undefined' || typeof window === 'undefined' ) { - return false; + if (typeof document === 'undefined' || typeof window === 'undefined') { + return false } - if ( !router ) { - throw new Error('[vue-baidu-analytics] Must pass a Vue-Router instance to vue-baidu-analytics.'); + if (!router) { + throw new Error( + '[vue-baidu-analytics] Must pass a Vue-Router instance to vue-baidu-analytics.' + ) } - if ( !siteIdList ) { - throw new Error('[vue-baidu-analytics] Missing tracking domain ID, add at least one of baidu analytics siteId.'); + if (!siteIdList) { + throw new Error( + '[vue-baidu-analytics] Missing tracking domain ID, add at least one of baidu analytics siteId.' + ) } /** * 挂载推送的方法 */ - const pushBAIDU: PushBAIDU = new PushBAIDU(siteIdList, isDebug); - __GLOBAL__.pushBAIDU = pushBAIDU; + const pushBAIDU: PushBAIDU = new PushBAIDU(siteIdList, isDebug) + __GLOBAL__.pushBAIDU = pushBAIDU /** * 挂载全局变量到 Vue 上 * 获取Vue版本（获取失败则默认为2） */ - const VUE_VERSION: number = getVueVersion(Vue) || 2; + const VUE_VERSION: number = getVueVersion(Vue) || 2 switch (VUE_VERSION) { case 2: - Vue.prototype.$pushBAIDU = pushBAIDU; - break; + Vue.prototype.$pushBAIDU = pushBAIDU + break case 3: - Vue.config.globalProperties.$pushBAIDU = pushBAIDU; - break; + Vue.config.globalProperties.$pushBAIDU = pushBAIDU + break } /** * 部署站点并初始化 */ - if ( siteIdList && Array.isArray(siteIdList) ) { - pushBAIDU.init(); + if (siteIdList && Array.isArray(siteIdList)) { + pushBAIDU.init() } /** * 路由切换时执行PV上报 */ - router.afterEach( (to: To) => { + router.afterEach(() => { // 获取要上报的链接（当前版本不需要拼接了） - const PAGE_URL: string = window.location.href; + const PAGE_URL: string = window.location.href // 上报数据 - pushBAIDU.pv(PAGE_URL); - }); + pushBAIDU.pv(PAGE_URL) + }) } diff --git a/src/modules/baidu.ts b/src/modules/baidu.ts index e0d3092..9b3e4f2 100644 --- a/src/modules/baidu.ts +++ b/src/modules/baidu.ts @@ -3,87 +3,100 @@ * 官方文档 https://tongji.baidu.com/open/api/more?p=guide_overview */ class BAIDU { - siteId: string; - isDebug: boolean; + siteId: string + isDebug: boolean - constructor (siteId: string = '', isDebug: boolean = false) { - this.siteId = siteId; - this.isDebug = isDebug; + constructor(siteId: string = '', isDebug: boolean = false) { + this.siteId = siteId + this.isDebug = isDebug } /** * 初始化 */ - init () { - window._hmt = window._hmt ? window._hmt : []; - const SCRIPT = document.createElement('script'); - SCRIPT['async'] = true; - SCRIPT['src'] = `https://hm.baidu.com/hm.js?${this.siteId}`; - document.querySelector('head')?.appendChild(SCRIPT); + init() { + window._hmt = window._hmt ? window._hmt : [] + const SCRIPT = document.createElement('script') + SCRIPT['async'] = true + SCRIPT['src'] = `https://hm.baidu.com/hm.js?${this.siteId}` + document.querySelector('head')?.appendChild(SCRIPT) - if ( this.isDebug ) { - console.log(`[vue-baidu-analytics] siteId load done.\nsiteId: ${this.siteId}`); + if (this.isDebug) { + console.log( + `[vue-baidu-analytics] siteId load done.\nsiteId: ${this.siteId}` + ) } } /** * 设置要响应的站点 */ - setAccount () { - window._hmt.push(['_setAccount', this.siteId]); + setAccount() { + window._hmt.push(['_setAccount', this.siteId]) } /** * 提交PV、UV */ - trackPageview (pageUrl: string) { + trackPageview(pageUrl: string) { // 如果页面链接没传或者无效链接，则默认为根域名 - if ( !pageUrl || typeof pageUrl !== 'string' ) { - pageUrl = '/'; + if (!pageUrl || typeof pageUrl !== 'string') { + pageUrl = '/' } // 如果页面链接带上了域名，则需要过滤掉 - if ( pageUrl.includes('http') ) { - const PAGE_CUT = pageUrl.split('/'); - const HOST_NAME = `${PAGE_CUT[0]}//${PAGE_CUT[2]}`; - pageUrl = pageUrl.replace(HOST_NAME, ''); + if (pageUrl.startsWith('http')) { + const PAGE_CUT = pageUrl.split('/') + const HOST_NAME = `${PAGE_CUT[0]}//${PAGE_CUT[2]}` + pageUrl = pageUrl.replace(HOST_NAME, '') } // 设置响应 id 并提交数据 - this.setAccount(); - window._hmt.push(['_trackPageview', pageUrl]); + this.setAccount() + window._hmt.push(['_trackPageview', pageUrl]) - if ( this.isDebug ) { - console.log(`[vue-baidu-analytics] track pv done.\nsiteId: ${this.siteId}\npageUrl: ${pageUrl}`); + if (this.isDebug) { + console.log( + `[vue-baidu-analytics] track pv done.\nsiteId: ${this.siteId}\npageUrl: ${pageUrl}` + ) } } /** * 提交点击事件 */ - trackEvent (category: string, action: string, label: string, value: number) { + trackEvent(category: string, action: string, label: string, value: number) { // 前两个是必填项 - if ( typeof category !== 'string' || typeof action !== 'string' || !category || !action ) { - throw new Error('[vue-baidu-analytics] Missing necessary category and operation information, and must be of type string.'); + if ( + typeof category !== 'string' || + typeof action !== 'string' || + !category || + !action + ) { + throw new Error( + '[vue-baidu-analytics] Missing necessary category and operation information, and must be of type string.' + ) } // 重置一些无效的默认值 - if ( !label || typeof label !== 'string' ) { - label = ''; + if (!label || typeof label !== 'string') { + label = '' } - if ( !Number(value) ) { - value = 1; + if (!Number(value)) { + value = 1 } // 设置响应id并提交数据 - this.setAccount(); - window._hmt.push(['_trackEvent', category, action, label, value]); + this.setAccount() + window._hmt.push(['_trackEvent', category, action, label, value]) - if ( this.isDebug ) { - console.log(`[vue-baidu-analytics] track event done.\nsiteId: ${this.siteId}\ncategory: ${category}\naction: ${action}\nlabel: ${label}\nvalue: ${value}`); + if (this.isDebug) { + console.log( + `[vue-baidu-analytics] track event done.\nsiteId: ${this.siteId}\ncategory: ${category}\naction: ${action}\nlabel: ${label}\nvalue: ${value}` + ) } } } -export default BAIDU; +export default BAIDU diff --git a/src/modules/getVueVersion.ts b/src/modules/getVueVersion.ts index 6b843d3..1be8e60 100644 --- a/src/modules/getVueVersion.ts +++ b/src/modules/getVueVersion.ts @@ -1,24 +1,26 @@ -/** - * 获取Vue的版本 - * @return 2=Vue2.x, 3=Vue3.x - */ -const getVueVersion = (Vue: Vue): number => { - let version: number = 2; - - // 获取Vue的版本号 - const VUE_VERSION: string = String(Vue.version); - - // Vue 2.x - if ( VUE_VERSION.slice(0, 2) === '2.' ) { - version = 2; - } - - // Vue 3.x - if ( VUE_VERSION.slice(0, 2) === '3.' ) { - version = 3; - } - - return version; -} - -export default getVueVersion; \ No newline at end of file +import type { Vue } from '@/types' + +/** + * 获取Vue的版本 + * @return 2=Vue2.x, 3=Vue3.x + */ +const getVueVersion = (Vue: Vue): number => { + let version: number = 2 + + // 获取Vue的版本号 + const VUE_VERSION: string = String(Vue.version) + + // Vue 2.x + if (VUE_VERSION.slice(0, 2) === '2.') { + version = 2 + } + + // Vue 3.x + if (VUE_VERSION.slice(0, 2) === '3.') { + version = 3 + } + + return version +} + +export default getVueVersion diff --git a/src/modules/pushBAIDU.ts b/src/modules/pushBAIDU.ts index 9984ee1..4aa6ffe 100644 --- a/src/modules/pushBAIDU.ts +++ b/src/modules/pushBAIDU.ts @@ -4,44 +4,43 @@ import BAIDU from '@m/baidu' * 定义推送操作 */ class PushBAIDU { - siteIdList: string[]; - isDebug: boolean; + siteIdList: string[] + isDebug: boolean - constructor (siteIdList: string[], isDebug: boolean) { - this.siteIdList = [...siteIdList]; - this.isDebug = isDebug; + constructor(siteIdList: string[], isDebug: boolean) { + this.siteIdList = [...siteIdList] + this.isDebug = isDebug } /** * 批量部署站点 */ - init () { - this.siteIdList.forEach( (siteId: string) => { - const SITE = new BAIDU(siteId, this.isDebug); - SITE.init(); - }); + init() { + this.siteIdList.forEach((siteId: string) => { + const SITE = new BAIDU(siteId, this.isDebug) + SITE.init() + }) } /** * 批量提交pv上报 */ - pv (pageUrl: string) { - this.siteIdList.forEach( (siteId: string) => { - const SITE = new BAIDU(siteId, this.isDebug); - SITE.trackPageview(pageUrl); - }); + pv(pageUrl: string) { + this.siteIdList.forEach((siteId: string) => { + const SITE = new BAIDU(siteId, this.isDebug) + SITE.trackPageview(pageUrl) + }) } /** * 批量提交事件上报 */ - event (category: string, action: string, label: string, value: number) { - this.siteIdList.forEach( (siteId: string) => { - const SITE = new BAIDU(siteId, this.isDebug); - SITE.trackEvent(category, action, label, value); - }); + event(category: string, action: string, label: string, value: number) { + this.siteIdList.forEach((siteId: string) => { + const SITE = new BAIDU(siteId, this.isDebug) + SITE.trackEvent(category, action, label, value) + }) } - } -export default PushBAIDU; +export default PushBAIDU diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..a9835ce --- /dev/null +++ b/src/types.ts @@ -0,0 +1,14 @@ +import PushBAIDU from '@m/pushBAIDU' + +export interface Options { + router: any + siteIdList: string[] + isDebug: boolean +} + +export interface Vue { + prototype: any + $pushBAIDU: PushBAIDU + version: number | string + config: any +}