Composer - 使用本地存储库

时间:2013-07-02 12:54:34

标签: git composer-php

我是一名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 个答案:

答案 0 :(得分:37)

使用作曲家自动加载本地包(每次更改时都不会打包)。

有很多方法可以做到,我将覆盖其中两个:

在所有情况下,我们都有两个主要方:
  - 本地软件包(我们不想在packagist上发布的代码,以便能够在我们的项目编写器中自动加载它)。
  - 主项目(需要使用本地包代码的代码库,可以是另一个包和/或任何项目)。

Methode 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不会覆盖你的本地更改)
- 你不需要你的包裹在包装上使用它 - 您在一个地方(本地包)工作,更改将自动加载到主项目中 的缺点:
- 您无法在生产中发布composer.json(需要在发布之前进行编辑以要求真正的包)

Methode 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
  2. 主要项目:
     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-name / package-name
    3. 注意:每当你在本地软件包(而不是供应商)中进行更改时,你需要git commit然后你可以编写者更新主项目,它将获得repo的最新副本到主项目供应商目录。

      <强>优势:
      - 你没有触及供应商目录(错误地运行编辑器更新不会覆盖你的本地更改) - 你不需要你的包装在包装上来使用它 的缺点:
      - 您必须继续提交更改(在本地包中),然后在主项目中运行composer update - 您无法在生产中发布composer.json(需要在发布之前进行编辑以要求真正的包)

答案 1 :(得分:23)

我认为你的语法错误了。该类型应该只是VCS,然后作曲家会计算出它是什么类型的VCS。

因此,在项目B中,存储库的条目应为:

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

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

答案 2 :(得分:4)

最简单的方法是使用type = path https://getcomposer.org/doc/05-repositories.md#path

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

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

}

答案 3 :(得分:2)

除了Danack的解决方案:改变路径从/ d /到d:/为我工作。

像这样:

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

答案 4 :(得分:2)

我发现本教程非常有用:https://johannespichler.com/developing-composer-packages-locally/当我遇到本地软件包生产问题时

请注意symlink条件,允许将供应商文件夹作为符号链接,这意味着您不再需要每次查看更改都需要composer update

"options": {
        "symlink": true
      }

答案 5 :(得分: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 禁用在供应商目录中加载包。 还将抑制有关具有相同命名空间的多个类的警告。 (https://getcomposer.org/doc/04-schema.md#exclude-files-from-classmaps)

运行开发(默认行为):

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 

答案 6 :(得分:0)

除了@Glen Solsberry 的解决方案,如果你像我一样在 docker 容器中运行,你可以在你的 docker-compose.yml 文件中添加一个卷,如:

services:
  theservicename:
    ...
    volumes:
      - ../:/var/www
      - /path/to/src/package:/var/www/vendor/path/to/src/package
    ...

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