feat: new disabled setting

Author: antfu

locales/en.json

@@ -40,6 +40,7 @@
   "config.derived_keys": "Rules to mark derived keys in the usage report",
   "config.dir_structure": "Preferred directory structure to organize locale files",
   "config.disable_path_parsing": "Disable path resolution",
+  "config.disabled": "Disable i18n Ally for the project",
   "config.display_language": "Displaying language",
   "config.editor_prefer_editor": "Prefer to use webview editor for locale editing.",
   "config.enabled_frameworks": "Specify the supported framework(s) to enable. If no value is set, the extension will detect frameworks automatically.",

package.json

@@ -654,6 +654,11 @@
       "type": "object",
       "title": "%extname%",
       "properties": {
+        "i18n-ally.disabled": {
+          "type": "boolean",
+          "default": false,
+          "description": "%config.disabled%"
+        },
         "i18n-ally.localesPaths": {
           "type": [
             "string",

src/core/Config.ts

@@ -11,6 +11,7 @@ import { ExtractionHTMLOptions } from '~/extraction/parsers/options'
 
 export class Config {
   static readonly reloadConfigs = [
+    'disabled',
     'localesPaths',
     'pathMatcher',
     'includeSubfolders',
@@ -45,6 +46,10 @@ export class Config {
   static ctx: ExtensionContext
   static readonly debug = process.env.NODE_ENV === 'development'
 
+  static get disabled() {
+    return Config.getConfig<boolean>('disabled') ?? true
+  }
+
   // languages
   static get displayLanguage(): string {
     return this.normalizeLocale(Config.getConfig<string>('displayLanguage') || '')

src/core/Global.ts

@@ -38,10 +38,10 @@ export class Global {
   static async init(context: ExtensionContext) {
     this.context = context
 
-    context.subscriptions.push(workspace.onDidChangeWorkspaceFolders(e => this.updateRootPath()))
-    context.subscriptions.push(window.onDidChangeActiveTextEditor(e => this.updateRootPath()))
-    context.subscriptions.push(workspace.onDidOpenTextDocument(e => this.updateRootPath()))
-    context.subscriptions.push(workspace.onDidCloseTextDocument(e => this.updateRootPath()))
+    context.subscriptions.push(workspace.onDidChangeWorkspaceFolders(() => this.updateRootPath()))
+    context.subscriptions.push(window.onDidChangeActiveTextEditor(() => this.updateRootPath()))
+    context.subscriptions.push(workspace.onDidOpenTextDocument(() => this.updateRootPath()))
+    context.subscriptions.push(workspace.onDidCloseTextDocument(() => this.updateRootPath()))
     context.subscriptions.push(workspace.onDidChangeConfiguration(e => this.update(e)))
     await this.updateRootPath()
   }
@@ -169,7 +169,7 @@ export class Global {
       .flatMap(f => [
         f.supportedExts,
         Object.entries(Config.parsersExtendFileExtensions)
-          .find(([k, v]) => v === f.id)?.[0],
+          .find(([, v]) => v === f.id)?.[0],
       ])
       .filter(Boolean)
       .join('|')
@@ -323,9 +323,9 @@ export class Global {
       const frameworks = Config.enabledFrameworks
       this.enabledFrameworks = getEnabledFrameworksByIds(frameworks, this._rootpath)
     }
-    const isValidProject = this.enabledFrameworks.length > 0
+    const isValidProject = this.enabledFrameworks.length > 0 && this.enabledParsers.length > 0
     const hasLocalesSet = Global.localesPaths.length > 0
-    const shouldEnabled = isValidProject && hasLocalesSet
+    const shouldEnabled = !Config.disabled && isValidProject && hasLocalesSet
     this.setEnabled(shouldEnabled)
 
     if (this.enabled) {
@@ -335,13 +335,15 @@ export class Global {
       await this.initLoader(this._rootpath, reload)
     }
     else {
-      if (!isValidProject)
-        Log.info('⚠ Current workspace is not a valid project, extension disabled')
-      else if (!hasLocalesSet)
-        Log.info('⚠ No locales path setting found, extension disabled')
-
-      if (isValidProject && !hasLocalesSet)
-        ConfigLocalesGuide.autoSet()
+      if (!Config.disabled) {
+        if (!isValidProject)
+          Log.info('⚠ Current workspace is not a valid project, extension disabled')
+        else if (!hasLocalesSet)
+          Log.info('⚠ No locales path setting found, extension disabled')
+
+        if (isValidProject && !hasLocalesSet)
+          ConfigLocalesGuide.autoSet()
+      }
 
       this.unloadAll()
     }