chore: rename package-manager to extension-manager

flarum · Jan 10, 2024 · 76cfa48 · 76cfa48
1 parent a5b3d97
commit 76cfa48
Show file tree

Hide file tree

Showing 113 changed files with 583 additions and 490 deletions.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Sami Mazouz
+Copyright (c) 2024 Stichting Flarum (Flarum Foundation)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# Package Manager
+# Extension Manager
 
-The package manager is a tool that allows you to easily install and manage extensions. It runs [composer](https://getcomposer.org/) under the hood.
+The extension manager is a tool that allows you to easily install and manage extensions. It runs [composer](https://getcomposer.org/) under the hood.
 
 ## Security
 
@@ -10,9 +10,9 @@ This extension is optional and can be removed for those who prefer to manually m
 
 ## Troubleshooting
 
-If you have many extensions installed, you may run into memory issues when using the package manager. If this happens, you can use an asynchronous queue that will run the package manager in the background.
+If you have many extensions installed, you may run into memory issues when using the extension manager. If this happens, you can use an asynchronous queue that will run the extension manager in the background.
 
 * Simple database queue guide: https://discuss.flarum.org/d/28151-database-queue-the-simplest-queue-even-for-shared-hosting
 * (Advanced) Redis queue: https://discuss.flarum.org/d/21873-redis-sessions-cache-queues
 
-You can find detailed logs on the package manager operations in the `storage/logs/composer` directory. Please include the latest log file when reporting issues in the [Flarum support forum](https://discuss.flarum.org/t/support).
+You can find detailed logs on the extension manager operations in the `storage/logs/composer` directory. Please include the latest log file when reporting issues in the [Flarum support forum](https://discuss.flarum.org/t/support).
diff --git a/composer.json b/composer.json
@@ -1,6 +1,6 @@
 {
-    "name": "flarum/package-manager",
-    "description": "A Flarum Package Manager.",
+    "name": "flarum/extension-manager",
+    "description": "An extension manager to install, update and remove extension packages from the interface (Wrapper around composer).",
     "keywords": [
         "extensions",
         "composer",
@@ -18,8 +18,8 @@
         }
     ],
     "support": {
-        "issues": "https://github.com/flarum/package-manager/issues",
-        "source": "https://github.com/flarum/package-manager"
+        "issues": "https://github.com/flarum/framework/issues",
+        "source": "https://github.com/flarum/extension-manager"
     },
     "require": {
         "flarum/core": "^1.8",
@@ -31,7 +31,7 @@
     },
     "extra": {
         "flarum-extension": {
-            "title": "Package Manager",
+            "title": "Extension Manager",
             "icon": {
                 "name": "fas fa-box-open",
                 "backgroundColor": "#117187",
@@ -69,12 +69,12 @@
     },
     "autoload": {
         "psr-4": {
-            "Flarum\\PackageManager\\": "src/"
+            "Flarum\\ExtensionManager\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "Flarum\\PackageManager\\Tests\\": "tests/"
+            "Flarum\\ExtensionManager\\Tests\\": "tests/"
         }
     },
     "scripts": {

diff --git a/extend.php b/extend.php
@@ -7,7 +7,7 @@
  * LICENSE file that was distributed with this source code.
  */
 
-namespace Flarum\PackageManager;
+namespace Flarum\ExtensionManager;
 
 use Flarum\Extend;
 use Flarum\Foundation\Paths;
@@ -17,43 +17,43 @@
 
 return [
     (new Extend\Routes('api'))
-        ->post('/package-manager/extensions', 'package-manager.extensions.require', Api\Controller\RequireExtensionController::class)
-        ->patch('/package-manager/extensions/{id}', 'package-manager.extensions.update', Api\Controller\UpdateExtensionController::class)
-        ->delete('/package-manager/extensions/{id}', 'package-manager.extensions.remove', Api\Controller\RemoveExtensionController::class)
-        ->post('/package-manager/check-for-updates', 'package-manager.check-for-updates', Api\Controller\CheckForUpdatesController::class)
-        ->post('/package-manager/why-not', 'package-manager.why-not', Api\Controller\WhyNotController::class)
-        ->post('/package-manager/minor-update', 'package-manager.minor-update', Api\Controller\MinorUpdateController::class)
-        ->post('/package-manager/major-update', 'package-manager.major-update', Api\Controller\MajorUpdateController::class)
-        ->post('/package-manager/global-update', 'package-manager.global-update', Api\Controller\GlobalUpdateController::class)
-        ->get('/package-manager-tasks', 'package-manager.tasks.index', Api\Controller\ListTasksController::class)
-        ->post('/package-manager/composer', 'package-manager.composer', Api\Controller\ConfigureComposerController::class),
+        ->post('/extension-manager/extensions', 'extension-manager.extensions.require', Api\Controller\RequireExtensionController::class)
+        ->patch('/extension-manager/extensions/{id}', 'extension-manager.extensions.update', Api\Controller\UpdateExtensionController::class)
+        ->delete('/extension-manager/extensions/{id}', 'extension-manager.extensions.remove', Api\Controller\RemoveExtensionController::class)
+        ->post('/extension-manager/check-for-updates', 'extension-manager.check-for-updates', Api\Controller\CheckForUpdatesController::class)
+        ->post('/extension-manager/why-not', 'extension-manager.why-not', Api\Controller\WhyNotController::class)
+        ->post('/extension-manager/minor-update', 'extension-manager.minor-update', Api\Controller\MinorUpdateController::class)
+        ->post('/extension-manager/major-update', 'extension-manager.major-update', Api\Controller\MajorUpdateController::class)
+        ->post('/extension-manager/global-update', 'extension-manager.global-update', Api\Controller\GlobalUpdateController::class)
+        ->get('/extension-manager-tasks', 'extension-manager.tasks.index', Api\Controller\ListTasksController::class)
+        ->post('/extension-manager/composer', 'extension-manager.composer', Api\Controller\ConfigureComposerController::class),
 
     (new Extend\Frontend('admin'))
         ->css(__DIR__.'/less/admin.less')
         ->js(__DIR__.'/js/dist/admin.js')
         ->content(function (Document $document) {
             $paths = resolve(Paths::class);
 
-            $document->payload['flarum-package-manager.writable_dirs'] = is_writable($paths->vendor)
+            $document->payload['flarum-extension-manager.writable_dirs'] = is_writable($paths->vendor)
                 && is_writable($paths->storage)
                 && (! file_exists($paths->storage.'/.composer') || is_writable($paths->storage.'/.composer'))
                 && is_writable($paths->base.'/composer.json')
                 && is_writable($paths->base.'/composer.lock');
 
-            $document->payload['flarum-package-manager.using_sync_queue'] = resolve(Queue::class) instanceof SyncQueue;
+            $document->payload['flarum-extension-manager.using_sync_queue'] = resolve(Queue::class) instanceof SyncQueue;
         }),
 
     new Extend\Locales(__DIR__.'/locale'),
 
     (new Extend\Settings())
         ->default(Settings\LastUpdateCheck::key(), json_encode(Settings\LastUpdateCheck::default()))
         ->default(Settings\LastUpdateRun::key(), json_encode(Settings\LastUpdateRun::default()))
-        ->default('flarum-package-manager.queue_jobs', false)
-        ->default('flarum-package-manager.minimum_stability', 'stable')
-        ->default('flarum-package-manager.task_retention_days', 7),
+        ->default('flarum-extension-manager.queue_jobs', '0')
+        ->default('flarum-extension-manager.minimum_stability', 'stable')
+        ->default('flarum-extension-manager.task_retention_days', 7),
 
     (new Extend\ServiceProvider)
-        ->register(PackageManagerServiceProvider::class),
+        ->register(ExtensionManagerServiceProvider::class),
 
     (new Extend\ErrorHandling)
         ->handler(Exception\ComposerCommandFailedException::class, Exception\ExceptionHandler::class)

diff --git a/js/dist-typings/states/ControlSectionState.d.ts b/js/dist-typings/states/ControlSectionState.d.ts
diff --git a/...t-typings/states/PackageManagerState.d.ts → ...typings/states/ExtensionManagerState.d.ts b/...t-typings/states/PackageManagerState.d.ts → ...typings/states/ExtensionManagerState.d.ts
diff --git a/js/dist-typings/states/QueueState.d.ts b/js/dist-typings/states/QueueState.d.ts
diff --git a/js/dist/admin.js b/js/dist/admin.js
diff --git a/js/dist/admin.js.map b/js/dist/admin.js.map
diff --git a/js/package.json b/js/package.json
@@ -1,5 +1,5 @@
 {
-    "name": "@flarum/package-manager",
+    "name": "@flarum/extension-manager",
     "version": "0.0.0",
     "private": true,
     "prettier": "@flarum/prettier-config",

diff --git a/js/src/admin/components/AuthMethodModal.tsx b/js/src/admin/components/AuthMethodModal.tsx
@@ -32,40 +32,40 @@ export default class AuthMethodModal<CustomAttrs extends IAuthMethodModalAttrs =
 
   title(): Mithril.Children {
     const context = this.attrs.host ? 'edit' : 'add';
-    return app.translator.trans(`flarum-package-manager.admin.auth_config.${context}_label`);
+    return app.translator.trans(`flarum-extension-manager.admin.auth_config.${context}_label`);
   }
 
   content(): Mithril.Children {
     const types = {
-      'github-oauth': app.translator.trans('flarum-package-manager.admin.auth_config.types.github-oauth'),
-      'gitlab-oauth': app.translator.trans('flarum-package-manager.admin.auth_config.types.gitlab-oauth'),
-      'gitlab-token': app.translator.trans('flarum-package-manager.admin.auth_config.types.gitlab-token'),
-      bearer: app.translator.trans('flarum-package-manager.admin.auth_config.types.bearer'),
+      'github-oauth': app.translator.trans('flarum-extension-manager.admin.auth_config.types.github-oauth'),
+      'gitlab-oauth': app.translator.trans('flarum-extension-manager.admin.auth_config.types.gitlab-oauth'),
+      'gitlab-token': app.translator.trans('flarum-extension-manager.admin.auth_config.types.gitlab-token'),
+      bearer: app.translator.trans('flarum-extension-manager.admin.auth_config.types.bearer'),
     };
 
     return (
       <div className="Modal-body">
         <div className="Form-group">
-          <label>{app.translator.trans('flarum-package-manager.admin.auth_config.add_modal.type_label')}</label>
+          <label>{app.translator.trans('flarum-extension-manager.admin.auth_config.add_modal.type_label')}</label>
           <Select options={types} value={this.type()} onchange={this.type} />
         </div>
         <div className="Form-group">
-          <label>{app.translator.trans('flarum-package-manager.admin.auth_config.add_modal.host_label')}</label>
+          <label>{app.translator.trans('flarum-extension-manager.admin.auth_config.add_modal.host_label')}</label>
           <input
             className="FormControl"
             bidi={this.host}
-            placeholder={app.translator.trans('flarum-package-manager.admin.auth_config.add_modal.host_placeholder')}
+            placeholder={app.translator.trans('flarum-extension-manager.admin.auth_config.add_modal.host_placeholder')}
           />
         </div>
         <div className="Form-group">
-          <label>{app.translator.trans('flarum-package-manager.admin.auth_config.add_modal.token_label')}</label>
+          <label>{app.translator.trans('flarum-extension-manager.admin.auth_config.add_modal.token_label')}</label>
           <textarea
             className="FormControl"
             oninput={(e: InputEvent) => this.token((e.target as HTMLTextAreaElement).value)}
             rows="6"
             placeholder={
               this.token().startsWith('unchanged:')
-                ? extractText(app.translator.trans('flarum-package-manager.admin.auth_config.add_modal.unchanged_token_placeholder'))
+                ? extractText(app.translator.trans('flarum-extension-manager.admin.auth_config.add_modal.unchanged_token_placeholder'))
                 : ''
             }
           >
@@ -74,7 +74,7 @@ export default class AuthMethodModal<CustomAttrs extends IAuthMethodModalAttrs =
         </div>
         <div className="Form-group">
           <Button className="Button Button--primary" onclick={this.submit.bind(this)}>
-            {app.translator.trans('flarum-package-manager.admin.auth_config.add_modal.submit_button')}
+            {app.translator.trans('flarum-extension-manager.admin.auth_config.add_modal.submit_button')}
           </Button>
         </div>
       </div>

diff --git a/js/src/admin/components/ConfigureAuth.tsx b/js/src/admin/components/ConfigureAuth.tsx
@@ -9,7 +9,7 @@ export default class ConfigureAuth extends ConfigureJson<IConfigureJson> {
   protected type = 'auth';
 
   title(): Mithril.Children {
-    return app.translator.trans('flarum-package-manager.admin.auth_config.title');
+    return app.translator.trans('flarum-extension-manager.admin.auth_config.title');
   }
 
   className(): string {
@@ -27,14 +27,14 @@ export default class ConfigureAuth extends ConfigureJson<IConfigureJson> {
       });
 
     return (
-      <div className="SettingsGroups-content">
+      <div className="ExtensionManager-SettingsGroups-content">
         {hasAuthSettings ? (
           authSettings.map((type) => {
             const hosts = this.settings[type]();
 
             return (
               <div className="Form-group">
-                <label>{app.translator.trans(`flarum-package-manager.admin.auth_config.types.${type}`)}</label>
+                <label>{app.translator.trans(`flarum-extension-manager.admin.auth_config.types.${type}`)}</label>
                 <div className="ConfigureAuth-hosts">
                   {Object.keys(hosts).map((host) => {
                     const data = hosts[host] as string | Record<string, string>;
@@ -58,9 +58,9 @@ export default class ConfigureAuth extends ConfigureJson<IConfigureJson> {
                         <Button
                           className="Button Button--icon"
                           icon="fas fa-trash"
-                          aria-label={app.translator.trans('flarum-package-manager.admin.auth_config.delete_label')}
+                          aria-label={app.translator.trans('flarum-extension-manager.admin.auth_config.delete_label')}
                           onclick={() => {
-                            if (confirm(extractText(app.translator.trans('flarum-package-manager.admin.auth_config.delete_confirmation')))) {
+                            if (confirm(extractText(app.translator.trans('flarum-extension-manager.admin.auth_config.delete_confirmation')))) {
                               const newType = { ...this.setting(type)() };
                               delete newType[host];
 
@@ -80,7 +80,7 @@ export default class ConfigureAuth extends ConfigureJson<IConfigureJson> {
             );
           })
         ) : (
-          <span className="helpText">{app.translator.trans('flarum-package-manager.admin.auth_config.no_auth_methods_configured')}</span>
+          <span className="helpText">{app.translator.trans('flarum-extension-manager.admin.auth_config.no_auth_methods_configured')}</span>
         )}
       </div>
     );
@@ -99,7 +99,7 @@ export default class ConfigureAuth extends ConfigureJson<IConfigureJson> {
           })
         }
       >
-        {app.translator.trans('flarum-package-manager.admin.auth_config.add_label')}
+        {app.translator.trans('flarum-extension-manager.admin.auth_config.add_label')}
       </Button>
     );
 

diff --git a/js/src/admin/components/ConfigureComposer.tsx b/js/src/admin/components/ConfigureComposer.tsx
@@ -14,7 +14,7 @@ export default class ConfigureComposer extends ConfigureJson<IConfigureJson> {
   protected type = 'composer';
 
   title(): Mithril.Children {
-    return app.translator.trans('flarum-package-manager.admin.composer.title');
+    return app.translator.trans('flarum-extension-manager.admin.composer.title');
   }
 
   className(): string {
@@ -23,23 +23,23 @@ export default class ConfigureComposer extends ConfigureJson<IConfigureJson> {
 
   content(): Mithril.Children {
     return (
-      <div className="SettingsGroups-content">
+      <div className="ExtensionManager-SettingsGroups-content">
         {this.attrs.buildSettingComponent.call(this, {
           setting: 'minimum-stability',
-          label: app.translator.trans('flarum-package-manager.admin.composer.minimum_stability.label'),
-          help: app.translator.trans('flarum-package-manager.admin.composer.minimum_stability.help'),
+          label: app.translator.trans('flarum-extension-manager.admin.composer.minimum_stability.label'),
+          help: app.translator.trans('flarum-extension-manager.admin.composer.minimum_stability.help'),
           type: 'select',
           options: {
-            stable: app.translator.trans('flarum-package-manager.admin.composer.minimum_stability.options.stable'),
-            RC: app.translator.trans('flarum-package-manager.admin.composer.minimum_stability.options.rc'),
-            beta: app.translator.trans('flarum-package-manager.admin.composer.minimum_stability.options.beta'),
-            alpha: app.translator.trans('flarum-package-manager.admin.composer.minimum_stability.options.alpha'),
-            dev: app.translator.trans('flarum-package-manager.admin.composer.minimum_stability.options.dev'),
+            stable: app.translator.trans('flarum-extension-manager.admin.composer.minimum_stability.options.stable'),
+            RC: app.translator.trans('flarum-extension-manager.admin.composer.minimum_stability.options.rc'),
+            beta: app.translator.trans('flarum-extension-manager.admin.composer.minimum_stability.options.beta'),
+            alpha: app.translator.trans('flarum-extension-manager.admin.composer.minimum_stability.options.alpha'),
+            dev: app.translator.trans('flarum-extension-manager.admin.composer.minimum_stability.options.dev'),
           },
         })}
         <div className="Form-group">
-          <label>{app.translator.trans('flarum-package-manager.admin.composer.repositories.label')}</label>
-          <div className="helpText">{app.translator.trans('flarum-package-manager.admin.composer.repositories.help')}</div>
+          <label>{app.translator.trans('flarum-extension-manager.admin.composer.repositories.label')}</label>
+          <div className="helpText">{app.translator.trans('flarum-extension-manager.admin.composer.repositories.help')}</div>
           <div className="ConfigureComposer-repositories">
             {Object.keys(this.setting('repositories')() || {}).map((name) => {
               const repository = this.setting('repositories')()[name] as Repository;
@@ -75,9 +75,9 @@ export default class ConfigureComposer extends ConfigureJson<IConfigureJson> {
                   <Button
                     className="Button Button--icon"
                     icon="fas fa-trash"
-                    aria-label={app.translator.trans('flarum-package-manager.admin.composer.delete_repository_label')}
+                    aria-label={app.translator.trans('flarum-extension-manager.admin.composer.delete_repository_label')}
                     onclick={() => {
-                      if (confirm(extractText(app.translator.trans('flarum-package-manager.admin.composer.delete_repository_confirmation')))) {
+                      if (confirm(extractText(app.translator.trans('flarum-extension-manager.admin.composer.delete_repository_confirmation')))) {
                         const repositories = { ...this.setting('repositories')() };
                         delete repositories[name];
 
@@ -99,7 +99,7 @@ export default class ConfigureComposer extends ConfigureJson<IConfigureJson> {
 
     items.push(
       <Button className="Button" onclick={() => app.modal.show(RepositoryModal, { onsubmit: this.onchange.bind(this) })}>
-        {app.translator.trans('flarum-package-manager.admin.composer.add_repository_label')}
+        {app.translator.trans('flarum-extension-manager.admin.composer.add_repository_label')}
       </Button>
     );