Migrate glpi-project/tools to core #22465

froozeify · 2025-12-22T15:41:18Z

Checklist before requesting a review

Please delete options that are not relevant.

I have read the CONTRIBUTING document.
I have performed a self-review of my code.
I have added tests that prove my fix is effective or that my feature works.
This change requires a documentation update.

Description

Migrate https://github.com/glpi-project/tools into the core with also a converted python/bash scripts so all are runned as Symfony Command.

Doing that migration will avoid the dependencies exception libraries could have when they were requiring a different glpi-project/tools

For the future we could put glpi-project/tools as archived but we can't remove it from packagist as plugin supporting prior to GLPI 11.0.5 version would have to still install that library.

It's can be release in 11.0.5 as it was currently only a dev dependencies, so in worth case if the user try to run a command it will just not work.
It will force local dev env to be up to date (or at least be in 11.0.5-dev)

Template https://github.com/pluginsGLPI/empty should also be updated to remove that composer dependency once this PR is merged.

TODOs

LicenceHeadersCheck
CompileTwigTemplate
ExtractLocals (migrate this to /tools not /tools/plugins ???)
PluginRelease
~~PHPStan Rules~~ (already present in core MissingGlobalVarTypeRule)

What was done

Migrate LicenceHeadersCheckCommand.php and CompileTwigTemplatesCommand.php (no major edit - namespace and print changes)
Convert plugin-release python file to PHP
Convert extract-local bash file to PHP

Interconnected PR (merge order) :

Whatsapp plugin got a dedicated PR to test the modification (see in the feed under for the link)

AdrienClairembault

I think you'll need to rebase and update the header (2026)

tools/src/Command/AbstractCommand.php

tools/src/Command/CompileTwigTemplatesCommand.php

AdrienClairembault · 2026-01-05T08:20:43Z

tools/src/Command/CompileTwigTemplatesCommand.php

+
+class CompileTwigTemplatesCommand extends AbstractCommand
+{
+    protected const ALLOW_PLUGIN_OPTION = 1;


Suggested change

protected const ALLOW_PLUGIN_OPTION = 1;

protected const ALLOW_PLUGIN_OPTION = true;

This make me realize that the tool folder is not linted (at least not by phpstan), maybe we should change that?
Can be done in a separate PR.

tools/src/Command/CompileTwigTemplatesCommand.php

AdrienClairembault · 2026-01-05T08:26:42Z

tools/src/Command/ExtractLocalesCommand.php

+            $compile_input = new ArrayInput($options);
+            $compile_cmd->run($compile_input, $this->output);
+
+            $this->io->writeln("<question>Extracting translations from files</question>");


This doesn't seem like a question. Maybe it should be info instead?

I had set it up as question so it was blue background (screenshot top is question bottom is info) and was more like a section title for the progress bar

AdrienClairembault · 2026-01-05T08:28:42Z

tools/src/Command/ExtractLocalesCommand.php

+                    $args['F_ARGS_X'],
+                    $args['F_ARGS_NX']
+                );
+                system($cmd);


Maybe we could use symfony/process? I think its already required by GLPI's core.

tools/src/Command/LicenceHeadersCheckCommand.php

tools/src/Plugin/Command/PluginReleaseCommand.php

tools/src/Command/LicenceHeadersCheckCommand.php

…s a shadow dep)

…no header warning

…even if empty

cedric-anne · 2026-01-05T13:27:09Z

PluginsMakefile.mk


 locales-compile: ## Compile locales
-	@$(PLUGIN) vendor/bin/plugin-release --compile-mo
+	@$(CONSOLE) tools:plugin:release --compile-mo --plugin=$(PLUGIN_DIR)


IMHO, it is not necessary to maintain 2 distinct levels of commands. We will probably never have more than 10 commands in the tools "namespace".

Suggested change

@$(CONSOLE) tools:plugin:release --compile-mo --plugin=$(PLUGIN_DIR)

@$(CONSOLE) tools:plugin_release --compile-mo --plugin=$(PLUGIN_DIR)

cedric-anne · 2026-01-05T13:28:29Z

package.json

        "typescript": "^5.9.3",
-        "vue": "^3.5.26"
+        "vue": "^3.5.26",
+        "vue3-gettext": "^4.0.0-beta.1"


IMHO, it should be moved into the dev dependencies.

