फ़ाइल फ़ोल्डर के नियम

वर्कस्पेस के नियमों का इस्तेमाल, बाहरी डिपेंडेंसी को शामिल करने के लिए किया जाता है. आम तौर पर, ये मुख्य रिपॉज़िटरी से बाहर मौजूद सोर्स कोड होते हैं.

ध्यान दें: Workspace के मूल नियमों के अलावा, Basel ने कई Starlark Workspace रूल भी जोड़े हैं. खास तौर पर, वे नियम जो वेब पर होस्ट किए गए Git डेटा स्टोर करने की जगहों या संग्रह से जुड़े हैं.

नियम

• bind
• local_repository
• new_local_repository

बाइंड

नियम का सोर्स देखें

bind(name, actual, compatible_with, deprecation, distribs, features, licenses, restricted_to, tags, target_compatible_with, testonly, visibility)

चेतावनी: हम bind() का इस्तेमाल करने का सुझाव नहीं देते. बाइंड से जुड़ी समस्याओं और उनके विकल्पों पर लंबे समय तक चर्चा करने के लिए, "बाइंड हटाने पर विचार करें" देखें. खास तौर पर, repo_mapping रिपॉज़िटरी एट्रिब्यूट का इस्तेमाल करें.

चेतावनी: select() का इस्तेमाल bind() में नहीं किया जा सकता. ज़्यादा जानकारी के लिए, कॉन्फ़िगर किए जा सकने वाले एट्रिब्यूट के बारे में अक्सर पूछे जाने वाले सवाल देखें.

//external पैकेज में किसी टारगेट को कोई दूसरा नाम देता है.

//external पैकेज, "सामान्य" पैकेज नहीं होता है: इसमें कोई बाहरी/ डायरेक्ट्री मौजूद नहीं है. इसलिए, इसे एक "वर्चुअल पैकेज" माना जा सकता है जिसमें तय किए गए सभी टारगेट शामिल होते हैं.

उदाहरण

किसी टारगेट को कोई दूसरा नाम देने के लिए, WORKSPACE फ़ाइल में जाकर, bind उसे डालें. उदाहरण के लिए, मान लें कि //third_party/javacc-v2 नाम का एक java_library टारगेट है. WORKSPACE फ़ाइल में ये चीज़ें जोड़कर, इसे कोई दूसरा नाम दिया जा सकता है:

bind(
    name = "javacc-latest",
    actual = "//third_party/javacc-v2",
)

अब टारगेट, //third_party/javacc-v2 के बजाय //external:javacc-latest पर निर्भर हो सकते हैं. अगर javacc-v3 रिलीज़ किया गया, तो bind नियम को अपडेट किया जा सकता है और //external:javacc-latest के आधार पर सभी BUILD फ़ाइलें अब बिना बदलाव किए javacc-v3 पर निर्भर होंगी.

बाहरी रिपॉज़िटरी में मौजूद टारगेट को अपने फ़ाइल फ़ोल्डर में उपलब्ध कराने के लिए भी, बाइंड का इस्तेमाल किया जा सकता है. उदाहरण के लिए, अगर WORKSPACE फ़ाइल में @my-ssl नाम की कोई रिमोट रिपॉज़िटरी इंपोर्ट की गई है और उसमें cc_library टारगेट //src:openssl-lib है, तो bind का इस्तेमाल करके इस टारगेट के लिए कोई दूसरा नाम बनाया जा सकता है:

bind(
    name = "openssl",
    actual = "@my-ssl//src:openssl-lib",
)

इसके बाद, अपने वर्कस्पेस की BUILD फ़ाइल में, बाउंड किए गए टारगेट का इस्तेमाल इस तरह किया जा सकता है:

cc_library(
    name = "sign-in",
    srcs = ["sign_in.cc"],
    hdrs = ["sign_in.h"],
    deps = ["//external:openssl"],
)

sign_in.cc और sign_in.h में, //external:openssl से एक्सपोज़ की गई हेडर फ़ाइलों को, उनके रिपॉज़िटरी रूट के हिसाब से उनके पाथ का इस्तेमाल करके रेफ़र किया जा सकता है. उदाहरण के लिए, अगर @my-ssl//src:openssl-lib के लिए नियम की परिभाषा इस तरह दिखती है:

cc_library(
    name = "openssl-lib",
    srcs = ["openssl.cc"],
    hdrs = ["openssl.h"],
)

इसके बाद, sign_in.cc में शामिल आइटम कुछ इस तरह दिख सकते हैं:

#include "sign_in.h"
#include "src/openssl.h"

तर्क

विशेषताएं
name	नाम; यह ज़रूरी है इस टारगेट के लिए यूनीक नाम.
actual	लेबल; डिफ़ॉल्ट None है वह टारगेट जिसका दूसरा नाम दिया जाना है. यह टारगेट मौजूद होना चाहिए, लेकिन यह किसी भी तरह का नियम हो सकता है. इसमें बाइंड भी शामिल है. अगर इस एट्रिब्यूट को शामिल नहीं किया जाता है, तो //external में इस टारगेट का रेफ़रंस देने वाले नियमों को यह डिपेंडेंसी एज नहीं दिखेगी. ध्यान दें कि यह पूरी तरह से bind नियम को हटाने से अलग है: अगर किसी //external डिपेंडेंसी के लिए कोई bind नियम नहीं है, तो यह गड़बड़ी है.

