Cấu trúc ưa thích của dự án Magento 2 theo VCS là gì?

Khi tôi bắt đầu một dự án M2 mới, điều đầu tiên tôi sẽ làm là cài đặt lõi thông qua trình soạn thảo:

composer create-project --repository-url=https://repo.magento.com/ magento/project-community-edition

Bây giờ tôi có thể viết (các) mô-đun tùy chỉnh và chủ đề của mình bên dưới app/code. Sau đó tôi sẽ thêm thư mục của tôi composer.*và toàn bộ app/codevào VCS của tôi. Cho đến nay mọi thứ đều ổn.

Giả sử bây giờ tôi muốn sử dụng một số công cụ xây dựng cho dự án của mình, giả sử Grunt hoặc Gulp.

1. Nếu tôi cam kết Gruntfile.js, cái này sẽ bị ghi đè bởi magento/magento2-basegói khi tôi chạy composer installsau khi tôi nhân bản repo.

2. Nếu tôi cam kết gulpfile.js, tôi thực sự không thể xác định các phụ thuộc của mình trong một package.json, bởi vì nó cũng sẽ bị ghi đè bởi magento/magento2-base.

3. Nếu tôi quyết định sử dụng thiết lập Grunt của Magento và muốn tùy chỉnh nó bằng cách chỉnh sửa các tệp trong /dev/tools/grunt(ví dụ themes.js), tôi không thể vì những thay đổi của tôi sẽ bị ghi đè bởi magento/magento2-base.

Tôi hiểu rằng bạn thực sự không thể làm gì nhiều trong tài liệu gốc của bạn. Tất nhiên có rất nhiều giải pháp cho vấn đề này:

• Tôi có thể chạy git checkout -ngay sau khi cài đặt để thiết lập lại các tập tin của riêng mình
• Tôi có thể lưu trữ các tập tin xây dựng của mình trong một thư mục chuyên dụng, /buildví dụ
• Tôi có thể sử dụng một công cụ xây dựng khác, như Phing, Ant hoặc Rake (các nhà phát triển của tôi sẽ không vui lắm đâu)
• Tôi có thể thay thế magento/magento2-basebằng gói tùy chỉnh có ánh xạ tùy chỉnh cho các tệp lõi (không thực sự tối ưu nhưng này, đó là một tùy chọn)

Cá nhân tôi không thích tất cả các tùy chọn này, vì vậy tôi muốn biết liệu có cách nào ưu tiên hay tốt hơn để đạt được những gì tôi đang cố gắng thực hiện.

Có ai có cùng một vấn đề? Làm thế nào bạn giải quyết nó? Làm thế nào để bạn cấu trúc dự án của bạn theo VCS?

CẬP NHẬT

Một điểm bổ sung liên quan đến việc thiết lập dự án. Trong các thử nghiệm của tôi, tôi nhận thấy rằng trình cài đặt trình soạn thảo Magento có cờ ghi đè tệp:

"extra": {
    "magento-force": "override"
}

Nó được xử lý nội bộ như một boolean nếu tôi không nhầm, vì vậy tôi đã cố gắng đặt nó falseđể bỏ qua ghi đè. Khi tôi chạy composer installcài đặt của tôi không thành công vì tập tin đã có sẵn. Về cơ bản, nếu tôi không để Magento ghi đè các tệp của mình, tôi không thể cài đặt nó.

Mục đích của lá cờ này là gì? Có phải nó chỉ giả sử để thực hiện một kiểm tra cho tôi? Thành thật đối với tôi không có ý nghĩa gì, nhưng có lẽ ai đó có thể làm sáng tỏ chủ đề này.

Ngắn hạn, chúng tôi đang tìm cách tách các tệp cần tùy chỉnh. Ví dụ: nếu mọi người cần sửa đổi index.php, hãy tìm cách tách tệp Magento tiêu chuẩn khỏi nhu cầu tùy chỉnh cục bộ. Sau khi đạt được, có thể có "một .gitignore đúng cho tất cả các dự án có thể sử dụng". Đó là, dễ dàng cam kết toàn bộ thư mục dự án với Git với .gitignore của tất cả mọi thứ mà "trình soạn thảo cài đặt" sẽ tìm nạp cho bạn (và mọi thứ "cập nhật trình soạn thảo" sẽ thay thế khi cài đặt bản vá hoặc nâng cấp).

Dài hạn, mục tiêu là rút ngắn .gitignore càng nhiều càng tốt. Ví dụ: đẩy thêm vào các mô-đun trong thư mục 'nhà cung cấp'.

Sau đó

1. Đối với mọi thứ bạn không muốn chia sẻ trên các dự án, hãy để nó dưới ứng dụng / mã và cam kết trong repo dự án chính.
2. Mọi thứ được phát triển cục bộ mà bạn muốn chia sẻ giữa các dự án dễ dàng hơn, đặt vào một repo GIT riêng và cài đặt qua trình soạn thảo để nó kết thúc dưới 'nhà cung cấp'. (Có thể là repo nhà soạn nhạc địa phương hoặc chỉ cần cài đặt trực tiếp từ GIT.)

Bằng cách đó, bạn vẫn có thể git cam kết toàn bộ cây dự án từ trên xuống, chụp các tệp composer.json và composer.lock (chỉ cam kết không có ứng dụng / mã). .Gitignore sẽ loại trừ thư mục 'nhà cung cấp' và các tệp khác không muốn.

