blackteay/vue-baidu-analytics
1
0
Fork 0
mirror of https://github.com/analyticsjs/vue-baidu-analytics.git synced 2025-04-05 19:41:42 +08:00
Code Issues Projects Releases Wiki Activity

chore: update eslint rule

Browse Source
This commit is contained in:
程沛权 2021-06-15 17:17:20 +08:00
parent 3ad117891b
commit 900b744a5b
8 changed files with 162 additions and 141 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.eslintrc.ts → .eslintrc.js
View File

@ -4,20 +4,15 @@ module.exports = {
node: true, node: true,
browser: true, browser: true,
}, },
extends: [ extends: ['eslint:recommended', 'prettier'],
'eslint:recommended',
'prettier',
],
parser: '@typescript-eslint/parser', parser: '@typescript-eslint/parser',
parserOptions: { parserOptions: {
ecmaVersion: 2020, ecmaVersion: 2020,
}, },
plugins: [ plugins: ['@typescript-eslint', 'prettier'],
'@typescript-eslint',
],
rules: { rules: {
'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off', 'no-console': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off', 'no-debugger': process.env.NODE_ENV === 'production' ? 'warn' : 'off',
'prettier/prettier': 'warn', 'prettier/prettier': 'warn',
} },
}; }

4
package.json
View File