local_repository

नियम का सोर्स देखें

local_repository(name, path, repo_mapping)

इससे, किसी लोकल डायरेक्ट्री के टारगेट को बाउंड किया जा सकता है. इसका मतलब है कि मौजूदा रिपॉज़िटरी, इस दूसरी डायरेक्ट्री में तय किए गए टारगेट का इस्तेमाल कर सकता है. ज़्यादा जानकारी के लिए, बाइंड सेक्शन देखें.

उदाहरण

मान लें कि मौजूदा रिपॉज़िटरी, चैट क्लाइंट है, जो डायरेक्ट्री ~/chat-app में रूट किया गया है. इसे ऐसी एसएसएल लाइब्रेरी का इस्तेमाल करना है जिसे किसी दूसरी रिपॉज़िटरी: ~/ssl में तय किया गया है. एसएसएल लाइब्रेरी में टारगेट //src:openssl-lib है.

उपयोगकर्ता, ~/chat-app/WORKSPACE में ये लाइनें जोड़कर, इस टारगेट पर डिपेंडेंसी जोड़ सकता है:

local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
)

टारगेट, इस लाइब्रेरी पर निर्भर रहने के लिए, @my-ssl//src:openssl-lib को डिपेंडेंसी के तौर पर तय करेंगे.

तर्क

विशेषताएं
name	नाम; यह ज़रूरी है इस टारगेट के लिए यूनीक नाम.
path	स्ट्रिंग; आवश्यक है लोकल रिपॉज़िटरी की डायरेक्ट्री का पाथ. यह उस डायरेक्ट्री का पाथ होना चाहिए जिसमें रिपॉज़िटरी की WORKSPACE फ़ाइल मौजूद हो. यह पाथ, मुख्य रिपॉज़िटरी की WORKSPACE फ़ाइल के ऐब्सलूट या रिलेटिव पाथ में से कोई एक हो सकता है.
repo_mapping	डिक्शनरी: स्ट्रिंग -> स्ट्रिंग; डिफ़ॉल्ट तौर पर {} लोकल डेटा स्टोर करने की जगह के नाम से ग्लोबल डेटा स्टोर करने की जगह के नाम की डिक्शनरी. इससे, इस रिपॉज़िटरी की डिपेंडेंसी के लिए, वर्कस्पेस डिपेंडेंसी रिज़ॉल्यूशन को कंट्रोल किया जा सकता है. उदाहरण के लिए, "@foo": "@bar" एंट्री से पता चलता है कि जब भी यह रिपॉज़िटरी "@foo" पर निर्भर करता है, तो उसे ग्लोबल तौर पर बताए गए "@bar" ("@bar//some:target") में उस डिपेंडेंसी को हल करना चाहिए. जैसे, "@foo//some:target" पर डिपेंडेंसी.

new_local_repository

नियम का सोर्स देखें

new_local_repository(name, build_file, build_file_content, path, repo_mapping, workspace_file, workspace_file_content)

किसी लोकल डायरेक्ट्री को Basel का डेटा स्टोर करने की जगह में बदलने की अनुमति देता है. इसका मतलब है कि मौजूदा रिपॉज़िटरी, फ़ाइल सिस्टम में कहीं से भी टारगेट तय कर सकती है और उनका इस्तेमाल कर सकती है.

यह नियम, Workspace फ़ाइल और सबडायरेक्ट्री बनाकर, बेज़ल रिपॉज़िटरी बनाता है, जिसमें BUILD फ़ाइल और पाथ के सिमलिंक शामिल होते हैं. बिल्ड फ़ाइल को path के मुताबिक टारगेट बनाना चाहिए. जिन डायरेक्ट्री में पहले से ही WORKSPACE फ़ाइल और BUILD फ़ाइल मौजूद है उनके लिए, local_repository नियम का इस्तेमाल किया जा सकता है.

उदाहरण

मान लें कि डेटा स्टोर करने की मौजूदा जगह एक चैट क्लाइंट है, जिसे ~/chat-app डायरेक्ट्री पर रूट किया गया है. वह ऐसी एसएसएल लाइब्रेरी का इस्तेमाल करना चाहता है जिसकी जानकारी किसी दूसरी डायरेक्ट्री में दी गई है: ~/एसएसएल.

उपयोगकर्ता, एसएसएल लाइब्रेरी (~/chat-app/BUILD.my-ssl) के लिए एक बिल्ड फ़ाइल बनाकर, उस डिपेंडेंसी जोड़ सकता है जिसमें यह जानकारी शामिल हो:

java_library(
    name = "openssl",
    srcs = glob(['*.java'])
    visibility = ["//visibility:public"],
)

