Làm thế nào để bỏ qua các thư mục với Composer?

Question

Tôi muốn phát hành một thư viện PHP và gửi nó trên Packagist để có thể cài đặt qua Composer.

Thư viện của tôi có cấu trúc sau:

lib/ 
tests/ 
composer.json 
README.md 

Về cơ bản, bất cứ khi nào tôi bao gồm thư viện này trong một dự án của composer.json, tôi muốn tất cả mọi thứ được sao chép với ngoại lệ của thư mục tests, đó là cồng kềnh và chỉ cần thiết khi phát triển thư viện. Nó chỉ là một sự lãng phí không gian khác (đặc biệt là khi đóng gói dự án cho sản xuất).

Có thể loại trừ thư mục này khỏi thư viện composer.json của thư viện không?

Answer 1

Điều này là không thể trong Composer. Tuy nhiên, có một số cách để làm điều đó:

• Khi bạn chạy các bản cập nhật hoặc cài đặt lệnh với --prefer-dist, Composer cố gắng để tải về lưu trữ trên github. Bạn có thể loại bỏ các thư mục kiểm tra từ các tài liệu lưu trữ bằng cách đặt này trong một file .gitattributes trong thư mục gốc của dự án của bạn:

  Tests/ export-ignore 
  

• Composer sẽ chỉ sử dụng các thẻ trên github. Chỉ cần tạm thời xóa thư mục kiểm tra khi tạo thẻ cũng sẽ thực hiện thủ thuật.

Answer 2

này đã có thể kể từ 11 Tháng Mười Một 2015 với https://getcomposer.org/doc/04-schema.md#exclude-files-from-classmaps

Nguồn: https://github.com/composer/composer/issues/4456#issuecomment-155825777

EDIT: hiểu sai. Ở trên chỉ cho phép trình nạp tự động bỏ qua các đường dẫn được chỉ định, nó không thực sự ngăn cản chúng được sao chép vào hệ thống tập tin khi cài đặt.

Answer 3

Có thể kiểm soát việc tạo lưu trữ bằng cách thêm mẫu loại trừ trong tệp composer.json trong khóa archive. Xem https://getcomposer.org/doc/04-schema.md#archive để biết chi tiết.

Ví dụ nhất định (trích dẫn từ trên URL):

{ 
    "archive": { 
     "exclude": ["/foo/bar", "baz", "/*.test", "!/foo/bar/baz"] 
    } 
} 

Ví dụ sẽ bao gồm /dir/foo/bar/file, /foo/bar/baz, /file.php, /foo/my.test nhưng nó sẽ loại trừ /foo/bar/any, /foo/baz, và /my.test.

Bằng cách đó bạn có về cùng một điều khiển mà .gitattributes sẽ cung cấp cho bạn, mà không cần phải sử dụng Git hoặc ảnh hưởng đến bất kỳ quy trình đòi hỏi cài đặt khác nhau trong cho biết tập tin.