refactor: rename the option to tsSyntaxInTemplates

Author: haoqunjiang

README.md

@@ -68,7 +68,7 @@ configureVueProject({
   // Setting it to `false` could improve performance.
   // But TypeScript syntax in Vue templates will then lead to syntax errors.
   // Also, type-aware rules won't be applied to expressions in templates in that case.
-  tsInTemplates: true,
+  tsSyntaxInTemplates: true,
 
   // Optional: specify the script langs in `.vue` files
   // Defaults to `['ts']`.

examples/disable-ts-in-templates/eslint.config.js

@@ -6,7 +6,7 @@ import {
 } from '@vue/eslint-config-typescript'
 
 configureVueProject({
-  tsInTemplates: false,
+  tsSyntaxInTemplates: false,
 })
 
 export default defineConfigWithVueTs(

src/internals.ts

@@ -32,7 +32,7 @@ export const additionalRulesRequiringParserServices = [
 ]
 
 export function createBasicSetupConfigs(
-  tsInTemplates: boolean,
+  tsSyntaxInTemplates: boolean,
   scriptLangs: ScriptLang[],
 ): ConfigArray {
   const mayHaveJsxInSfc =
@@ -53,7 +53,7 @@ export function createBasicSetupConfigs(
 
   // If the user explicitly opts out of parsing TypeScript syntax in Vue templates,
   // force using `espree` for the template parser for better performance.
-  if (!tsInTemplates) {
+  if (!tsSyntaxInTemplates) {
     parser['<template>'] = 'espree'
   }
 

src/utilities.ts

@@ -27,7 +27,7 @@ export type ProjectOptions = {
    * But TypeScript syntax in Vue templates will then lead to syntax errors.
    * Also, type-aware rules won't be applied to expressions in templates in that case.
    */
-  tsInTemplates?: boolean
+  tsSyntaxInTemplates?: boolean
 
   /**
    * Allowed script languages in `vue` files.
@@ -43,16 +43,16 @@ export type ProjectOptions = {
 }
 
 let projectOptions: ProjectOptions = {
-  tsInTemplates: true,
+  tsSyntaxInTemplates: true,
   scriptLangs: ['ts'],
   rootDir: process.cwd(),
 }
 
 // This function, if called, is guaranteed to be executed before `defineConfigWithVueTs`,
 // so mutating the `projectOptions` object is safe and will be reflected in the final ESLint config.
 export function configureVueProject(userOptions: ProjectOptions): void {
-  if (userOptions.tsInTemplates !== undefined) {
-    projectOptions.tsInTemplates = userOptions.tsInTemplates
+  if (userOptions.tsSyntaxInTemplates !== undefined) {
+    projectOptions.tsSyntaxInTemplates = userOptions.tsSyntaxInTemplates
   }
   if (userOptions.scriptLangs) {
     projectOptions.scriptLangs = userOptions.scriptLangs
@@ -127,7 +127,7 @@ function insertAndReorderConfigs(
 
   return [
     ...configsWithoutTypeAwareRules.slice(0, lastExtendedConfigIndex + 1),
-    ...createBasicSetupConfigs(projectOptions.tsInTemplates!, projectOptions.scriptLangs!),
+    ...createBasicSetupConfigs(projectOptions.tsSyntaxInTemplates!, projectOptions.scriptLangs!),
 
     // user-turned-off type-aware rules must come after the last extended config
     // in case some rules re-enabled by the extended config