blackteay/vue-baidu-analytics
1
0
Fork 0
mirror of https://github.com/analyticsjs/vue-baidu-analytics.git synced 2025-04-05 07:52:44 +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,
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',
}
};
},
}

4
package.json
View File

@ -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",

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

68
src/main.ts
View File

@ -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<Options>) {
export default function install(
Vue: Vue,
{ router, siteIdList, isDebug = false }: Partial<Options>
) {
/**
* 一些环境和参数的检查
*/
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)
})
}

89
src/modules/baidu.ts
View File

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

50
src/modules/getVueVersion.ts
View File

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

43
src/modules/pushBAIDU.ts
View File

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

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
}