cedric-anne · 2026-01-05T13:56:12Z

src/Glpi/Console/CommandLoader.php

Changes made to this file should not be necessary once #22568 will be merged.

cedric-anne · 2026-01-05T14:00:05Z

tools/src/Command/AbstractCommand.php

+    /** @var bool Declare the command has supporting plugging. */
+    protected const ALLOW_PLUGIN_OPTION = false;
+
+    /** @var bool Declare the command supporting plugging and require it to be set. */
+    protected const REQUIRE_PLUGIN_OPTION = false;


It is preferable to use methods for this. For instance

abstract protected function isPluginOptionAvailable(): bool;

cedric-anne · 2026-01-05T14:03:34Z

tools/src/Command/AbstractCommand.php

+            $this->addOption(
+                'plugin',
+                'p',
+                InputOption::VALUE_REQUIRED,


This does not make the option mandatory, it just make its value required. bin/console tools:command_name and bin/console tools:command_name --plugin=XXX will be valid usages.

cedric-anne · 2026-01-05T14:22:34Z

tools/src/Plugin/Command/PluginReleaseCommand.php

+        // Propose version
+        if ($input->getOption('propose')) {
+            $this->proposeVersion();
+            return Command::SUCCESS;
+        }


This is useless, I think noone uses it. We can remove this feature.

cedric-anne · 2026-01-05T14:25:30Z

tools/src/Plugin/Command/PluginReleaseCommand.php

+        // Release or Check-Only
+        $release_version = $input->getOption('release');
+        $input_commit = $input->getOption('commit');
+        $extra = $input->getOption('extra');
+
+        if (($extra || $input_commit) && (!$extra || !$input_commit || !$release_version)) {
+            $this->io->error('You have to specify --release, --commit and --extra all together');
+            return Command::FAILURE;
+        }
+
+        if ($release_version) {
+            if (!$input->getOption('dont-check')) {
+                if (!$this->validVersion($release_version)) {
+                    $this->io->error(sprintf('%s is not a valid version number!', $release_version));
+                    return Command::FAILURE;
+                }
+
+                if (!$this->checkVersion($release_version)) {
+                    return Command::FAILURE;
+                }
+            }
+
+            if ($input_commit) {
+                if (!$this->validCommit($input_commit)) {
+                    $this->io->error(sprintf('Invalid commit ref %s', $input_commit));
+                    return Command::FAILURE;
+                }
+            } elseif (!$this->isExistingVersion($release_version)) {
+                $this->io->error(sprintf('Tag %s does not exist!', $release_version));
+                return Command::FAILURE;
+            }
+        } else {
+            // If no release version specified, use latest version
+            $release_version = $this->getLatestVersion();
+            if (!$release_version) {
+                $this->io->error('No tags found in the repository.');
+                return Command::FAILURE;
+            }
+
+            if ($input->getOption('force')) {
+                // Force mode, proceed directly
+            } else {
+                if (!$this->io->confirm(sprintf('Do you want to build version %s?', $release_version), true)) {
+                    return Command::SUCCESS;
+                }
+            }
+        }


IMHO, we should only use the version provided by the plugin_xxx_init() function. There is no need to have a such complex way to compute the release version name.

cedric-anne · 2026-01-05T14:26:19Z

tools/src/Plugin/Command/PluginReleaseCommand.php

+        if ($input->getOption('check-only')) {
+            $this->io->note('*** Entering *check-only* mode ***');
+            $this->io->success('Check-only mode finished.');
+            return Command::SUCCESS;
+        }


I am not sure this is usefull if we simplify the other parts of the script.

cedric-anne · 2026-01-05T14:27:23Z

tools/src/Plugin/Command/PluginReleaseCommand.php

+        if (!$input->getOption('nogithub')) {
+            $this->createGithubRelease($release_version, $input_commit, $tarball);
+        }


This is useless now. We have automatize it using Github workflows.

cedric-anne · 2026-01-05T14:28:23Z

tools/src/Plugin/Command/PluginReleaseCommand.php

+        // Sign
+        if (!$input->getOption('nosign')) {
+            $this->sign($tarball);
+        }


@trasher Is the plugin release archive GPG sign still used?

It's never been used on GLPI as far as I remember.

More globally, the python release script has been made for another project of mine; and it's just been quickly adapted to suit GLPI plugins. Many "features" have never been used, and are probably useless.

froozeify force-pushed the 11.0/migrate-glpi-project-tools branch from b0d64a4 to 4aa5600 Compare December 31, 2025 08:18

This was referenced Dec 31, 2025

Fix common dependencies check exception when composer.json has no dependencies glpi-project/plugin-ci-workflows#50

Draft

Remove glpi tools dep pluginsGLPI/empty#57

Draft

froozeify requested review from AdrienClairembault, cedric-anne and trasher December 31, 2025 14:48

froozeify marked this pull request as ready for review December 31, 2025 14:48

AdrienClairembault reviewed Jan 5, 2026

View reviewed changes

froozeify added 22 commits January 5, 2026 09:55

chore: remove glpi-project/tools dependency

06c807b

feat: register plugins tools into Command and PluginMakefile

578f621

chore: migrate tools code to glpi core

4a9653d

feat: switch to AbstractPlugin

d0132cc

chore: Migrate plugin_release to php

d156efd

style: fix missing licence headers

8f3d410

chore: Migrate plugin_release to php

f8c5bb2

feat: update licence-header check to be in core tools

e3a9cb5

feat: update licence-header check to be in core tools

b803fb3

feat: update licence-header check to be in core tools

fe0d23e

fix: broken headers

f5c2566

style: fix missing @return

c12edb6

style: fix wrong namespace

6a846b9

feat: remove PHPStan rule already present in core

06546a9

feat: CompileTwigTemplates to core

7cb8d6e

feat: Migrate ExtractLocales to core

e63ed40

feat: Plugin release command

8339511

chore: simply composer autoload for plugin command

7f7876d

chore: remove useless alias

1a5dea6

chore: rename Licence header check to match the other GLPI commands

efa4ebb

feat: migrate tools to core

d0ff413

chore: add sf/finder and sf/process as dev dependencies (currently wa…

2a83ff5

…s a shadow dep)

froozeify added 17 commits January 5, 2026 09:55

feat: migrate tools to core

e510933

chore: add missing override

f47c853

feat(license-header-check): Add support for disable license header

a979bfe

test(license-header-check): Update test

985604c

style: code quality

0a5342e

style: code quality

c9e8d2e

feat: migrate tools to core

4ab1ee1

feat: migrate tools to core

46f13a5

deps: add gettext as js dependencies for vue

f9329c5

feat: extract locales from vue files

d41f56a

feat(licence-header-check): change gettext config to start with . so …

7073b6d

…no header warning

style: code quality

340b4c2

test: add command tests

a4ff5bc

style: add missing headers

bcd854b

style: code quality

0ca9c1b

test: recreate picture dir since some tests require it to be present …

a22f7f1

…even if empty

feat: add vue3-gettext as dependencies

5554081

froozeify force-pushed the 11.0/migrate-glpi-project-tools branch from 657aa2b to 5554081 Compare January 5, 2026 08:59

froozeify added 5 commits January 5, 2026 10:15

fix: typo in isPluginCommand name

631caed

rebase too violent

c5bc961

fix: int instead of bool value on command settings

6369eb0

chore: make commands final

b698540

style: new year licence headers update

2be45f2

cedric-anne added the task label Jan 5, 2026

cedric-anne added this to the 11.0.5 milestone Jan 5, 2026

feat: Switch extract local to use Symfony Proccess instead of system()

b82e036

cedric-anne mentioned this pull request Jan 5, 2026

Make tools command compliant with PSR-4 autoloading #22568

Merged

4 tasks

cedric-anne requested changes Jan 5, 2026

View reviewed changes

	protected const ALLOW_PLUGIN_OPTION = 1;
	protected const ALLOW_PLUGIN_OPTION = true;

	@$(CONSOLE) tools:plugin:release --compile-mo --plugin=$(PLUGIN_DIR)
	@$(CONSOLE) tools:plugin_release --compile-mo --plugin=$(PLUGIN_DIR)

Uh oh!

Migrate glpi-project/tools to core #22465

Are you sure you want to change the base?

Migrate glpi-project/tools to core #22465

Conversation

froozeify commented Dec 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist before requesting a review

Description

TODOs

What was done

Interconnected PR (merge order) :

Uh oh!

AdrienClairembault left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

trasher Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

froozeify commented Dec 22, 2025 •

edited

Loading

trasher Jan 5, 2026 •

edited

Loading