Merge pull request #31 from abgox/module

feat(module): update version to 5.0.0
abgox · Aug 30, 2024 · 8e2c9f2 · 8e2c9f2
2 parents 27e8173 + ac2bab9
commit 8e2c9f2
Show file tree

Hide file tree

Showing 15 changed files with 1,749 additions and 1,561 deletions.
diff --git a/module/CHANGELOG-CN.md b/module/CHANGELOG-CN.md
@@ -3,6 +3,26 @@
     <a href="./CHANGELOG-CN.md">简体中文</a>
 </p>
 
+## 5.0.0 (2024/8/30)
+
+- 减少文件 I/O 操作，优化初始化方法，提升首次加载速度。
+  - 移除每个补全目录下的 **alias.txt** 文件，使用 **data.json** 文件存储数据。
+- 将配置数据文件 **config.json** 合并到 **data.json** 中。
+  - 注意: 如果使用了 scoop 去安装 `PSCompletions`，请检查应用清单(manifest)中的 persist 是否更新为 **data.json**。
+- 修改了几乎所有配置项的名称。
+
+  - 配置项名称的修改，不影响正常使用，在更新版本后，也会自动迁移旧的配置项到新的配置项。
+  - 比如:
+    - `update` => `enable_completions_update`
+    - `module_update` => `enable_module_update`
+    - `menu_show_tip` => `enable_tip`
+    - ...
+
+- 移除了两个配置项: `github` 和 `gitee`。
+  - 如果需要自定义地址，请使用 `url` 配置项。
+  - `psc config url <url>`
+- 其他的优化和修复。
+
 ## 4.3.3 (2024/8/27)
 
 - 当启用 `menu_is_prefix_match` 时，公共前缀提取后的输入可能会导致错误，现在已修复

