Composer - 使用本地仓库

63

我是一名Composer初学者,正在尝试使一个项目依赖于另一个项目,而这两个项目都只存在于我的本地机器上。

我的库项目(ProjectA)中的composer.json文件如下:

{
    "name" : "project/util",
    "type" : "library"
}

我在这个项目的根目录中初始化了git。

我的composer.json依赖于第一个项目(ProjectB):

{
    "repositories": [
        {
            "name" : "util", 
            "type" : "git",
            "url" : "/d/workspaces/util"
        }   
    ],

    "require": {
        "project/util" : "*"
    },
}

当我从ProjectB运行composer install时,我会得到以下错误:

[RuntimeException]
Failed to clone , could not read packages from it
fatal: repository '' does not exist
我认为存储库的URL有问题,但我不确定还应该写什么。
7个回答

64

使用Composer自动加载本地包(无需每次更改都到Packagist网站)。

有很多方法可以做到这一点,我将介绍其中的两种:

在所有情况下,我们都有两个主要方面:
- 本地包(我们不想发布到Packagist以便在我们的项目Composer中自动加载其代码)。
- 主项目(需要使用本地包代码的代码库,可以是另一个包或任何项目)。


方法1:(直接命名空间)

打开主项目的composer.json文件,并使用任何方法(PSR-4、PSR-0等)自动加载本地包命名空间。

例如:

如果在本地包的composer.json中我们有:

  "autoload": {
    "psr-4": {
      “Local\\Pack\\": "library"
    }
  },
  "autoload-dev": {
    "psr-4": {
      "Local\\Pack\\Tests\\": "tests"
    }
  },

那么在主项目的composer.json文件中,我们应该有:

  "autoload": {
    "psr-4": {
      "Mahmoudz\\Project\\": "src",
      "Local\\Pack\\": "../path/to/local/pack/library”                   << referencing the other local package
    }
  },
  "autoload-dev": {
    "psr-4": {
      "Mahmoudz\\Project\\Tests\\": "tests"
    }
  },

优点:
- 您不会触及供应商目录(通过错误运行composer update不会覆盖您的本地更改)
- 您不需要将您的包放在packagist上就可以使用它
- 您只需在一个地方工作(本地包),更改将自动加载到主项目中
缺点:
- 您无法在生产环境上发布composer.json文件(在发布之前需要进行编辑以要求真正的包)

方法2:(本地仓库)

从本地仓库下载本地包。

本地包:
1. 在包中初始化git(即使您不想使用它-无需提交任何内容)
2. 添加composer.json文件。 在文件中确保具有以下内容:

"name": "vendor-name/package-name",  