Điều này cung cấp cho bạn tốt nhất của cả hai thế giới được đề cập trong các cuộc thảo luận khác. Nỗi đau hiện tại là độ dài và độ phức tạp của tệp .gitignore và cài đặt bản vá hiện đang xóa sạch một số tùy chỉnh cục bộ (ví dụ: trong tệp index.php). Giải pháp ngắn hạn - xóa index.php khỏi .gitignore và khi bạn cài đặt kiểm tra bản vá để xem những thay đổi bạn đã mất (git diff) và áp dụng lại chúng theo cách thủ công.

Có một Giải pháp dễ dàng cho vấn đề ghi đè của bạn: không thay đổi Tập tin lõi;) Magento dựa trên việc mở rộng Mã và không thay đổi.

Điều đầu tiên là, bạn không nên đặt toàn bộ thư mục ứng dụng / mã của mình vào một Kho lưu trữ vcs. Mỗi Thành phần Magento (Mô-đun, Chủ đề, v.v ...) phải là một kho lưu trữ.

Nếu bạn muốn thay đổi / mở rộng giao diện, bạn nên tạo một chủ đề mới và coi chủ đề này là dự án lẩm cẩm của bạn, chứ không phải toàn bộ Sơ đồ Magento2.

Để cài đặt chủ đề của bạn trong Dự án, bạn có thể dễ dàng kéo nó qua trình soạn thảo trực tiếp từ kho lưu trữ vcs của bạn

Ok, có vẻ như tôi đã tìm thấy một giải pháp tốt hơn cho những gì tôi đang cố gắng đạt được. Trong composer.jsonđó, có thể chỉ định tệp nào sẽ bị bỏ qua bởi Trình cài đặt Trình soạn thảo Magento. Nếu tôi không muốn Gruntfile.jsghi đè, tôi chỉ cần xác định nó với cấu hình sau:

"extra": {
    "magento-deploy-ignore": {
        "magento/magento2-base": [
            "/Gruntfile.js",
            "/package.json"
        ]
    }
}

Bây giờ tôi có thể mở rộng cài đặt tiêu chuẩn để phù hợp với nhu cầu của tôi.

Thật không may, câu trả lời được chấp nhận, mặc dù là cách ban đầu nhằm đạt được mục tiêu mong muốn, chỉ hoạt động để loại trừ các tệp và thư mục được đặt trong thư mục gốc, bởi vì nếu chúng tôi muốn loại trừ một tệp được đặt trong thư mục con (ví dụ: dev/tools/grunt/configs/themes.jscần thiết nếu chúng tôi thêm chủ đề mới và muốn sử dụng các tác vụ Magento Grunt), đặt nó trong cấu hình "magento-triển khai-bỏ qua", nó chặn việc triển khai tất cả các thư mục mẹ (nghĩa là dev và tất cả các thư mục con của nó).

Điều này xảy ra bởi vì phương thức xử lý "magento-triển khai-bỏ qua" ( \MagentoHackathon\Composer\Magento\Deploystrategy\DeploystrategyAbstract::isDestinationIgnored) sử dụng strposđể khớp đường dẫn đích với danh sách loại trừ, vì vậy mọi đường dẫn cha mẹ sẽ luôn trả về đúng.

Sử dụng miếng vá

Những gì tôi sử dụng là tạo và áp dụng các bản vá. Khi chúng ta cần phải thay đổi dev/tools/grunt/configs/themes.js, index.phphoặc .htaccesschúng tôi áp dụng các thay đổi cho một bản sao tạm thời của tập tin và tạo ra một bản vá ra khỏi nó (tạo ra một build/thư mục đầu tiên):

$ cp dev/tools/grunt/configs/themes.js dev/tools/grunt/configs/themes.js.tmp
  # Now Make changes in .tmp file
$ diff -u3 dev/tools/grunt/configs/themes.js dev/tools/grunt/configs/themes.js.tmp | sed 's/\.tmp//' > build/themes.patch
$ mv dev/tools/grunt/configs/themes.js.tmp dev/tools/grunt/configs/themes.js

Sau đó, chúng tôi có thể làm cho bản vá này tự động áp dụng khi chạy composer installhoặc updatebằng cách thêm các lệnh te vào scriptsphần composer.jsontệp của bạn :

{
    "scripts": {
        "post-install-cmd": "patch -i build/themes.patch dev/tools/grunt/configs/themes.js",
        "post-update-cmd": "patch -i build/themes.patch dev/tools/grunt/configs/themes.js"
    }
}

(Ngoài ra, bạn có thể đặt patch ...lệnh trên trong tập lệnh bash, hãy nói build/themes_patch.shvà gọi tập lệnh đó từ Trình soạn thảo để nó có thể được sử dụng lại hoặc thực thi thủ công)

Nâng cấp an toàn! : D

Giải pháp này được nâng cấp an toàn! Bạn không thay đổi trực tiếp các tệp cốt lõi mà không tôn trọng tệp gốc. Bạn đang áp dụng một bản vá cho tệp Magento2 gốc. Khi tệp đó thay đổi vì bạn đang nâng cấp, bản vá sẽ thất bại và bạn biết rằng bạn phải xem xét kỹ hơn những thay đổi mới và tạo một bản vá mới.