qa: suggest laminas/laminas-cli so that the CLI commands can be con…

…sumed This also marks the existing CLI commands as internal as these are not meant to be instantiated from any project. Signed-off-by: Maximilian Bösing <[email protected]>
laminas · Mar 30, 2023 · 7bd2668 · 7bd2668
1 parent 0fe2d78
commit 7bd2668
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 8 deletions.
diff --git a/composer.json b/composer.json
@@ -65,6 +65,7 @@
         "zendframework/zend-code": "<3.3.1"
     },
     "suggest": {
+        "laminas/laminas-cli": "To consume CLI commands provided by this component",
         "ocramius/proxy-manager": "ProxyManager ^2.1.1 to handle lazy initialization of services"
     },
     "autoload": {

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -48,18 +48,14 @@
         </InvalidThrow>
         <InternalClass>
             <errorLevel type="suppress">
-                <referencedClass name="Laminas\ServiceManager\Tool\FactoryCreator"/>
-                <referencedClass name="Laminas\ServiceManager\Tool\ConfigDumper"/>
+                <!-- Tests are allowed to work with internal classes -->
+                <directory name="test"/>
             </errorLevel>
         </InternalClass>
         <InternalMethod>
             <errorLevel type="suppress">
-                <referencedMethod name="Laminas\ServiceManager\Tool\FactoryCreator::createFactory"/>
-                <referencedMethod name="Laminas\ServiceManager\Tool\ConfigDumper::createDependencyConfig"/>
-                <referencedMethod name="Laminas\ServiceManager\Tool\ConfigDumper::dumpConfigFile"/>
-                <referencedMethod name="Laminas\ServiceManager\Tool\ConfigDumper::createFactoryMappingsFromConfig"/>
-                <referencedMethod name="Laminas\ServiceManager\Tool\ConfigDumper::createFactoryMappings"/>
-                <referencedMethod name="Laminas\ServiceManager\Tool\ConfigDumper::__construct"/>
+                <!-- Tests are allowed to work with internal classes -->
+                <directory name="test"/>
             </errorLevel>
         </InternalMethod>
     </issueHandlers>

diff --git a/src/Command/ConfigDumperCommand.php b/src/Command/ConfigDumperCommand.php
@@ -25,6 +25,9 @@
 use function is_writable;
 use function sprintf;
 
+/**
+ * @internal CLI commands are not meant to be used in any upstream projects other than via `laminas-cli`.
+ */
 final class ConfigDumperCommand extends Command
 {
     public const NAME = 'servicemanager:generate-deps-for-config-factory';

diff --git a/src/Command/FactoryCreatorCommand.php b/src/Command/FactoryCreatorCommand.php
@@ -17,6 +17,9 @@
 use function is_string;
 use function sprintf;
 
+/**
+ * @internal CLI commands are not meant to be used in any upstream projects other than via `laminas-cli`.
+ */
 final class FactoryCreatorCommand extends Command
 {
     public const NAME = 'servicemanager:generate-factory-for-class';