"autoload": {    // use whichever method you prefer, but make sure it’s being loaded correctly

"minimum-stability": "dev"  
  1. composer dump-autoload

主项目:
1. 编辑您的composer.json文件,并包含以下内容:

  "repositories": [
    {
      "type": "vcs",
      "url": "/full/path/to/the/local/package/package-name"
    }
  ],
  "require": {
    "vendor-name/package-name": "dev-master"
  },
  1. composer update vendor-name/package-name
  2. 现在检查一下你的 vendor 目录,你应该能看到 vendor-name/package-name

注意:每当您更改本地软件包(而不是供应商)时,您需要进行 git 提交,然后才能 composer update 主项目,这将使主项目的供应商目录获得存储库的最新副本。

优点:
- 您不会触及供应商目录(由于错误运行 composer update 不会覆盖您的本地更改) - 您无需将软件包放在 packagist 上即可使用它
缺点:
- 您必须继续提交更改(在本地软件包中),然后在主项目中运行 composer update
- 您不能在生产环境中发布 composer.json(发布之前需要编辑以要求真实软件包)


7
谢谢,太棒了!注:如果你使用_vcs_方法(#2),不要忘记提交你的composer.json更改。很容易忘记,然后你会想知道为什么composer会弹出“找不到包版本”的错误。 - mangonights
第二种方法相比第一种的另一个优点是代码对IDE的可访问性,以进行代码完成。 - nibra
1
我使用了第二种方法,但是出现了以下错误: 在任何分支或标签中都没有找到有效的composer.json文件,因此无法从中加载包。 为了解决这个问题,我采用了@mangonights的回复,并将更改提交到了我的本地存储库,这解决了我的问题。 - Gandalf
1
方法1在开发生产力方面真的非常棒,因为我不必浪费时间执行“composer update”命令。然而,Composer自动加载器无法很好地处理传递依赖项。换句话说,如果“ProjectA”依赖于“ProjectB”,后者又依赖于“ProjectC”,那么除非我在ProjectA的composer.json文件中明确指定“ProjectA”依赖于“ProjectB/ProjectC”,否则方法1实际上并不起作用。但是,如果你有20多个小项目,这种方法并不可扩展。自动加载器管理变成了噩梦。@Mahmoud,你有什么想法吗? - Miroslav Dzhokanov
在解决方案2中,我注意到主项目的composer.json文件有一个require: { "vendor/package": "dev-master" }。我尝试使用require: { "vendor/package": "1.2.0" },但似乎Composer不够智能,无法读取我本地Git存储库中的本地标签(尚未推送到origin)。我觉得这很令人沮丧。 - cartbeforehorse
显示剩余4条评论

24

我认为你只是语法写错了。类型应该只是VCS,然后composer会确定它是哪种类型的VCS。

因此,在你的B项目中,repositories的条目应该是:

"repositories": [
    {
        "type": "vcs",
        "url" : "/d/workspaces/util"
    }
],

你不需要命名位于/d/workspaces/util中可用的库。Composer将扫描该目录中的composer.json文件,并知道那里有哪些项目名称,并优先使用该目录中的项目,而不是列在packagist或其他存储库中的版本。


好的,当我切换到vcs时,我收到了这个消息:[运行时异常]目录不存在:/d/workspaces/util - Banana
3
那么,可能目录不存在或无法访问? - Danack
3
我认为目录名称只是拼写错误了。你确定要将其提供为/d/workspaces/util而不是d:/workspaces/util吗? - Vladislav Rastrusny
它需要如何提供? - Miguel Stevens

11

这将创建一个符号链接。 - Supun Kavinda

6
我发现这篇教程非常有用:https://johannespichler.com/developing-composer-packages-locally/。在我面临本地包生产问题时,它很有帮助。
请注意symlink条件,允许vendor文件夹成为符号链接,这意味着每次想要看到更改时您不再需要运行composer update
"options": {
        "symlink": true
      }

4
除了Danack的解决方案之外:将路径从/d/更改为d:/对我有用。
像这样:

"repositories": [
    {
        "type": "vcs",
        "url" : "d:/workspaces/util"
    }
],

0

注意:本答案假定您拥有类似包注册表或GIT存储库的东西,可以从中检索软件包的版本。如果您还没有这个,请参考https://getcomposer.org/doc/05-repositories.md

Composer使我们能够自动加载本地开发包,而不会污染composer.lock文件。当Composer在两个或多个软件包之间发现冲突时,它将仅自动加载其中一个软件包。

您可以使用autoload-dev来自动加载特定的开发文件夹。(https://getcomposer.org/doc/04-schema.md#autoload-dev

autoload-dev(和autoload)设置不会影响composer.lock文件

在您的项目composer.json文件中:

"repositories": {
    "99999999": {
        "type": "composer",
        "url": "https://gitlab.com/api/v4/group/99999999/-/packages/composer/packages.json"
    }
}
"require": {
    "a-vendor-name/test-package": "1.0.*"
}, 
"autoload-dev": {
    "classmap": [
        "./../../packages/a-vendor-name/test-package"
    ],
    "exclude-from-classmap": [
        "vendor/a-vendor-name/test-package"
    ]
}

在这个例子中,packages目录位于项目根目录之外,并包含其自己的包GIT存储库。
使用autoload-dev,因为我们只想在开发时加载此文件夹。(https://getcomposer.org/doc/04-schema.md#autoload-dev
使用classmap从本地目录加载软件包。(https://getcomposer.org/doc/04-schema.md#classmap
使用exclude-from-classmap禁用在vendor目录中加载包。还将抑制有关具有相同命名空间的多个类的警告。(https://getcomposer.org/doc/04-schema.md#exclude-files-from-classmaps
运行DEVELOPMENT(默认行为):
composer update a-vendor-name/test-package // or any other composer command 

您的软件包仍将从您的软件包注册表下载。这个下载的软件包不仅在您的应用程序代码中被忽略,而且还可以根据项目composer.json文件进行更新。这将以正确的方式更新composer.lock文件。

使用--no-dev标志运行DTAP / PRODUCTION

composer update a-vendor-name/test-package --no-dev // or any other composer command 

0
除了 @Glen Solsberry 的解决方案之外,如果你像我一样在 Docker 容器中运行,你可以在你的 docker-compose.yml 文件中添加一个卷,例如:
services:
  theservicename:
    ...
    volumes:
      - ../:/var/www
      - /path/to/src/package:/var/www/vendor/path/to/src/package
    ...

当您在本地进行更改时,它们将反映在容器中。


网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接