diff --git a/module/CHANGELOG.json b/module/CHANGELOG.json
@@ -1,4 +1,45 @@
 [
+  {
+    "version": "5.0.0",
+    "info": {
+      "zh-CN": [
+        "更新(2024/8/30)\n",
+        "- 减少文件 I/O 操作，优化初始化方法，提升首次加载速度。\n",
+        "  - 移除每个补全目录下的 alias.txt 文件，使用 data.json 文件存储数据。\n",
+        "- 将配置数据文件 config.json 合并到 data.json 中。\n",
+        "  - 注意: 如果使用了 scoop 去安装 <@Magenta>PSCompletions<@Blue>，请检查应用清单(manifest)中的 persist 是否更新为 data.json。\n",
+        "- 修改了几乎所有配置项的名称。\n",
+        "  - 配置项名称的修改，不影响正常使用，在更新版本后，也会自动迁移旧的配置项到新的配置项。\n",
+        "  - 比如:\n",
+        "    - <@Magenta>update<@Blue> => <@Magenta>enable_completions_update<@Blue>\n",
+        "    - <@Magenta>module_update<@Blue> => <@Magenta>enable_module_update<@Blue>\n",
+        "    - <@Magenta>menu_show_tip<@Blue> => <@Magenta>enable_tip<@Blue>\n",
+        "    - ...\n",
+        "- 移除了两个配置项: <@Magenta>github<@Blue> 和 <@Magenta>gitee<@Blue>。\n",
+        "  - 如果需要自定义地址，请使用 <@Magenta>url<@Blue> 配置项。\n",
+        "  - <@Magenta>psc config url <url><@Blue>\n",
+        "- 其他的优化和修复。\n"
+      ],
+      "en-US": [
+        "Update(2024/8/30)\n",
+        "- Reduce file I/O operations and optimize initialization method to improve first load speed.\n",
+        "  - Remove the alias.txt file in each completion directory, and use data.json to store data.\n",
+        "- Merge configuration data file config.json into data.json.\n",
+        "  - Note: If you use scoop to install <@Magenta>PSCompletions<@Blue>, please check the manifest (persist) to update to data.json.\n",
+        "- Modify the name of almost all configuration items.\n",
+        "  - The name of the configuration item has been modified, and it will not affect normal use. When the version is updated, it will automatically migrate the old configuration item to the new configuration item.\n",
+        "  - For example:\n",
+        "    - <@Magenta>update<@Blue> => <@Magenta>enable_completions_update<@Blue>\n",
+        "    - <@Magenta>module_update<@Blue> => <@Magenta>enable_module_update<@Blue>\n",
+        "    - <@Magenta>menu_show_tip<@Blue> => <@Magenta>enable_tip<@Blue>\n",
+        "    - ...\n",
+        "- Remove two configuration items: <@Magenta>github<@Blue> and <@Magenta>gitee<@Blue>.\n",
+        "  - If you need to customize the url, please use the <@Magenta>url<@Blue> configuration item.\n",
+        "  - <@Magenta>psc config url <url><@Blue>\n",
+        "- Other optimizations and fixes.\n"
+      ]
+    }
+  },
   {
     "version": "4.3.3",
     "info": {

diff --git a/module/CHANGELOG.md b/module/CHANGELOG.md
@@ -3,6 +3,24 @@
     <a href="./CHANGELOG.md">English</a>
 </p>
 
+## 5.0.0 (2024/8/30)
+
+- Reduce file I/O operations and optimize initialization method to improve first load speed.
+  - Remove the **alias.txt** file in each completion directory, and use **data.json** to store data.
+- Merge configuration data file **config.json** into **data.json**.
+  - Note: If you use scoop to install `PSCompletions`, please check the manifest (persist) to update to **data.json**.
+- Modify the name of almost all configuration items.
+  - The name of the configuration item has been modified, and it will not affect normal use. When the version is updated, it will automatically migrate the old configuration item to the new configuration item.
+  - For example:
+    - `update` => `enable_completions_update`
+    - `module_update` => `enable_module_update`
+    - `menu_show_tip` => `enable_tip`
+    - ...
+- Remove two configuration items: `github` and `gitee`.
+  - If you need to customize the url, please use the `url` configuration item.
+  - `psc config url <url>`
+- Other optimizations and fixes.
+
 ## 4.3.3 (2024/8/27)
 
 - Fix an error that occurred when `menu_is_prefix_match` was enabled, due to the input after public prefix extraction.

diff --git a/module/PSCompletions/PSCompletions.psd1 b/module/PSCompletions/PSCompletions.psd1
@@ -7,29 +7,41 @@
 #
 
 @{
+    RootModule           = 'PSCompletions.psm1'
 
-    RootModule       = 'PSCompletions.psm1'
+    ModuleVersion        = '5.0.0'
 
-    ModuleVersion    = '4.3.3'
+    GUID                 = '00929632-527d-4dab-a5b3-21197faccd05'
 
-    GUID             = '00929632-527d-4dab-a5b3-21197faccd05'
+    Author               = 'abgox'
 
-    Author           = 'abgox'
+    Copyright            = 'Copyright (c) 2023-present abgox. All Rights Reserved.'
 
-    Copyright        = '(c) abgox. All rights reserved.'
+    PowerShellVersion    = '5.1'
 
-    Description      = 'A completion manager for better and simpler use powershell completions. For more information, please visit the project or website: https://github.com/abgox/PSCompletions | https://gitee.com/abgox/PSCompletions | https://pscompletions.pages.dev'
-    ScriptsToProcess = 'core\init.ps1'
+    CompatiblePSEditions = @('Core', 'Desktop')
 
-    PrivateData      = @{
+    HelpInfoUri          = 'https://pscompletions.pages.dev'
+
+    Description          = 'A completion manager for better and simpler use PowerShell completions.
+ For more information, please visit the project or website:
+  - https://github.com/abgox/PSCompletions
+  - https://gitee.com/abgox/PSCompletions
+  - https://pscompletions.pages.dev'
+
+    ScriptsToProcess     = 'core\init.ps1'
+
+    PrivateData          = @{
 
         PSData = @{
 
-            Tags       = @('PowerShell', 'pwsh', 'Tab', 'PS-Completions', 'Dynamic', 'Multi-language', 'base-in-json' , 'Completion-Manager', 'TabExpansion2')
+            Tags         = @('Tab', 'Completion', 'Prompt', 'TabExpansion', 'Completions', 'Dynamic', 'Multi-Language', 'Base-in-json', 'Completion-Manager', 'TabExpansion2', 'PowerShell', 'pwsh', 'PSEdition_Core', 'PSEdition_Desktop', 'Windows', 'Linux', 'MacOS')
+
+            LicenseUri   = 'https://github.com/abgox/PSCompletions/blob/main/LICENSE'
 
-            LicenseUri = 'https://github.com/abgox/PSCompletions/blob/main/LICENSE'
+            ProjectUri   = 'https://github.com/abgox/PSCompletions'
 
-            ProjectUri = 'https://github.com/abgox/PSCompletions'
+            ReleaseNotes = 'https://github.com/abgox/PSCompletions/blob/main/module/CHANGELOG.md'
 
         }