इसके बाद, वे ~/chat-app/WORKSPACE में ये लाइनें जोड़ सकते हैं:

new_local_repository(
    name = "my-ssl",
    path = "/home/user/ssl",
    build_file = "BUILD.my-ssl",
)

इससे एक @my-ssl रिपॉज़िटरी बन जाएगी, जो /home/user/ssl से लिंक होगी. टारगेट, इस लाइब्रेरी पर निर्भर हो सकते हैं. इसके लिए, टारगेट की डिपेंडेंसी में @my-ssl//:openssl जोड़ें.

new_local_repository का इस्तेमाल, सिर्फ़ डायरेक्ट्री ही नहीं, बल्कि एक फ़ाइल को भी शामिल करने के लिए किया जा सकता है. उदाहरण के लिए, मान लें कि आपके पास /home/username/Downloads/piano.jar में एक jar फ़ाइल है. आप अपनी वर्कस्पेस फ़ाइल में यह फ़ाइल जोड़कर, सिर्फ़ उस फ़ाइल को अपने बिल्ड में जोड़ सकते हैं:

new_local_repository(
    name = "piano",
    path = "/home/username/Downloads/piano.jar",
    build_file = "BUILD.piano",
)

और निम्न BUILD.piano फ़ाइल बनाना:

java_import(
    name = "play-music",
    jars = ["piano.jar"],
    visibility = ["//visibility:public"],
)

इसके बाद, पियानो.जर का इस्तेमाल करने के लिए, टारगेट @piano//:play-music की मदद ली जा सकती है.

तर्क

विशेषताएं
name	नाम; यह ज़रूरी है इस टारगेट के लिए यूनीक नाम.
build_file	नाम; डिफ़ॉल्ट तौर पर None इस डायरेक्ट्री के लिए, BUILD फ़ाइल के तौर पर इस्तेमाल की जाने वाली फ़ाइल. build_file या build_file_content में से किसी एक की जानकारी देना ज़रूरी है. यह एट्रिब्यूट, मुख्य फ़ाइल फ़ोल्डर से जुड़ा लेबल होता है. फ़ाइल का नाम ज़रूर से ही BUILD होना चाहिए, ऐसा नहीं है. (BUILD.new-repo-name जैसा कुछ, इसे रिपॉज़िटरी की असल BUILD फ़ाइलों से अलग करने के लिए काम कर सकता है.)
build_file_content	स्ट्रिंग; डिफ़ॉल्ट रूप से "" इस रिपॉज़िटरी के लिए BUILD फ़ाइल का कॉन्टेंट. build_file या build_file_content में से किसी एक की जानकारी देना ज़रूरी है.
path	स्ट्रिंग; ज़रूरी है लोकल फ़ाइल सिस्टम पर कोई पाथ. यह मुख्य रिपॉज़िटरी की WORKSPACE फ़ाइल के हिसाब से ऐब्सलूट या रिलेटिव हो सकता है.
repo_mapping	डिक्शनरी: स्ट्रिंग -> स्ट्रिंग; डिफ़ॉल्ट तौर पर {} लोकल डेटा स्टोर करने की जगह के नाम से ग्लोबल डेटा स्टोर करने की जगह के नाम की डिक्शनरी. इससे, इस रिपॉज़िटरी की डिपेंडेंसी के लिए, वर्कस्पेस डिपेंडेंसी रिज़ॉल्यूशन को कंट्रोल किया जा सकता है. उदाहरण के लिए, "@foo": "@bar" एंट्री से पता चलता है कि जब भी यह रिपॉज़िटरी "@foo" पर निर्भर करता है, तो उसे ग्लोबल तौर पर बताए गए "@bar" ("@bar//some:target") में उस डिपेंडेंसी को हल करना चाहिए. जैसे, "@foo//some:target" पर डिपेंडेंसी.
workspace_file	नाम; डिफ़ॉल्ट तौर पर None इस रिपॉज़िटरी के लिए, WORKSPACE फ़ाइल के तौर पर इस्तेमाल की जाने वाली फ़ाइल. workspace_file या workspace_file_content में से किसी एक की वैल्यू दी जा सकती है, लेकिन दोनों की नहीं. यह एट्रिब्यूट, मुख्य फ़ाइल फ़ोल्डर से जुड़ा लेबल होता है. फ़ाइल का नाम WORKSPACE होना ज़रूरी नहीं है, लेकिन ऐसा किया जा सकता है. (WORKSPACE.new-repo-name जैसा कोई नाम, इसे रिपॉज़िटरी की असल WORKSPACE फ़ाइलों से अलग करने के लिए काम कर सकता है.)
workspace_file_content	स्ट्रिंग; डिफ़ॉल्ट रूप से "" इस रिपॉज़िटरी के लिए WORKSPACE फ़ाइल का कॉन्टेंट. workspace_file या workspace_file_content में से किसी एक की वैल्यू दी जा सकती है, लेकिन दोनों की नहीं.