@ -5,7 +5,9 @@
"main": "dist/vue-baidu-analytics.min.js", "main": "dist/vue-baidu-analytics.min.js",
"types": "vue-baidu-analytics.d.ts", "types": "vue-baidu-analytics.d.ts",
"scripts": { "scripts": {
"build": "rollup -c rollup.config.ts" "build": "rollup -c rollup.config.ts",
"lint": "eslint src --ext .js,.ts",
"prettier": "prettier --write src"
}, },
"repository": { "repository": {
"type": "git", "type": "git",

22
src/global.d.ts vendored
View File

@ -1,24 +1,8 @@
import PushBAIDU from '@m/pushBAIDU' /* eslint-disable no-unused-vars */
export {}
declare global { declare global {
interface Window { interface Window {
_hmt: any; _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;
} }
} }

68
src/main.ts
View File

@ -1,11 +1,12 @@
import PushBAIDU from '@m/pushBAIDU' import PushBAIDU from '@m/pushBAIDU'
import getVueVersion from '@m/getVueVersion' import getVueVersion from '@m/getVueVersion'
import type { Options, Vue } from '@/types'
/** /**
* 全局的数据 * 全局的数据
*/ */
const __GLOBAL__ = { const __GLOBAL__ = {
pushBAIDU: {} as PushBAIDU pushBAIDU: {} as PushBAIDU,
} }
/** /**
@ -16,78 +17,89 @@ const __GLOBAL__ = {
* const baidu = usePush(); * const baidu = usePush();
* baidu.pv('/'); * baidu.pv('/');
*/ */
export function usePush () { export function usePush() {
// 提交 pv // 提交 pv
function pv (pageUrl: string) { function pv(pageUrl: string) {
return __GLOBAL__.pushBAIDU.pv(pageUrl); return __GLOBAL__.pushBAIDU.pv(pageUrl)
} }
// 提交事件 // 提交事件
function event (category: string, action: string, label: string, value: number) { function event(
return __GLOBAL__.pushBAIDU.event(category, action, label, value); category: string,
action: string,
label: string,
value: number
) {
return __GLOBAL__.pushBAIDU.event(category, action, label, value)
} }
return { return {
pv, pv,
event event,
} }
} }
/** /**
* 定义插件 * 定义插件
*/ */
export default function install (Vue: Vue, { router, siteIdList, isDebug = false }: Partial<Options>) { export default function install(
Vue: Vue,
{ router, siteIdList, isDebug = false }: Partial<Options>
) {
/** /**
* 一些环境和参数的检查 * 一些环境和参数的检查
*/ */
if ( typeof document === 'undefined' || typeof window === 'undefined' ) { if (typeof document === 'undefined' || typeof window === 'undefined') {
return false; return false
} }
if ( !router ) { if (!router) {
throw new Error('[vue-baidu-analytics] Must pass a Vue-Router instance to vue-baidu-analytics.'); throw new Error(
'[vue-baidu-analytics] Must pass a Vue-Router instance to vue-baidu-analytics.'
)
} }
if ( !siteIdList ) { if (!siteIdList) {
throw new Error('[vue-baidu-analytics] Missing tracking domain ID, add at least one of baidu analytics siteId.'); 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); const pushBAIDU: PushBAIDU = new PushBAIDU(siteIdList, isDebug)
__GLOBAL__.pushBAIDU = pushBAIDU; __GLOBAL__.pushBAIDU = pushBAIDU
/** /**
* 挂载全局变量到 Vue 上 * 挂载全局变量到 Vue 上
* 获取Vue版本（获取失败则默认为2） * 获取Vue版本（获取失败则默认为2）
*/ */
const VUE_VERSION: number = getVueVersion(Vue) || 2; const VUE_VERSION: number = getVueVersion(Vue) || 2
switch (VUE_VERSION) { switch (VUE_VERSION) {
case 2: case 2:
Vue.prototype.$pushBAIDU = pushBAIDU; Vue.prototype.$pushBAIDU = pushBAIDU
break; break
case 3: case 3:
Vue.config.globalProperties.$pushBAIDU = pushBAIDU; Vue.config.globalProperties.$pushBAIDU = pushBAIDU
break; break
} }
/** /**
* 部署站点并初始化 * 部署站点并初始化
*/ */
if ( siteIdList && Array.isArray(siteIdList) ) { if (siteIdList && Array.isArray(siteIdList)) {
pushBAIDU.init(); pushBAIDU.init()
} }
/** /**
* 路由切换时执行PV上报 * 路由切换时执行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)
}); })
} }

89
src/modules/baidu.ts
View File

@ -3,87 +3,100 @@
* 官方文档 https://tongji.baidu.com/open/api/more?p=guide_overview * 官方文档 https://tongji.baidu.com/open/api/more?p=guide_overview
*/ */
class BAIDU { class BAIDU {
siteId: string; siteId: string
isDebug: boolean; isDebug: boolean
constructor (siteId: string = '', isDebug: boolean = false) { constructor(siteId: string = '', isDebug: boolean = false) {
this.siteId = siteId; this.siteId = siteId
this.isDebug = isDebug; this.isDebug = isDebug
} }
/** /**
* 初始化 * 初始化
*/ */
init () { init() {
window._hmt = window._hmt ? window._hmt : []; window._hmt = window._hmt ? window._hmt : []
const SCRIPT = document.createElement('script'); const SCRIPT = document.createElement('script')
SCRIPT['async'] = true; SCRIPT['async'] = true
SCRIPT['src'] = `https://hm.baidu.com/hm.js?${this.siteId}`; SCRIPT['src'] = `https://hm.baidu.com/hm.js?${this.siteId}`
document.querySelector('head')?.appendChild(SCRIPT); document.querySelector('head')?.appendChild(SCRIPT)
if ( this.isDebug ) { if (this.isDebug) {
console.log(`[vue-baidu-analytics] siteId load done.\nsiteId: ${this.siteId}`); console.log(
`[vue-baidu-analytics] siteId load done.\nsiteId: ${this.siteId}`
)
} }
} }
/** /**
* 设置要响应的站点 * 设置要响应的站点
*/ */
setAccount () { setAccount() {
window._hmt.push(['_setAccount', this.siteId]); window._hmt.push(['_setAccount', this.siteId])
} }
/** /**
* 提交PV、UV * 提交PV、UV
*/ */
trackPageview (pageUrl: string) { trackPageview(pageUrl: string) {
// 如果页面链接没传或者无效链接，则默认为根域名 // 如果页面链接没传或者无效链接，则默认为根域名
if ( !pageUrl || typeof pageUrl !== 'string' ) { if (!pageUrl || typeof pageUrl !== 'string') {
pageUrl = '/'; pageUrl = '/'
} }
// 如果页面链接带上了域名，则需要过滤掉 // 如果页面链接带上了域名，则需要过滤掉
if ( pageUrl.includes('http') ) { if (pageUrl.startsWith('http')) {
const PAGE_CUT = pageUrl.split('/'); const PAGE_CUT = pageUrl.split('/')
const HOST_NAME = `${PAGE_CUT[0]}//${PAGE_CUT[2]}`; const HOST_NAME = `${PAGE_CUT[0]}//${PAGE_CUT[2]}`
pageUrl = pageUrl.replace(HOST_NAME, ''); pageUrl = pageUrl.replace(HOST_NAME, '')
} }
// 设置响应 id 并提交数据 // 设置响应 id 并提交数据
this.setAccount(); this.setAccount()
window._hmt.push(['_trackPageview', pageUrl]); window._hmt.push(['_trackPageview', pageUrl])
if ( this.isDebug ) { if (this.isDebug) {
console.log(`[vue-baidu-analytics] track pv done.\nsiteId: ${this.siteId}\npageUrl: ${pageUrl}`); 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 ) { if (
throw new Error('[vue-baidu-analytics] Missing necessary category and operation information, and must be of type string.'); 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' ) { if (!label || typeof label !== 'string') {
label = ''; label = ''
} }
if ( !Number(value) ) { if (!Number(value)) {
value = 1; value = 1
} }
// 设置响应id并提交数据 // 设置响应id并提交数据
this.setAccount(); this.setAccount()
window._hmt.push(['_trackEvent', category, action, label, value]); window._hmt.push(['_trackEvent', category, action, label, value])
if ( this.isDebug ) { if (this.isDebug) {
console.log(`[vue-baidu-analytics] track event done.\nsiteId: ${this.siteId}\ncategory: ${category}\naction: ${action}\nlabel: ${label}\nvalue: ${value}`); 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

18
src/modules/getVueVersion.ts
View File

@ -1,24 +1,26 @@
import type { Vue } from '@/types'
/** /**
* 获取Vue的版本 * 获取Vue的版本
* @return 2=Vue2.x, 3=Vue3.x * @return 2=Vue2.x, 3=Vue3.x
*/ */
const getVueVersion = (Vue: Vue): number => { const getVueVersion = (Vue: Vue): number => {
let version: number = 2; let version: number = 2
// 获取Vue的版本号 // 获取Vue的版本号
const VUE_VERSION: string = String(Vue.version); const VUE_VERSION: string = String(Vue.version)
// Vue 2.x // Vue 2.x
if ( VUE_VERSION.slice(0, 2) === '2.' ) { if (VUE_VERSION.slice(0, 2) === '2.') {
version = 2; version = 2
} }
// Vue 3.x // Vue 3.x
if ( VUE_VERSION.slice(0, 2) === '3.' ) { if (VUE_VERSION.slice(0, 2) === '3.') {
version = 3; version = 3
} }
return version; return version
} }
export default getVueVersion; export default getVueVersion

43
src/modules/pushBAIDU.ts
View File

@ -4,44 +4,43 @@ import BAIDU from '@m/baidu'
* 定义推送操作 * 定义推送操作
*/ */
class PushBAIDU { class PushBAIDU {
siteIdList: string[]; siteIdList: string[]
isDebug: boolean; isDebug: boolean
constructor (siteIdList: string[], isDebug: boolean) { constructor(siteIdList: string[], isDebug: boolean) {
this.siteIdList = [...siteIdList]; this.siteIdList = [...siteIdList]
this.isDebug = isDebug; this.isDebug = isDebug
} }
/** /**
* 批量部署站点 * 批量部署站点
*/ */
init () { init() {
this.siteIdList.forEach( (siteId: string) => { this.siteIdList.forEach((siteId: string) => {
const SITE = new BAIDU(siteId, this.isDebug); const SITE = new BAIDU(siteId, this.isDebug)
SITE.init(); SITE.init()
}); })
} }
/** /**
* 批量提交pv上报 * 批量提交pv上报
*/ */
pv (pageUrl: string) { pv(pageUrl: string) {
this.siteIdList.forEach( (siteId: string) => { this.siteIdList.forEach((siteId: string) => {
const SITE = new BAIDU(siteId, this.isDebug); const SITE = new BAIDU(siteId, this.isDebug)
SITE.trackPageview(pageUrl); SITE.trackPageview(pageUrl)
}); })
} }
/** /**
* 批量提交事件上报 * 批量提交事件上报
*/ */
event (category: string, action: string, label: string, value: number) { event(category: string, action: string, label: string, value: number) {
this.siteIdList.forEach( (siteId: string) => { this.siteIdList.forEach((siteId: string) => {
const SITE = new BAIDU(siteId, this.isDebug); const SITE = new BAIDU(siteId, this.isDebug)
SITE.trackEvent(category, action, label, value); SITE.trackEvent(category, action, label, value)
}); })
} }
} }
export default PushBAIDU; export default PushBAIDU

14
src/types.ts Normal file
View File

@ -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
}