chore: @typescript-eslint/explicit-module-boundary-types (#2735)

vitejs · Apr 14, 2021 · c61b3e4 · c61b3e4
1 parent 6dfba78
commit c61b3e4
Show file tree

Hide file tree

Showing 23 changed files with 119 additions and 67 deletions.
diff --git a/packages/plugin-vue/src/handleHotUpdate.ts b/packages/plugin-vue/src/handleHotUpdate.ts
@@ -144,7 +144,7 @@ export async function handleHotUpdate({
   return [...affectedModules].filter(Boolean) as ModuleNode[]
 }
 
-export function isEqualBlock(a: SFCBlock | null, b: SFCBlock | null) {
+export function isEqualBlock(a: SFCBlock | null, b: SFCBlock | null): boolean {
   if (!a && !b) return true
   if (!a || !b) return false
   // src imports will trigger their own updates
@@ -161,7 +161,7 @@ export function isEqualBlock(a: SFCBlock | null, b: SFCBlock | null) {
 export function isOnlyTemplateChanged(
   prev: SFCDescriptor,
   next: SFCDescriptor
-) {
+): boolean {
   return (
     isEqualBlock(prev.script, next.script) &&
     isEqualBlock(prev.scriptSetup, next.scriptSetup) &&

diff --git a/packages/plugin-vue/src/script.ts b/packages/plugin-vue/src/script.ts
@@ -17,15 +17,15 @@ export function setResolvedScript(
   descriptor: SFCDescriptor,
   script: SFCScriptBlock,
   ssr: boolean
-) {
+): void {
   ;(ssr ? ssrCache : clientCache).set(descriptor, script)
 }
 
 export function resolveScript(
   descriptor: SFCDescriptor,
   options: ResolvedOptions,
   ssr: boolean
-) {
+): SFCScriptBlock | null {
   if (!descriptor.script && !descriptor.scriptSetup) {
     return null
   }

diff --git a/packages/plugin-vue/src/utils/descriptorCache.ts b/packages/plugin-vue/src/utils/descriptorCache.ts
@@ -1,7 +1,13 @@
 import path from 'path'
 import slash from 'slash'
 import hash from 'hash-sum'
-import { parse, SFCDescriptor } from '@vue/compiler-sfc'
+import { CompilerError, parse, SFCDescriptor } from '@vue/compiler-sfc'
+
+// node_modules/@vue/compiler-sfc/dist/compiler-sfc.d.ts SFCParseResult should be exported so it can be re-used
+export interface SFCParseResult {
+  descriptor: SFCDescriptor
+  errors: Array<CompilerError | SyntaxError>
+}
 
 const cache = new Map<string, SFCDescriptor>()
 const prevCache = new Map<string, SFCDescriptor | undefined>()
@@ -11,7 +17,7 @@ export function createDescriptor(
   source: string,
   root: string,
   isProduction: boolean | undefined
-) {
+): SFCParseResult {
   const { descriptor, errors } = parse(source, {
     filename,
     sourceMap: true
@@ -26,15 +32,21 @@ export function createDescriptor(
   return { descriptor, errors }
 }
 
-export function getPrevDescriptor(filename: string) {
+export function getPrevDescriptor(filename: string): SFCDescriptor | undefined {
   return prevCache.get(filename)
 }
 
-export function setPrevDescriptor(filename: string, entry: SFCDescriptor) {
+export function setPrevDescriptor(
+  filename: string,
+  entry: SFCDescriptor
+): void {
   prevCache.set(filename, entry)
 }
 
-export function getDescriptor(filename: string, errorOnMissing = true) {
+export function getDescriptor(
+  filename: string,
+  errorOnMissing = true
+): SFCDescriptor | undefined {
   if (cache.has(filename)) {
     return cache.get(filename)!
   }
@@ -46,6 +58,6 @@ export function getDescriptor(filename: string, errorOnMissing = true) {
   }
 }
 
-export function setDescriptor(filename: string, entry: SFCDescriptor) {
+export function setDescriptor(filename: string, entry: SFCDescriptor): void {
   cache.set(filename, entry)
 }
diff --git a/packages/plugin-vue/src/utils/query.ts b/packages/plugin-vue/src/utils/query.ts
@@ -9,7 +9,9 @@ export interface VueQuery {
   raw?: boolean
 }
 
-export function parseVueRequest(id: string) {
+export function parseVueRequest(
+  id: string
+): { filename: string; query: VueQuery } {
   const [filename, rawQuery] = id.split(`?`, 2)
   const query = qs.parse(rawQuery) as VueQuery
   if (query.vue != null) {

diff --git a/packages/vite/src/client/client.ts b/packages/vite/src/client/client.ts
@@ -201,7 +201,7 @@ const supportsConstructedSheet = (() => {
 
 const sheetsMap = new Map()
 
-export function updateStyle(id: string, content: string) {
+export function updateStyle(id: string, content: string): void {
   let style = sheetsMap.get(id)
   if (supportsConstructedSheet && !content.includes('@import')) {
     if (style && !(style instanceof CSSStyleSheet)) {
@@ -235,7 +235,7 @@ export function updateStyle(id: string, content: string) {
   sheetsMap.set(id, style)
 }
 
-export function removeStyle(id: string) {
+export function removeStyle(id: string): void {
   const style = sheetsMap.get(id)
   if (style) {
     if (style instanceof CSSStyleSheet) {
@@ -334,6 +334,8 @@ const ctxToListenersMap = new Map<
   Map<string, ((customData: any) => void)[]>
 >()
 
+// Just infer the return type for now
+// _This would have to be activated when used `plugin:@typescript-eslint/recommended`_ eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
 export const createHotContext = (ownerPath: string) => {
   if (!dataMap.has(ownerPath)) {
     dataMap.set(ownerPath, {})
@@ -436,7 +438,7 @@ export const createHotContext = (ownerPath: string) => {
 /**
  * urls here are dynamic import() urls that couldn't be statically analyzed
  */
-export function injectQuery(url: string, queryToInject: string) {
+export function injectQuery(url: string, queryToInject: string): string {
   // skip urls that won't be handled by vite
   if (!url.startsWith('.') && !url.startsWith('/')) {
     return url

diff --git a/packages/vite/src/client/overlay.ts b/packages/vite/src/client/overlay.ts
@@ -151,7 +151,7 @@ export class ErrorOverlay extends HTMLElement {
     })
   }
 
-  text(selector: string, text: string, linkFiles = false) {
+  text(selector: string, text: string, linkFiles = false): void {
     const el = this.root.querySelector(selector)!
     if (!linkFiles) {
       el.textContent = text
@@ -176,7 +176,7 @@ export class ErrorOverlay extends HTMLElement {
     }
   }
 
-  close() {
+  close(): void {
     this.parentNode?.removeChild(this)
   }
 }

diff --git a/packages/vite/src/node/build.ts b/packages/vite/src/node/build.ts
@@ -637,7 +637,7 @@ export function onRollupWarning(
   warning: RollupWarning,
   warn: WarningHandler,
   config: ResolvedConfig
-) {
+): void {
   if (warning.code === 'UNRESOLVED_IMPORT') {
     const id = warning.source
     const importer = warning.importer

diff --git a/packages/vite/src/node/config.ts b/packages/vite/src/node/config.ts
@@ -798,7 +798,11 @@ async function loadConfigFromBundledFile(
   return config
 }
 
-export function loadEnv(mode: string, root: string, prefix = 'VITE_') {
+export function loadEnv(
+  mode: string,
+  root: string,
+  prefix = 'VITE_'
+): Record<string, string> {
   if (mode === 'local') {
     throw new Error(
       `"local" cannot be used as a mode name because it conflicts with ` +

diff --git a/packages/vite/src/node/optimizer/registerMissing.ts b/packages/vite/src/node/optimizer/registerMissing.ts
@@ -9,7 +9,9 @@ import { resolveSSRExternal } from '../ssr/ssrExternal'
  */
 const debounceMs = 100
 
-export function createMissingImporterRegisterFn(server: ViteDevServer) {
+export function createMissingImporterRegisterFn(
+  server: ViteDevServer
+): (id: string, resolved: string) => void {
   const { logger } = server.config
   let knownOptimized = server._optimizeDepsMetadata!.optimized
   let currentMissing: Record<string, string> = {}

diff --git a/packages/vite/src/node/optimizer/scan.ts b/packages/vite/src/node/optimizer/scan.ts
@@ -417,7 +417,10 @@ async function transformGlob(
   return s.toString()
 }
 
-export function shouldExternalizeDep(resolvedId: string, rawId: string) {
+export function shouldExternalizeDep(
+  resolvedId: string,
+  rawId: string
+): boolean {
   // not a valid file path
   if (!path.isAbsolute(resolvedId)) {
     return true
@@ -430,4 +433,5 @@ export function shouldExternalizeDep(resolvedId: string, rawId: string) {
   if (!JS_TYPES_RE.test(resolvedId) && !htmlTypesRE.test(resolvedId)) {
     return true
   }
+  return false
 }
diff --git a/packages/vite/src/node/plugins/asset.ts b/packages/vite/src/node/plugins/asset.ts
@@ -102,7 +102,7 @@ export function assetPlugin(config: ResolvedConfig): Plugin {
   }
 }
 
-export function registerAssetToChunk(chunk: RenderedChunk, file: string) {
+export function registerAssetToChunk(chunk: RenderedChunk, file: string): void {
   let emitted = chunkToEmittedAssetsMap.get(chunk)
   if (!emitted) {
     emitted = new Set()
@@ -132,7 +132,7 @@ export function fileToUrl(
   id: string,
   config: ResolvedConfig,
   ctx: PluginContext
-) {
+): string | Promise<string> {
   if (config.command === 'serve') {
     return fileToDevUrl(id, config)
   } else {
@@ -163,7 +163,10 @@ const assetHashToFilenameMap = new WeakMap<
   Map<string, string>
 >()
 
-export function getAssetFilename(hash: string, config: ResolvedConfig) {
+export function getAssetFilename(
+  hash: string,
+  config: ResolvedConfig
+): string | undefined {
   return assetHashToFilenameMap.get(config)?.get(hash)
 }
 

diff --git a/packages/vite/src/node/plugins/css.ts b/packages/vite/src/node/plugins/css.ts
@@ -97,10 +97,10 @@ const enum PureCssLang {
 }
 type CssLang = keyof typeof PureCssLang | keyof typeof PreprocessLang
 
-export const isCSSRequest = (request: string) =>
+export const isCSSRequest = (request: string): boolean =>
   cssLangRE.test(request) && !directRequestRE.test(request)
 
-export const isDirectCSSRequest = (request: string) =>
+export const isDirectCSSRequest = (request: string): boolean =>
   cssLangRE.test(request) && directRequestRE.test(request)
 
 const cssModulesCache = new WeakMap<

diff --git a/packages/vite/src/node/plugins/html.ts b/packages/vite/src/node/plugins/html.ts
@@ -29,7 +29,7 @@ import {
 } from '@vue/compiler-dom'
 
 const htmlProxyRE = /\?html-proxy&index=(\d+)\.js$/
-export const isHTMLProxy = (id: string) => htmlProxyRE.test(id)
+export const isHTMLProxy = (id: string): boolean => htmlProxyRE.test(id)
 
 const htmlCommentRE = /<!--[\s\S]*?-->/g
 const scriptModuleRE = /(<script\b[^>]*type\s*=\s*(?:"module"|'module')[^>]*>)(.*?)<\/script>/gims
@@ -79,7 +79,7 @@ export async function traverseHtml(
   html: string,
   filePath: string,
   visitor: NodeTransform
-) {
+): Promise<void> {
   // lazy load compiler
   const { parse, transform } = await import('@vue/compiler-dom')
   // @vue/compiler-core doesn't like lowercase doctypes
@@ -101,7 +101,12 @@ export async function traverseHtml(
   }
 }
 
-export function getScriptInfo(node: ElementNode) {
+export function getScriptInfo(
+  node: ElementNode
+): {
+  src: AttributeNode | undefined
+  isModule: boolean
+} {
   let src: AttributeNode | undefined
   let isModule = false
   for (let i = 0; i < node.props.length; i++) {
@@ -440,7 +445,9 @@ export type IndexHtmlTransform =
       transform: IndexHtmlTransformHook
     }
 
-export function resolveHtmlTransforms(plugins: readonly Plugin[]) {
+export function resolveHtmlTransforms(
+  plugins: readonly Plugin[]
+): [IndexHtmlTransformHook[], IndexHtmlTransformHook[]] {
   const preHooks: IndexHtmlTransformHook[] = []
   const postHooks: IndexHtmlTransformHook[] = []
 

diff --git a/packages/vite/src/node/preview.ts b/packages/vite/src/node/preview.ts
@@ -11,7 +11,10 @@ import { openBrowser } from './server/openBrowser'
 import corsMiddleware from 'cors'
 import { proxyMiddleware } from './server/middlewares/proxy'
 
-export async function preview(config: ResolvedConfig, port = 5000) {
+export async function preview(
+  config: ResolvedConfig,
+  port = 5000
+): Promise<void> {
   const app = connect() as Connect.Server
   const httpServer = await resolveHttpServer(config.server, app)
 

diff --git a/packages/vite/src/node/server/hmr.ts b/packages/vite/src/node/server/hmr.ts
@@ -164,7 +164,7 @@ export async function handleFileAddUnlink(
   file: string,
   server: ViteDevServer,
   isUnlink = false
-) {
+): Promise<void> {
   const modules = [...(server.moduleGraph.getModulesByFile(file) ?? [])]
   if (isUnlink && file in server._globImporters) {
     delete server._globImporters[file]
@@ -247,7 +247,7 @@ function invalidate(mod: ModuleNode, timestamp: number, seen: Set<ModuleNode>) {
 export function handlePrunedModules(
   mods: Set<ModuleNode>,
   { ws }: ViteDevServer
-) {
+): void {
   // update the disposed modules' hmr timestamp
   // since if it's re-imported, it should re-apply side effects
   // and without the timestamp the browser will not re-import it!

diff --git a/packages/vite/src/node/server/http.ts b/packages/vite/src/node/server/http.ts
@@ -30,7 +30,9 @@ export async function resolveHttpServer(
   }
 }
 
-export async function resolveHttpsConfig(httpsOption: HttpsServerOptions) {
+export async function resolveHttpsConfig(
+  httpsOption: HttpsServerOptions
+): Promise<HttpsServerOptions> {
   const { ca, cert, key, pfx } = httpsOption
   Object.assign(httpsOption, {
     ca: readFileIfExists(ca),

diff --git a/packages/vite/src/node/server/middlewares/error.ts b/packages/vite/src/node/server/middlewares/error.ts
@@ -24,7 +24,7 @@ export function buildErrorMessage(
   err: RollupError,
   args: string[] = [],
   includeStack = true
-) {
+): string {
   if (err.plugin) args.push(`  Plugin: ${chalk.magenta(err.plugin)}`)
   if (err.id) args.push(`  File: ${chalk.cyan(err.id)}`)
   if (err.frame) args.push(chalk.yellow(pad(err.frame)))

diff --git a/packages/vite/src/node/server/middlewares/indexHtml.ts b/packages/vite/src/node/server/middlewares/indexHtml.ts
@@ -16,7 +16,9 @@ import { CLIENT_PUBLIC_PATH, FS_PREFIX } from '../../constants'
 import { cleanUrl, fsPathFromId } from '../../utils'
 import { assetAttrsConfig } from '../../plugins/html'
 
-export function createDevHtmlTransformFn(server: ViteDevServer) {
+export function createDevHtmlTransformFn(
+  server: ViteDevServer
+): (url: string, html: string) => Promise<string> {
   const [preHooks, postHooks] = resolveHtmlTransforms(server.config.plugins)
 
   return (url: string, html: string): Promise<string> => {