Clean code

ZHY · ZHY · commit 065a370b5c27 · 2022-04-05T02:02:30.000+08:00
diff --git a/src/app/components/limit/add-dialog/form/url.ts b/src/app/components/limit/add-dialog/form/url.ts
@@ -37,9 +37,9 @@ const protocolSelect = (protocolRef: Ref<string>) => h(ElSelect, {
 
 const url2PathItems = (url: string) => {
     const querySign = url.indexOf('?')
-    querySign > -1 && (url = url.substr(0, querySign))
+    querySign > -1 && (url = url.substring(0, querySign))
     const hashSign = url.indexOf('#')
-    hashSign > -1 && (url = url.substr(0, hashSign))
+    hashSign > -1 && (url = url.substring(0, hashSign))
     return url.split('/').filter(path => path).map(path => UrlPathItem.of(path))
 }
 
@@ -58,10 +58,10 @@ const handlePaste = async (protocolRef: Ref<string>, pathItemsRef: Ref<UrlPathIt
     url = decodeURI(url)
     if (url.startsWith(Protocol.HTTP)) {
         protocol = Protocol.HTTP
-        url = url.substr(Protocol.HTTP.length)
+        url = url.substring(Protocol.HTTP.length)
     } else if (url.startsWith(Protocol.HTTPS)) {
         protocol = Protocol.HTTPS
-        url = url.substr(Protocol.HTTPS.length)
+        url = url.substring(Protocol.HTTPS.length)
     }
     protocolRef.value = protocol
     pathItemsRef.value = url2PathItems(url)
diff --git a/src/app/components/trend/host-option-info.ts b/src/app/components/trend/host-option-info.ts
@@ -32,7 +32,7 @@ class HostOptionInfo {
     static from(key: string) {
         if (!key || !key.length) return this.empty()
         const merged = key.charAt(0) === '1'
-        return new HostOptionInfo(key.substr(1), merged)
+        return new HostOptionInfo(key.substring(1), merged)
     }
 
     key(): string {
diff --git a/src/database/archived-database.ts b/src/database/archived-database.ts
@@ -22,7 +22,7 @@ class ArchivedDatabase extends BaseDatabase {
         const result = {}
         Object.entries(items)
             .filter(([key]) => key.startsWith(ARCHIVED_PREFIX))
-            .map(([key, val]) => [key.substr(ARCHIVED_PREFIX.length), val])
+            .map(([key, val]) => [key.substring(ARCHIVED_PREFIX.length), val])
             .forEach(([key, val]) => result[key] = val)
         log('All archived', result)
         return Promise.resolve(result)
diff --git a/src/database/host-alias-database.ts b/src/database/host-alias-database.ts
@@ -24,12 +24,12 @@ const ABBR_MAP = {
 const generateKey = (host: string) => DB_KEY_PREFIX + host
 const hostOf = (key: string) => key.substring(DB_KEY_PREFIX_LENGTH)
 function valueOf(host: string, value: string): HostAlias {
-    const abbr = value.substr(0, 1)
+    const abbr = value.substring(0, 1)
 
     return {
         host,
         source: ABBR_MAP[abbr],
-        name: value.substr(1)
+        name: value.substring(1)
     }
 }
 
diff --git a/src/database/period-database.ts b/src/database/period-database.ts
@@ -28,11 +28,11 @@ function merge(exists: { [dateKey: string]: FocusPerDay }, toMerge: PeriodInfo[]
 function db2PeriodInfos(data: { [dateKey: string]: FocusPerDay }): PeriodInfo[] {
     const result: PeriodInfo[] = []
     Object.entries(data).forEach((([dateKey, val]) => {
-        const dateStr = dateKey.substr(KEY_PREFIX_LENGTH)
+        const dateStr = dateKey.substring(KEY_PREFIX_LENGTH)
         const date = new Date(
-            Number.parseInt(dateStr.substr(0, 4)),
-            Number.parseInt(dateStr.substr(4, 2)) - 1,
-            Number.parseInt(dateStr.substr(6, 2))
+            Number.parseInt(dateStr.substring(0, 4)),
+            Number.parseInt(dateStr.substring(4, 6)) - 1,
+            Number.parseInt(dateStr.substring(6, 8))
         )
         Object
             .entries(val)
diff --git a/src/database/timer-database.ts b/src/database/timer-database.ts
@@ -199,7 +199,7 @@ class TimerDatabase extends BaseDatabase {
         let result: DataItem[] = []
 
         for (let key in items) {
-            const date = key.substr(0, 8)
+            const date = key.substring(0, 8)
             const host = key.substring(8)
             const val: WastePerDay = items[key]
             if (this.filterBefore(date, host, val, _cond)) {
diff --git a/src/popup/components/chart/option.ts b/src/popup/components/chart/option.ts
@@ -98,7 +98,7 @@ function calcPositionOfTooltip(container: HTMLDivElement, point: (number | strin
         tooltipWidth = tooltip.offsetWidth
         if (!tooltipWidth) {
             const styleWidth = tooltip.style.width
-            tooltipWidth = Number.parseFloat(styleWidth.endsWith('px') ? styleWidth.substr(0, styleWidth.length) : styleWidth)
+            tooltipWidth = Number.parseFloat(styleWidth.endsWith('px') ? styleWidth.substring(0, styleWidth.length) : styleWidth)
         }
         tooltipWidth = tooltipWidth || 0
     }
@@ -121,9 +121,9 @@ function calculateSubTitleText(date: Date | Date[]) {
         if (startStr === endStr) {
             return startStr
         } else {
-            if (startStr.substr(0, 4) === endStr.substr(0, 4)) {
+            if (startStr.substring(0, 4) === endStr.substring(0, 4)) {
                 // the same year
-                endStr = endStr.substr(5)
+                endStr = endStr.substring(5)
             }
             return `${startStr}-${endStr}`
         }
diff --git a/src/service/components/host-merge-ruler.ts b/src/service/components/host-merge-ruler.ts
@@ -16,8 +16,8 @@ export interface IHostMergeRuler {
 }
 
 /**
- * @param host host
- * @param dotCount the count of dots to remain 
+ * @param origin origin host
+ * @param dotCount the count of dots to remain
  */
 const getTheSuffix = (origin: string, dotCount: number) => {
     if (isIpAndPort(origin)) return origin
@@ -33,7 +33,7 @@ const getTheSuffix = (origin: string, dotCount: number) => {
         }
 
         const index = origin.lastIndexOf('.')
-        result.push(origin.substr(index + 1))
+        result.push(origin.substring(index + 1))
         origin = origin.substring(0, index)
     }
     return result.reverse().join('.')
@@ -68,7 +68,7 @@ export default class CustomizedHostMergeRuler implements IHostMergeRuler {
     }
 
     /**
-     * @param host origin host
+     * @param origin origin host
      * @returns merged host
      */
     merge(origin: string): string {
diff --git a/src/service/components/period-calculator.ts b/src/service/components/period-calculator.ts
@@ -40,7 +40,7 @@ export function calculate(timestamp: number, milliseconds: number): PeriodInfo[]
 /**
  * Found the max divisible period
  * 
- * @param date date  
+ * @param period key
  * @param periodWindowSize divisor
  */
 export function getMaxDivisiblePeriod(period: PeriodKey, periodWindowSize: number): PeriodKey {
diff --git a/src/util/i18n/i18n-vue.ts b/src/util/i18n/i18n-vue.ts
@@ -34,8 +34,8 @@ export type NodeTranslateProps<MessageType> = {
 /**
  * Translate with slots for vue
  * 
- * @param key key path
- * @param param param, slot vnodes
+ * @param messages messages
+ * @param props param, slot vnodes
  * @returns The array of vnodes or strings
  */
 export function tN<MessageType>(messages: MessageType, props: NodeTranslateProps<MessageType>): I18nResultItem[] {
diff --git a/src/util/i18n/index.ts b/src/util/i18n/index.ts
@@ -88,12 +88,6 @@ function fillWithParam(result: string, param: { [key: string]: string | number }
     return result
 }
 
-/**
- * Translate
- * @param key     keyPath 
- * @param param   param
- * @returns string or vnodes[]
- */
 export function t<MessageType>(messages: MessageType, props: TranslateProps<MessageType>): string {
     const { key, param } = props
     let result: string = getI18nVal(messages, key)
diff --git a/src/util/pattern.ts b/src/util/pattern.ts
@@ -35,7 +35,7 @@ export function isIpAndPort(host: string) {
     host = host.trim()
     const indexOfColon = host.indexOf(':')
     if (indexOfColon > 0) {
-        const portStr = host.substr(indexOfColon + 1)
+        const portStr = host.substring(indexOfColon + 1)
         if (isNotValidPort(portStr)) {
             return false
         }
@@ -53,11 +53,11 @@ export function isIpAndPort(host: string) {
 export function isValidHost(host: string) {
     const indexOfColon = host.indexOf(':')
     if (indexOfColon > -1) {
-        const portStr = host.substr(indexOfColon + 1)
+        const portStr = host.substring(indexOfColon + 1)
         if (isNotValidPort(portStr)) {
             return false
         }
-        host = host.substr(0, indexOfColon)
+        host = host.substring(0, indexOfColon)
     }
     const reg = /^((\*|([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9]))\.)*(\*|([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))$/
     return reg.test(host)
@@ -80,7 +80,7 @@ export function extractHostname(url: string): HostInfo {
         const splits = url.split('/')
         host = splits[2]
         protocol = splits[0]
-        protocol = protocol.substr(0, protocol.length - 1)
+        protocol = protocol.substring(0, protocol.length - 1)
     } else {
         host = url.split('/')[0]
         protocol = ''
@@ -101,7 +101,7 @@ export function extractFileHost(url: string): string {
     if (dotIdx < 0) {
         return undefined
     }
-    const suffix = url.substr(dotIdx + 1)?.toLowerCase()
+    const suffix = url.substring(dotIdx + 1)?.toLowerCase()
     return suffix ? SUFFIX_HOST_MAP[suffix] : undefined
 }
 
@@ -123,7 +123,7 @@ export function isHomepage(url: string) {
     const indexOfDoubleSlashes = url.indexOf("//")
     let hostStr = url
     if (indexOfDoubleSlashes > -1) {
-        hostStr = url.substr(indexOfDoubleSlashes + 2)
+        hostStr = url.substring(indexOfDoubleSlashes + 2)
     }
     const indexOfSlash = hostStr.indexOf("/")
     return indexOfSlash < 0 || indexOfSlash === hostStr.length - 1

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class HostOptionInfo {`
`32`	`32`	`static from(key: string) {`
`33`	`33`	`if (!key \|\| !key.length) return this.empty()`
`34`	`34`	`const merged = key.charAt(0) === '1'`
`35`		`- return new HostOptionInfo(key.substr(1), merged)`
	`35`	`+ return new HostOptionInfo(key.substring(1), merged)`
`36`	`36`	`}`
`37`	`37`
`38`	`38`	`key(): string {`
Original file line number	Diff line number	Diff line change
`@@ -24,12 +24,12 @@ const ABBR_MAP = {`
`24`	`24`	`const generateKey = (host: string) => DB_KEY_PREFIX + host`
`25`	`25`	`const hostOf = (key: string) => key.substring(DB_KEY_PREFIX_LENGTH)`
`26`	`26`	`function valueOf(host: string, value: string): HostAlias {`
`27`		`- const abbr = value.substr(0, 1)`
	`27`	`+ const abbr = value.substring(0, 1)`
`28`	`28`
`29`	`29`	`return {`
`30`	`30`	`host,`
`31`	`31`	`source: ABBR_MAP[abbr],`
`32`		`- name: value.substr(1)`
	`32`	`+ name: value.substring(1)`
`33`	`33`	`}`
`34`	`34`	`}`
`35`	`35`
Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ function calcPositionOfTooltip(container: HTMLDivElement, point: (number \| strin`
`98`	`98`	`tooltipWidth = tooltip.offsetWidth`
`99`	`99`	`if (!tooltipWidth) {`
`100`	`100`	`const styleWidth = tooltip.style.width`
`101`		`- tooltipWidth = Number.parseFloat(styleWidth.endsWith('px') ? styleWidth.substr(0, styleWidth.length) : styleWidth)`
	`101`	`+ tooltipWidth = Number.parseFloat(styleWidth.endsWith('px') ? styleWidth.substring(0, styleWidth.length) : styleWidth)`
`102`	`102`	`}`
`103`	`103`	`tooltipWidth = tooltipWidth \|\| 0`
`104`	`104`	`}`
`@@ -121,9 +121,9 @@ function calculateSubTitleText(date: Date \| Date[]) {`
`121`	`121`	`if (startStr === endStr) {`
`122`	`122`	`return startStr`
`123`	`123`	`} else {`
`124`		`- if (startStr.substr(0, 4) === endStr.substr(0, 4)) {`
	`124`	`+ if (startStr.substring(0, 4) === endStr.substring(0, 4)) {`
`125`	`125`	`// the same year`
`126`		`- endStr = endStr.substr(5)`
	`126`	`+ endStr = endStr.substring(5)`
`127`	`127`	`}`
`128`	`128`	return `${startStr}-${endStr}`
`129`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ export interface IHostMergeRuler {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * @param host host`
`20`		`- * @param dotCount the count of dots to remain`
	`19`	`+ * @param origin origin host`
	`20`	`+ * @param dotCount the count of dots to remain`
`21`	`21`	`*/`
`22`	`22`	`const getTheSuffix = (origin: string, dotCount: number) => {`
`23`	`23`	`if (isIpAndPort(origin)) return origin`
`@@ -33,7 +33,7 @@ const getTheSuffix = (origin: string, dotCount: number) => {`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`const index = origin.lastIndexOf('.')`
`36`		`- result.push(origin.substr(index + 1))`
	`36`	`+ result.push(origin.substring(index + 1))`
`37`	`37`	`origin = origin.substring(0, index)`
`38`	`38`	`}`
`39`	`39`	`return result.reverse().join('.')`
`@@ -68,7 +68,7 @@ export default class CustomizedHostMergeRuler implements IHostMergeRuler {`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`/**`
`71`		`- * @param host origin host`
	`71`	`+ * @param origin origin host`
`72`	`72`	`* @returns merged host`
`73`	`73`	`*/`
`74`	`74`	`merge(origin: string): string {`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ export function calculate(timestamp: number, milliseconds: number): PeriodInfo[]`
`40`	`40`	`/**`
`41`	`41`	`* Found the max divisible period`
`42`	`42`	`*`
`43`		`- * @param date date`
	`43`	`+ * @param period key`
`44`	`44`	`* @param periodWindowSize divisor`
`45`	`45`	`*/`
`46`	`46`	`export function getMaxDivisiblePeriod(period: PeriodKey, periodWindowSize: number): PeriodKey {`