Schema của Aggrega Wasm Describe Socket
Tài liệu tham khảo được sinh tự động. Không chỉnh sửa thủ công — hãy sinh lại từ JSON Schema đã xuất bản.
Schema id: https://aggrega.ai/schemas/wasm-describe-v1beta1.schema.json
Cấu trúc truyền tải mà mọi plugin Wasm trả về từ export describe() của nó (PluginDescriptor). describe() là phần tự khai báo của plugin, được host đọc một lần khi tải plugin: phiên bản ABI mà guest liên kết, loại plugin, các export mà plugin cung cấp cùng phần khai báo năng lực của từng export, một bản tự báo cáo năng lực ở cấp plugin, một hợp đồng hành vi render của provider (tùy chọn), một hợp đồng nhận diện của importer (tùy chọn), các lệnh CLI (tùy chọn), một schema cho phần cài đặt (tùy chọn) và siêu dữ liệu về tác giả (tùy chọn). Một cấu trúc duy nhất áp dụng cho mọi loại plugin — provider, linter, bước feature-recipe-pipeline, governance, CLI, parser và importer. Host đọc describe() trước khi điều phối bất kỳ export nào khác và từ chối một descriptor mà nó không thể chấp nhận, thay vì gọi sai plugin khi điều phối.
Một trong các dạng sau
PluginDescriptor
Định nghĩa
PluginDescriptor
Bản tự khai báo đầy đủ của một plugin, được trả về từ describe() và đọc một lần khi tải. Nó mang phần bắt tay tương thích ABI, loại plugin, các export được cung cấp và các bề mặt tùy chọn theo từng loại (hợp đồng hành vi render của một provider, hợp đồng nhận diện của một importer, các lệnh của một plugin CLI, một schema cài đặt, siêu dữ liệu về tác giả).
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
abi_version | const “v1beta1” | có | ABI plugin mà guest liên kết theo. Host chỉ chấp nhận đúng phiên bản này; một guest được build theo bất kỳ ABI nào khác sẽ bị từ chối khi tải thay vì bị gọi sai khi điều phối. Hằng số: "v1beta1" |
plugin_type | string (enum) | có | Loại của plugin. Nó chọn quy tắc export tối thiểu mà host kiểm tra và, cùng với tên export, mẫu cung cấp đầu vào mặc định. Một plugin governance đảm nhận các vai trò biến đổi và phán quyết của pipeline build; vai trò mà nó được gắn vào — chứ không phải loại của nó — quyết định những gì nó được phép phát ra. Giá trị cho phép: "provider", "linter", "pipeline-step", "governance", "cli", "parser", "importer" |
capabilities | string[] | không | Những gì plugin phục vụ. Danh sách là phẳng khi truyền đi và trường plugin_type bắt buộc liền kề quyết định mỗi mục mang nghĩa nào trong bốn nghĩa: với một provider, là tên các capability (chẳng hạn helm hoặc compose) có dạng đầu ra mà nó render; với một bước feature-recipe-pipeline, là các capability của provider mà bước đó tương thích; với một parser, là các định dạng nguồn mà nó chuyển thành cây có cấu trúc chuẩn, mỗi định dạng viết là parse: |
exports | PluginExport[] | có | Các export mà plugin cung cấp, theo thứ tự khai báo. Host kiểm tra rằng export tối thiểu theo từng loại có mặt và liên kết bề mặt host theo từng export trước khi gọi mỗi export. |
contract | ProviderContract | không | Bản tự báo cáo hành vi render của provider — các loại đầu vào mà nó render, cách nó lắp ráp đầu ra theo từng node của một nhóm điều phối, và cặp dấu phân cách artifact-template mà nó áp dụng. Nó mô tả provider như một tổng thể chứ không phải bất kỳ export riêng lẻ nào. Vắng mặt với một plugin không khai báo hợp đồng hành vi render. |
importer | ImporterContract | không | Bản tự báo cáo của một importer về cách nhận diện một nguồn thuộc các định dạng mà nó quảng bá khi một lần import không nêu định dạng nào. Chỉ một plugin có plugin_type là importer mới được khai báo nó; bất kỳ plugin nào khác khai báo nó đều bị từ chối khi tải. Vắng mặt với một importer không khai báo cách nhận diện các định dạng của mình, khi đó các định dạng ấy chỉ được dùng tới bằng cách nêu tên chúng. |
description | string | không | Mô tả một dòng, dễ đọc cho con người, do chính plugin đưa ra về việc nó làm, khác với mô tả theo từng export và với mô tả trong metadata của thực thể. Nó chỉ mang tính thông tin; host không kiểm tra cũng không xử lý nó. |
commands | PluginCLICommand[] | không | Các động từ lệnh aggrega cấp cao nhất mà một plugin CLI đóng góp, mỗi lệnh có dòng trợ giúp ngắn riêng. Một plugin CLI có thể đóng góp nhiều lệnh; host đăng ký một lệnh cho mỗi mục và chuyển tên lệnh đã phân giải tới guest khi gọi. Một plugin không phải CLI để trống trường này. |
settings_schema | object | không | Một tài liệu JSON Schema tùy chọn mà plugin khai báo để định kiểu các cài đặt do người vận hành cung cấp mà phần gắn của nó mang theo. Khi có mặt, host biên dịch nó khi tải và kiểm tra các cài đặt của phần gắn theo nó khi điều phối, trước khi gọi plugin; các cài đặt không phù hợp sẽ dừng bản build. Khi vắng mặt, plugin không khai báo dạng nào và các cài đặt được chuyển qua nguyên văn. Schema là bản khai báo dạng tự do của chính plugin; host chạy kiểm tra JSON Schema chung theo nó và không diễn giải ý nghĩa của các cài đặt. |
metadata | PluginDescriptorMeta | không | Thông tin tùy chọn về tác giả và nguồn gốc build. Nó không mang hợp đồng hành vi nào — host không kiểm tra cũng không xử lý nó. |
Không cho phép thuộc tính bổ sung.
PluginExport
Một export mà plugin cung cấp, như được khai báo trong describe(). Host điều phối tới export theo tên của nó và liên kết bề mặt host đặc quyền tối thiểu mà các hàm host được khai báo của export yêu cầu.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Tên ABI của export — ví dụ render_node, assemble_boundary, lint_rules hoặc step. Host điều phối tới export theo tên này. |
input_pattern | string (enum) | không | Cách host cung cấp đầu vào của export: b cung cấp toàn bộ payload trực tiếp để guest render chỉ từ payload; a cung cấp một payload nhỏ mà guest bổ sung thông qua các hàm host. Một export bỏ qua trường này sẽ dùng giá trị mặc định theo loại plugin và tên. Giá trị cho phép: "a", "b" |
host_functions | string[] | không | Tên các hàm host mà export này import. Mọi tên phải nằm trong danh sách cho phép của hàm host. Khai báo này có tính quyết định và được đối chiếu khi tải với các hàm mà guest thực sự import từ module của nó, nên nó không thể lệch khỏi các hàm mà guest thực sự gọi. |
description | string | không | Văn bản tùy chọn, dễ đọc cho con người, mô tả export. Đây là tài liệu cho người đọc catalog; host không kiểm tra cũng không xử lý nó. |
stability | string (enum) | không | Mức độ ổn định của export. Giá trị bị bỏ qua nghĩa là không tuyên bố về độ ổn định. Giá trị cho phép: "stable", "experimental", "deprecated" |
operates | string (enum) | không | Thao tác pipeline mà export này thực hiện: patch sửa đổi một tài liệu đã render có sẵn, emit thêm một tài liệu mới. Giá trị được kiểm tra dạng khi tải; runtime đọc nó khi điều phối bước. Giá trị cho phép: "patch", "emit" |
scope | string (enum) | không | Gốc tài liệu mà export này thao tác: own là các tài liệu đã render của chính node, host là các tài liệu của component mà một feature recipe phạm vi component được gắn vào. Giá trị được kiểm tra dạng khi tải; runtime phân giải các tài liệu của phạm vi khi điều phối. Giá trị cho phép: "own", "host" |
selector | string | không | Mô tả dạng tự do, dễ đọc cho con người, về đối tượng mà export tác động. Đây là tài liệu cho người đọc catalog; host không kiểm tra nội dung cũng không xử lý nó. |
input | object | không | Một tài liệu JSON Schema tùy chọn mà một export step khai báo để định kiểu đầu vào cục bộ của bước mà một mục pipeline cung cấp qua khối with của nó. Khi có mặt, nó mô tả dạng mà đầu vào with của một bước thỏa mãn; khi vắng mặt, export không khai báo hợp đồng đầu vào. Schema là bản khai báo dạng tự do của chính export về bề mặt đầu vào mà tác giả pipeline nhắm tới cho export này. |
output | object | không | Một tài liệu JSON Schema tùy chọn mà một export step khai báo để định kiểu các đầu ra nó trả về cho một bước — dạng của các đầu ra có thể tham chiếu mà một bước đóng góp để bước sau hoặc một template đọc. Khi có mặt, nó mô tả dạng của các đầu ra được trả về đó; khi vắng mặt, export không khai báo hợp đồng đầu ra. Schema là bản khai báo dạng tự do của chính export về bề mặt đầu ra mà export này tạo ra. |
Không cho phép thuộc tính bổ sung.
PluginCLICommand
Một động từ lệnh aggrega cấp cao nhất mà một plugin CLI đóng góp, như được khai báo trong describe(). Host đăng ký một lệnh cho mỗi mục và chuyển tên lệnh đã phân giải trở lại guest khi gọi, nên một guest duy nhất có thể đảm nhận nhiều lệnh và chọn hành vi dựa trên tên.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Động từ lệnh mà host đăng ký — token aggrega mà người vận hành gọi và là yếu tố phân biệt mà host trao cho guest để nó định tuyến theo lệnh đã được gọi. Mọi lệnh được khai báo đều phải đặt tên này. |
description | string | không | Văn bản trợ giúp ngắn một dòng của lệnh, hiển thị trong danh sách lệnh và đầu ra trợ giúp. Đây là tài liệu tùy chọn; host không kiểm tra cũng không xử lý nó. |
flags | PluginCommandFlag[] | không | Các cờ của lệnh, theo thứ tự khai báo. Mỗi mục đóng góp một cờ mà host đăng ký trên lệnh để aggrega help |
Không cho phép thuộc tính bổ sung.
PluginCommandFlag
Một cờ mà một CLI plugin khai báo trên một lệnh, như được báo cáo trong describe(). Host đăng ký nó trên lệnh để aggrega help
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
name | string | có | Tên dài của cờ — token —name mà người vận hành truyền trên dòng lệnh. Mọi cờ được khai báo đều phải đặt tên này. Dài ít nhất 1 ký tự. |
shorthand | string | không | Bí danh ngắn một ký tự tùy chọn của cờ — dạng -x mà người vận hành có thể truyền thay cho tên dài. Khi vắng mặt, cờ không có bí danh ngắn. |
description | string | không | Văn bản trợ giúp một dòng của cờ, hiển thị trong đầu ra trợ giúp của lệnh. Đây là tài liệu tùy chọn; host không kiểm tra cũng không xử lý nó. |
type | string | không | Kiểu giá trị của cờ — ví dụ string, bool hoặc int. Khi vắng mặt, không có khẳng định nào về kiểu. |
default | string | không | Giá trị mặc định của cờ khi người vận hành không truyền nó, được biểu diễn dưới dạng chuỗi. Khi vắng mặt, cờ không khai báo giá trị mặc định. |
Không cho phép thuộc tính bổ sung.
PluginDescriptorMeta
Siêu dữ liệu tùy chọn về tác giả và nguồn gốc bản dựng mà một plugin khai báo trong describe(). Nó chỉ mang tính thông tin; host không kiểm tra cũng không xử lý nó. Các trường version và commit là thông tin nguồn gốc bản dựng được đóng dấu vào guest lúc dựng; một bản dựng không được đóng dấu sẽ bỏ qua chúng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
author | string | không | Tác giả của plugin. |
repository | string | không | Kho mã nguồn của plugin. |
license | string | không | Mã định danh giấy phép của plugin. |
version | string | không | Phiên bản nguồn gốc bản dựng được đóng dấu vào guest lúc dựng. Bị bỏ qua bởi một bản dựng không được đóng dấu. |
commit | string | không | Commit ngắn về nguồn gốc bản dựng mà guest được dựng từ đó. Bị bỏ qua bởi một bản dựng không được đóng dấu. |
Không cho phép thuộc tính bổ sung.
ProviderContract
Bản tự khai báo của một provider về các hành vi kết xuất lúc biên dịch mà nó thực hiện trên các nút nó kết xuất — các loại đầu vào nó chấp nhận, liệu nó có và bằng cách nào ghép đầu ra theo từng nút của một nhóm điều phối thành một artifact duy nhất, cặp dấu phân cách Go-template nó áp dụng cho các tệp artifact được nhập, liệu nó có chấp nhận các tệp mà một Recipe đóng góp vào đầu ra chung của ranh giới của nó hay không, và các tệp mà hệ sinh thái của nó không bao giờ phân phối cùng một nguồn. Nó mô tả provider như một tổng thể, không phải bất kỳ một export nào. Cổng tải đối chiếu nó với khẳng định được soạn của thực thể.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
input_kinds | InputKinds | có | Plugin kết xuất những loại nào trong ba loại đầu vào của Recipe: một tập tệp có nguồn, một workload được tổng hợp, và một nút độc lập chỉ chứa artifact. |
boundary_assembly | string (enum) | có | Cách plugin kết hợp đầu ra kết xuất theo từng nút của một nhóm điều phối: none ghi đầu ra của mỗi nút trực tiếp tại đường dẫn điều phối, merge gộp các mảnh theo từng nút thành một tài liệu, và nest đặt đầu ra của mỗi nút dưới vị trí riêng của nó trong một cấu trúc bao trùm. Một giá trị rỗng không mang khẳng định nào về việc ghép. Giá trị cho phép: "none", "merge", "nest", "" |
artifact_delimiters | ArtifactDelimiters | không | Cặp dấu phân cách Go-template mà plugin áp dụng cho các tệp artifact được nhập. Khi vắng mặt, dùng cặp mở/đóng mặc định; một plugin có cú pháp đích xung đột với cặp đó sẽ báo cáo một cặp thay thế tại đây. |
assembly_name_annotation | AssemblyNameAnnotation | không | Một annotation ranh giới có giá trị đã phân giải đặt tên cho artifact mà plugin ghép từ một nhóm điều phối. Khi vắng mặt, plugin đặt tên cho bản ghép chỉ từ đường dẫn điều phối. |
reusable_instance | boolean | không | Liệu một phiên bản plugin đã tải có thể phục vụ mọi lượt render, assemble và validate của bản dựng thay vì một phiên bản mới cho mỗi lượt hay không. Một plugin chỉ khai báo true khi nó không giữ trạng thái giữa các lượt. Vắng mặt (false) là mặc định an toàn: host tải một phiên bản mới cho mỗi lượt. |
cross_boundary_linking | boolean | không | Liệu plugin có nối các cạnh uses xuyên ranh giới — các cạnh có đầu tiêu thụ và đầu bị tiêu thụ được ghép vào các nhóm điều phối khác nhau — bằng cách tạo ra liên kết tham chiếu chéo gốc của provider thông qua các export link_publish và link_resolve của nó hay không. Một plugin chỉ khai báo true khi nó export cả hai. Vắng mặt (false) là mặc định an toàn: plugin không nối cạnh xuyên ranh giới nào. |
omits | boolean | không | Liệu plugin có tôn trọng các mục omit mà một đầu vào render_node mang theo hay không: nó loại mọi đơn vị được kết xuất mà một mục khớp ra khỏi mọi thứ nó trả về, và báo cáo một số đếm cho mỗi mục nó được giao trong omitted của đầu ra. Một plugin chỉ khai báo true khi nó làm cả hai. Vắng mặt (false) là mặc định an toàn: plugin không khẳng định sẽ loại bỏ bất cứ thứ gì. |
boundary_artifacts | boolean | không | Liệu đích của plugin có chấp nhận các tệp mà một Recipe đóng góp vào đầu ra chung của ranh giới mà nó kết xuất trong đó hay không. Host đánh giá các tệp đó và ghi mỗi tệp một lần, trong thư mục chứa đầu ra đã ghép của nhóm điều phối, bên cạnh những gì bản ghép của plugin ghi ra; plugin không được giao tệp nào trong số đó và không đọc tệp nào, vì vậy khẳng định này là một tuyên bố rằng đích của nó coi một tệp được đặt ở đó là một phần của đầu ra ranh giới. Vắng mặt (false) là mặc định an toàn: một Recipe khai báo các tệp như vậy cho plugin này sẽ bị từ chối trước khi bất cứ thứ gì được kết xuất. |
nest_segment | string | không | Thư mục mà đích của plugin đặt thư mục con riêng của mỗi bên đóng góp vào bên dưới, đối với một plugin lồng đầu ra theo từng nút của một nhóm điều phối. Host nối đoạn này, tên ở cấp soạn thảo của bên đóng góp, và đường dẫn riêng của mỗi tệp. Chỉ được đọc khi boundary_assembly là nest. Khi vắng mặt, host đặt thư mục con của mỗi bên đóng góp trực tiếp tại vị trí điều phối, không có thư mục bao quanh. Giá trị đặt tên cho một thư mục và không bao giờ là một đường dẫn: một giá trị chứa dấu phân tách đường dẫn, hoặc đặt tên cho thư mục hiện tại hay thư mục cha, sẽ bị từ chối, vì host ghép tên của bên đóng góp vào đó và một mảnh đường dẫn sẽ đặt các tệp của bên đóng góp ở nơi khác ngoài bên dưới vị trí điều phối. |
source_ignore | SourceIgnore | không | Các tệp mà hệ sinh thái của plugin này không bao giờ phân phối cùng một nguồn mà nó kết xuất, được khai báo dưới dạng các quy tắc bỏ qua. Host đọc khai báo khi một tác giả ghim một Recipe hoặc FeatureRecipe có capability mà plugin này phục vụ cho họ: nó kết hợp các quy tắc này với tệp bỏ qua riêng của tác giả, ghi lại các quy tắc đã kết hợp trong entity lock bên cạnh thực thể, và từ đó trở đi mọi lần xuất bản thực thể, mọi lần so sánh nguồn cục bộ của nó và mọi lần kết xuất nó đều áp dụng các quy tắc đã ghi thay vì hỏi lại một plugin. Vì vậy một Recipe được xuất bản cho một capability mang theo các tệp mà quy tắc của người xuất bản giữ lại, và một plugin kết xuất nó khi nó dùng cùng phiên bản ABI, hợp đồng của nó khớp với khẳng định của thực thể, và nó không cần tệp nào ngoài tập đó. Một plugin cần một tệp mà tập đó bỏ ra phải làm bản dựng của nó thất bại rõ ràng và nêu tên tệp; phần của host là từ chối việc đóng gói hoặc đọc một tệp mà tập đó không chứa, kèm theo tên tệp. Khi vắng mặt, không khai báo quy tắc bỏ qua nào, và một nguồn mà plugin kết xuất khi đó giữ mọi tệp mà quy tắc riêng của tác giả giữ lại. |
Không cho phép thuộc tính bổ sung.
SourceIgnore
Các quy tắc bỏ qua mà hệ sinh thái của một plugin áp dụng cho một thư mục nguồn, theo cú pháp gitignore: một mẫu không chứa dấu gạch chéo, hoặc chỉ có một dấu ở cuối, khớp với một tên ở bất kỳ độ sâu nào, một mẫu chứa bất kỳ dấu gạch chéo nào khác được đọc từ gốc của thư mục mà nó áp dụng, một dấu gạch chéo ở cuối chỉ khớp với thư mục, và một dấu ! ở đầu đưa trở lại những gì một quy tắc trước đó đã loại trừ. Các quy tắc áp dụng theo thứ tự và một kết quả khớp sau ghi đè lên kết quả trước. Một thư mục bị một quy tắc loại trừ sẽ không được duyệt vào, vì vậy không có gì bên dưới nó được đưa trở lại trừ khi chính thư mục đó được đưa trở lại trước.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
patterns | string[] | không | Các mẫu bỏ qua riêng của hệ sinh thái, mỗi mẫu áp dụng từ gốc của thư mục nguồn cục bộ đang được duyệt, theo thứ tự chúng được áp dụng. Khi vắng mặt hoặc rỗng, không khai báo mẫu nào. |
files | string[] | không | Tên của các tệp bỏ qua mà hệ sinh thái tôn trọng bên trong một nguồn — ví dụ .helmignore cho một chart. Bất cứ nơi nào việc duyệt một nguồn tìm thấy một tệp có một trong các tên này, các dòng của nó được đọc như các mẫu bổ sung theo cùng cú pháp, mỗi mẫu áp dụng từ thư mục chứa tệp, và chúng được áp dụng sau các mẫu ở trên; một dòng trống và một dòng bắt đầu bằng # sẽ bị bỏ qua. Bản thân một tệp có tên như vậy vẫn được mang theo trừ khi một quy tắc loại trừ nó. Khi vắng mặt hoặc rỗng, không nêu tên tệp nào. |
Không cho phép thuộc tính bổ sung.
InputKinds
Những loại đầu vào Recipe mà một plugin kết xuất. Mỗi trường là một khẳng định độc lập; plugin có thể báo cáo bất kỳ tổ hợp nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
sourced | boolean | có | Plugin có kết xuất một tập tệp có nguồn (một chart, một module, một tệp compose) hay không. |
synthesized | boolean | có | Plugin có kết xuất một workload được tổng hợp hay không. |
artifacts_standalone | boolean | có | Plugin có kết xuất một nút độc lập chỉ chứa artifact hay không — nút mang các tài liệu artifact được nhập và không có nguồn hay workload. |
Không cho phép thuộc tính bổ sung.
ArtifactDelimiters
Cặp dấu phân cách Go-template mà plugin áp dụng cho các tệp artifact được nhập, được báo cáo khi nó khác cặp mặc định.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
left | string | có | Dấu phân cách mở. |
right | string | có | Dấu phân cách đóng. |
Không cho phép thuộc tính bổ sung.
AssemblyNameAnnotation
Annotation của boundary có giá trị đã phân giải đặt tên cho artifact được lắp ráp của plugin, được báo cáo khi plugin gộp các boundary đóng góp của một nhóm dispatch thành một bản lắp ráp có tên.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
annotation | string | có | Khóa annotation của boundary mà plugin đọc tên của artifact được lắp ráp từ đó. |
require_unique | boolean | không | Mọi boundary đóng góp vào một nhóm dispatch có phải thống nhất về giá trị đã phân giải của annotation hay không. Khi là true, một nhóm có các boundary đóng góp phân giải annotation thành các giá trị khác nhau sẽ dừng bản build; khi là false, plugin chấp nhận giá trị được phân giải đầu tiên. |
Không cho phép thuộc tính bổ sung.
ImporterContract
Những gì một importer khai báo về các định dạng của nó ngoài việc quảng bá chúng: các chữ ký mà nhờ đó một nguồn thuộc các định dạng ấy được nhận diện. Khi một lần import không nêu định dạng, host đọc các chữ ký được ghi lại bởi mọi importer mà lần import chọn trong số đó — các importer trong catalog của workspace và các importer lõi của trình biên dịch, mà binary mang theo các thực thể Plugin của chúng — so khớp từng chữ ký với nguồn mà không cần biết bất kỳ định dạng nào là gì, và đọc nguồn theo định dạng của importer duy nhất có chữ ký khớp. Một nguồn không khớp chữ ký nào sẽ bị từ chối kèm yêu cầu nêu định dạng, và một nguồn khớp chữ ký của nhiều hơn một định dạng sẽ bị từ chối kèm tên các định dạng đó. Thực thể Plugin ghi lại cùng danh sách này, và host từ chối một importer có báo cáo describe() khác với bản ghi.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
detect | DetectSignature[] | không | Các chữ ký nhận diện một nguồn thuộc các định dạng của importer này, theo thứ tự khai báo; một nguồn được nhận diện khi bất kỳ chữ ký nào trong số đó khớp với nó. Một nguồn được một importer nhận diện thì được nhận diện là mọi định dạng mà importer đó quảng bá, nên một importer quảng bá nhiều hơn một định dạng sẽ có mọi lần khớp bị từ chối vì mơ hồ, và một importer mà các nguồn của nó cần được nhận diện thì quảng bá một định dạng. Khi vắng mặt hoặc rỗng, không khai báo chữ ký nào, và các định dạng của importer chỉ được dùng đến bằng cách nêu tên chúng. |
Không cho phép thuộc tính bổ sung.
DetectSignature
Một cách nhận diện một nguồn: cú pháp mà nguồn được đọc theo, các tên tệp mà chữ ký áp dụng, và các vị từ mà cây đã phân tích phải thỏa mãn. Nó khớp với một tệp có tên khớp một trong các mẫu tệp của nó — hoặc, khi nó không khai báo mẫu nào, một nguồn là một tệp duy nhất, dù tên là gì — có các byte phân tích được theo cú pháp của nó, và có cây đã phân tích thỏa mãn mọi vị từ của nó. Nó khớp với một thư mục khi nó khớp một trong các tệp của thư mục mà các mẫu của nó chọn, nên một chữ ký không khai báo mẫu nào sẽ không khớp thư mục nào.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
syntax | string | có | Định dạng cú pháp mà nguồn được phân tích theo — ví dụ json hoặc yaml — là định dạng mà một plugin parser quảng bá dưới dạng parse: |
files | string[] | không | Các mẫu tên tệp mà chữ ký áp dụng, được so khớp với phần cuối tên của nguồn với các dấu phân cách được đọc là dấu gạch chéo xuôi: một mẫu gồm một đoạn được so khớp với tên riêng của tệp, và một mẫu gồm nhiều đoạn phân cách bằng gạch chéo được so khớp với chừng ấy đoạn cuối của đường dẫn, nên .vscode/mcp.json khớp với tệp tên mcp.json trong thư mục tên .vscode. Trong một đoạn, * khớp với một chuỗi ký tự bất kỳ, ? khớp với một ký tự, và […] khớp với một ký tự thuộc một lớp. Chữ ký áp dụng khi bất kỳ mẫu nào khớp. Một mẫu không đúng dạng sẽ bị từ chối khi nạp. Khi vắng mặt hoặc rỗng, chữ ký áp dụng cho một nguồn là một tệp duy nhất, dù tên là gì, và không áp dụng cho tệp nào của một thư mục. Các mẫu trong chữ ký của một importer cũng là thứ quyết định những tệp nào của một thư mục được một lần import giao cho nó. |
match | PathMatch[] | không | Các vị từ mà cây đã phân tích phải thỏa mãn, tất cả chúng, theo thứ tự khai báo. Khi vắng mặt hoặc rỗng, không yêu cầu gì ở cây ngoài việc phân tích được theo cú pháp đó. |
Không cho phép thuộc tính bổ sung.
PathMatch
Một vị từ trên cây đã phân tích: giá trị mà một đường dẫn đạt tới, loại giá trị mà nó phải có, và tùy chọn một chuỗi mà nó phải bằng hoặc bắt đầu bằng.
| Thuộc tính | Loại | Bắt buộc | Mô tả |
|---|---|---|---|
path | string | có | Vị trí trong cây mà vị từ xem xét, được viết dưới dạng các khóa nối bằng dấu chấm từ đỉnh của cây: data.nodes chỉ thành viên nodes của đối tượng data cấp cao nhất. Một đoạn được viết là số nguyên, từ 0 trở lên, chọn vị trí đó của một mảng, đếm từ không, nên nodes.0.type chỉ type của nút đầu tiên; mọi đoạn khác chọn một thành viên của một đối tượng. Không thể chỉ đến một khóa mà bản thân nó chứa dấu chấm. Dài ít nhất 1 ký tự. |
is | string (enum) | có | Thứ mà đường dẫn phải đạt tới: present đúng khi nó đạt tới một giá trị thuộc bất kỳ loại nào, kể cả null; absent đúng khi nó không đạt tới gì; object, array, string, number và boolean mỗi cái đúng khi nó đạt tới một giá trị thuộc loại đó. Giá trị cho phép: "present", "absent", "object", "array", "string", "number", "boolean" |
equals | string | không | Một chuỗi mà giá trị đường dẫn đạt tới phải bằng chính xác. Một giá trị không phải chuỗi thì không bao giờ bằng nó. Mỗi vị từ khai báo nhiều nhất một trong equals và prefix, và một vị từ khai báo cả hai sẽ bị từ chối khi nạp. Dài ít nhất 1 ký tự. |
prefix | string | không | Một chuỗi mà giá trị đường dẫn đạt tới phải bắt đầu bằng. Một giá trị không phải chuỗi thì không bao giờ bắt đầu bằng nó. Mỗi vị từ khai báo nhiều nhất một trong equals và prefix, và một vị từ khai báo cả hai sẽ bị từ chối khi nạp. Dài ít nhất 1 ký tự. |
Không cho phép thuộc tính bổ sung.