monosmith-plugin-sdk 0.5.0__tar.gz → 2.0.0b2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of monosmith-plugin-sdk might be problematic. Click here for more details.
- {monosmith_plugin_sdk-0.5.0/src/monosmith_plugin_sdk.egg-info → monosmith_plugin_sdk-2.0.0b2}/PKG-INFO +1 -1
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/pyproject.toml +1 -1
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/__init__.py +4 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/protocol/protocol_schema_contract.py +355 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/protocol/protocol_types_contract.py +326 -4
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/__init__.py +4 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/plugin_contract.py +16 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/plugin_members_config.py +2 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2/src/monosmith_plugin_sdk.egg-info}/PKG-INFO +1 -1
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/LICENSE +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/README.md +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/setup.cfg +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/build_dir/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/build_dir/build_dir_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/cancellation/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/cancellation/cancel_token_model.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/cancellation/request_cancelled_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/ci/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/ci/ci_contribution_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/encode_by_schema_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/encode_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/encode_json_value_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/message_parse_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/method_codec_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/normalize_by_schema_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/params_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/received_message_contract.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/schema_lookup_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/codec/wire_message_mapper.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/concurrency/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/concurrency/concurrency_policy.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/check_generation_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/check_kind_change_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/check_plugin_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/check_scheduling_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/conformance_report_model.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/find_manifests_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/conformance/go_list_mapper.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/framing/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/framing/frame_message_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/framing/frame_reader_store.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/framing/framing_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/host/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/host/call_interrupted_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/host/connect_plugin_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/host/host_options_contract.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/host/plugin_client_client.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/host/start_plugin_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/jsondoc/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/jsondoc/indent_raw_json_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/jsondoc/json_document_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/jsondoc/json_document_model.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/jsondoc/scan_json_object_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/plugin_refs/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/plugin_refs/plugin_ref_policy.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/plugin_roles/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/plugin_roles/plugin_role_policy.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/projects/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/projects/audit_settings_policy.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/projects/manifest_match_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/projects/project_kind_policy.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/projects/publishes_policy.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/projects/set_toolchain_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/projects/stack_plugins_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/protocol/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/protocol/rpc_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/py.typed +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/scaffold/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/scaffold/scaffold_data_mapper.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/scaffold/scaffold_project_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/capabilities_of_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/claim_stdio_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/dispatch_request_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/frame_writer_store.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/initialize_plugin_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/protocol_streams_contract.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/request_outcome_contract.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/request_pool_store.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/serve/serve_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/tasks/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/tasks/contribute_tasks_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/tasks/task_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/__init__.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/file_exists_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/parse_template_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/render_template_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/template_error.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/template_functions_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/template_syntax_contract.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/tokenize_action_algorithm.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/templating/write_templates_use_case.py +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk.egg-info/SOURCES.txt +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk.egg-info/dependency_links.txt +0 -0
- {monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: monosmith-plugin-sdk
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 2.0.0b2
|
|
4
4
|
Summary: The Python SDK for writing smith plugins: the protocol's types, the serve loop, a test host, the conformance checks, templating and key-order-keeping JSON editing. No runtime dependencies.
|
|
5
5
|
Author: Eduardo Russo
|
|
6
6
|
License-Expression: MIT
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "monosmith-plugin-sdk"
|
|
7
|
-
version = "0.
|
|
7
|
+
version = "2.0.0-beta.2"
|
|
8
8
|
description = "The Python SDK for writing smith plugins: the protocol's types, the serve loop, a test host, the conformance checks, templating and key-order-keeping JSON editing. No runtime dependencies."
|
|
9
9
|
readme = "README.md"
|
|
10
10
|
requires-python = ">=3.10"
|
{monosmith_plugin_sdk-0.5.0 → monosmith_plugin_sdk-2.0.0b2}/src/monosmith_plugin_sdk/__init__.py
RENAMED
|
@@ -90,11 +90,13 @@ from .projects import (
|
|
|
90
90
|
from .protocol import * # noqa: F403
|
|
91
91
|
from .scaffold import scaffold_data, scaffold_project
|
|
92
92
|
from .serve import (
|
|
93
|
+
APISurfaceReader,
|
|
93
94
|
CIContributor,
|
|
94
95
|
ComponentLister,
|
|
95
96
|
Contributor,
|
|
96
97
|
DeclarationEditor,
|
|
97
98
|
DependencyManager,
|
|
99
|
+
Deriver,
|
|
98
100
|
Discoverer,
|
|
99
101
|
DoctorContributor,
|
|
100
102
|
Generator,
|
|
@@ -128,6 +130,8 @@ __all__ = [
|
|
|
128
130
|
"Remover",
|
|
129
131
|
"KindChanger",
|
|
130
132
|
"DependencyManager",
|
|
133
|
+
"Deriver",
|
|
134
|
+
"APISurfaceReader",
|
|
131
135
|
"ComponentLister",
|
|
132
136
|
"DeclarationEditor",
|
|
133
137
|
"LatestReader",
|
|
@@ -230,6 +230,28 @@ _SCHEMA_JSON = r'''{
|
|
|
230
230
|
},
|
|
231
231
|
"capability": "components",
|
|
232
232
|
"notification": false
|
|
233
|
+
},
|
|
234
|
+
"derive": {
|
|
235
|
+
"description": "Asks which files a plugin derives from facts and the project graph (a tsconfig's references, a test config's display name). The plugin writes nothing: it answers with the content, and the host rewrites a file only when its ownership record allows.",
|
|
236
|
+
"params": {
|
|
237
|
+
"$ref": "#/$defs/DeriveParams"
|
|
238
|
+
},
|
|
239
|
+
"result": {
|
|
240
|
+
"$ref": "#/$defs/DeriveResult"
|
|
241
|
+
},
|
|
242
|
+
"capability": "derive",
|
|
243
|
+
"notification": false
|
|
244
|
+
},
|
|
245
|
+
"api/surface": {
|
|
246
|
+
"description": "Asks for the public API names of a project, at the working tree or at a git revision (its last release tag), so a release can compare them and say what bump the change needs.",
|
|
247
|
+
"params": {
|
|
248
|
+
"$ref": "#/$defs/APISurfaceParams"
|
|
249
|
+
},
|
|
250
|
+
"result": {
|
|
251
|
+
"$ref": "#/$defs/APISurfaceResult"
|
|
252
|
+
},
|
|
253
|
+
"capability": "apiSurface",
|
|
254
|
+
"notification": false
|
|
233
255
|
}
|
|
234
256
|
},
|
|
235
257
|
"x-errorCodes": [
|
|
@@ -310,6 +332,42 @@ _SCHEMA_JSON = r'''{
|
|
|
310
332
|
}
|
|
311
333
|
],
|
|
312
334
|
"$defs": {
|
|
335
|
+
"APISurfaceParams": {
|
|
336
|
+
"description": "APISurfaceParams asks a plugin for the public API names of one project.",
|
|
337
|
+
"type": "object",
|
|
338
|
+
"properties": {
|
|
339
|
+
"project": {
|
|
340
|
+
"$ref": "#/$defs/Project"
|
|
341
|
+
},
|
|
342
|
+
"ref": {
|
|
343
|
+
"type": "string",
|
|
344
|
+
"description": "Ref is the git revision to read the project at (the tag of its last release). Empty means the working tree."
|
|
345
|
+
}
|
|
346
|
+
},
|
|
347
|
+
"required": [
|
|
348
|
+
"project"
|
|
349
|
+
]
|
|
350
|
+
},
|
|
351
|
+
"APISurfaceResult": {
|
|
352
|
+
"description": "APISurfaceResult is the public API of a project: the names its entry points export. A host compares the names of two revisions; it never reads their meaning, so a plugin chooses its own spelling and keeps it stable.",
|
|
353
|
+
"type": "object",
|
|
354
|
+
"properties": {
|
|
355
|
+
"names": {
|
|
356
|
+
"type": "array",
|
|
357
|
+
"items": {
|
|
358
|
+
"type": "string"
|
|
359
|
+
},
|
|
360
|
+
"description": "Names are the exported names, sorted. A name an entry point other than the main one exports is prefixed with that entry point and a colon (\"./cli:run\"). An empty list is an answer: the project exports nothing."
|
|
361
|
+
},
|
|
362
|
+
"unreadable": {
|
|
363
|
+
"type": "string",
|
|
364
|
+
"description": "Unreadable says why the API could not be listed (no entry point, no source at the revision). When set, Names is empty and the host skips the project without a warning."
|
|
365
|
+
}
|
|
366
|
+
},
|
|
367
|
+
"required": [
|
|
368
|
+
"names"
|
|
369
|
+
]
|
|
370
|
+
},
|
|
313
371
|
"ActionStep": {
|
|
314
372
|
"description": "ActionStep is a provider-native step: a GitHub action or an Azure task, with its inputs in the order they are written.",
|
|
315
373
|
"type": "object",
|
|
@@ -558,6 +616,18 @@ _SCHEMA_JSON = r'''{
|
|
|
558
616
|
"components": {
|
|
559
617
|
"type": "boolean",
|
|
560
618
|
"description": "Components lists a project's dependencies for its SBOM."
|
|
619
|
+
},
|
|
620
|
+
"derive": {
|
|
621
|
+
"type": "boolean",
|
|
622
|
+
"description": "Derive says which files the plugin derives from facts and the project graph (smith derive)."
|
|
623
|
+
},
|
|
624
|
+
"apiSurface": {
|
|
625
|
+
"type": "boolean",
|
|
626
|
+
"description": "APISurface lists the names a project exports, at a git revision, so a release can warn when the commits ask for a smaller bump than the API change needs."
|
|
627
|
+
},
|
|
628
|
+
"channels": {
|
|
629
|
+
"type": "boolean",
|
|
630
|
+
"description": "Channels says a prerelease version the plugin publishes never takes the place of the stable one: the plugin publishes under PublishParams.Tag, a release channel's name, without moving the registry's stable pointer (npm's latest), or its registry orders a prerelease below the release (PyPI, NuGet) and needs no tag. A host does not publish a package of a release channel with a plugin that lacks it."
|
|
561
631
|
}
|
|
562
632
|
}
|
|
563
633
|
},
|
|
@@ -615,6 +685,68 @@ _SCHEMA_JSON = r'''{
|
|
|
615
685
|
}
|
|
616
686
|
}
|
|
617
687
|
},
|
|
688
|
+
"Choice": {
|
|
689
|
+
"description": "Choice is one option on an axis of a project's make-up: a framework, a test runner, a style library. A plugin publishes the choices it owns in InitializeResult.Choices; the host checks a selection of them (smith add --with react,vitest,bootstrap) and turns it into a stack. What a choice writes (dependencies, tasks, files) stays with the plugin: the host never sees it.",
|
|
690
|
+
"type": "object",
|
|
691
|
+
"properties": {
|
|
692
|
+
"axis": {
|
|
693
|
+
"type": "string",
|
|
694
|
+
"description": "Axis is the question the choice answers: \"framework\", \"test\", \"style\", \"lint\". The plugins agree on the name; the host only compares it."
|
|
695
|
+
},
|
|
696
|
+
"name": {
|
|
697
|
+
"type": "string",
|
|
698
|
+
"description": "Name identifies the choice in a selection and is unique among the choices of all loaded plugins."
|
|
699
|
+
},
|
|
700
|
+
"description": {
|
|
701
|
+
"type": "string"
|
|
702
|
+
},
|
|
703
|
+
"language": {
|
|
704
|
+
"type": "string",
|
|
705
|
+
"description": "Language is the language plugin the choice applies to (\"node\")."
|
|
706
|
+
},
|
|
707
|
+
"roles": {
|
|
708
|
+
"type": "array",
|
|
709
|
+
"items": {
|
|
710
|
+
"$ref": "#/$defs/Role"
|
|
711
|
+
},
|
|
712
|
+
"description": "Roles are the roles the choice's plugin plays in a stack built from it: scaffold (it writes the project) and/or toolchain (it joins the toolchain). Empty means it only adds to what a plugin of the selection already writes, as a style does."
|
|
713
|
+
},
|
|
714
|
+
"needs": {
|
|
715
|
+
"type": "array",
|
|
716
|
+
"items": {
|
|
717
|
+
"type": "string"
|
|
718
|
+
},
|
|
719
|
+
"description": "Needs are axes that the selection must have a choice on. An axis the person leaves out is filled with the default of the axis."
|
|
720
|
+
},
|
|
721
|
+
"default": {
|
|
722
|
+
"type": "boolean",
|
|
723
|
+
"description": "Default marks the choice the host adds when a selection needs its axis and has no choice on it."
|
|
724
|
+
},
|
|
725
|
+
"many": {
|
|
726
|
+
"type": "boolean",
|
|
727
|
+
"description": "Many allows the choice next to other choices of its axis that are Many too. By default a selection has one choice per axis."
|
|
728
|
+
},
|
|
729
|
+
"requires": {
|
|
730
|
+
"type": "array",
|
|
731
|
+
"items": {
|
|
732
|
+
"type": "string"
|
|
733
|
+
},
|
|
734
|
+
"description": "Requires are choices that must be in the selection."
|
|
735
|
+
},
|
|
736
|
+
"conflicts": {
|
|
737
|
+
"type": "array",
|
|
738
|
+
"items": {
|
|
739
|
+
"type": "string"
|
|
740
|
+
},
|
|
741
|
+
"description": "Conflicts are choices that must not be in the selection."
|
|
742
|
+
}
|
|
743
|
+
},
|
|
744
|
+
"required": [
|
|
745
|
+
"axis",
|
|
746
|
+
"name",
|
|
747
|
+
"language"
|
|
748
|
+
]
|
|
749
|
+
},
|
|
618
750
|
"Component": {
|
|
619
751
|
"description": "Component is one dependency of a project.",
|
|
620
752
|
"type": "object",
|
|
@@ -729,6 +861,10 @@ _SCHEMA_JSON = r'''{
|
|
|
729
861
|
"release": {
|
|
730
862
|
"$ref": "#/$defs/ReleaseDefaults",
|
|
731
863
|
"description": "Release is how the project's release files are made, for a project that releases through GitHub releases and leaves them out of its smith.toml [projects.<name>.release] table; what the table sets wins."
|
|
864
|
+
},
|
|
865
|
+
"facts": {
|
|
866
|
+
"type": "object",
|
|
867
|
+
"description": "Facts are the plugin's default facts for the project: typed values under namespaced keys ({\"source.roots\": [\"src\"]}) that other settings and plugins read through the merged Project.Facts. They are the lowest scope: a [facts] table in smith.toml wins over them, and two plugins that publish different values for one key are an error that names both."
|
|
732
868
|
}
|
|
733
869
|
}
|
|
734
870
|
},
|
|
@@ -817,6 +953,28 @@ _SCHEMA_JSON = r'''{
|
|
|
817
953
|
"projects"
|
|
818
954
|
]
|
|
819
955
|
},
|
|
956
|
+
"DeclaredProject": {
|
|
957
|
+
"description": "DeclaredProject is a project smith.toml declares: a folder with no manifest.",
|
|
958
|
+
"type": "object",
|
|
959
|
+
"properties": {
|
|
960
|
+
"name": {
|
|
961
|
+
"type": "string",
|
|
962
|
+
"description": "Name is the project's name, the key of its [projects.<name>] table."
|
|
963
|
+
},
|
|
964
|
+
"root": {
|
|
965
|
+
"type": "string",
|
|
966
|
+
"description": "Root is the workspace-relative folder."
|
|
967
|
+
},
|
|
968
|
+
"kind": {
|
|
969
|
+
"$ref": "#/$defs/ProjectKind",
|
|
970
|
+
"description": "Kind is \"app\", \"lib\" or \"package\", or empty for the plugin's choice."
|
|
971
|
+
}
|
|
972
|
+
},
|
|
973
|
+
"required": [
|
|
974
|
+
"name",
|
|
975
|
+
"root"
|
|
976
|
+
]
|
|
977
|
+
},
|
|
820
978
|
"DeclaredResult": {
|
|
821
979
|
"description": "DeclaredResult is every declaration, and the version installed of each name where the plugin can tell.",
|
|
822
980
|
"type": "object",
|
|
@@ -856,6 +1014,114 @@ _SCHEMA_JSON = r'''{
|
|
|
856
1014
|
}
|
|
857
1015
|
}
|
|
858
1016
|
},
|
|
1017
|
+
"DeriveParams": {
|
|
1018
|
+
"description": "DeriveParams asks a plugin for the files it can derive from facts and the project graph. The plugin writes nothing: it answers with the content, and the host decides, from its ownership record, whether to write it.",
|
|
1019
|
+
"type": "object",
|
|
1020
|
+
"properties": {
|
|
1021
|
+
"projects": {
|
|
1022
|
+
"type": "array",
|
|
1023
|
+
"items": {
|
|
1024
|
+
"$ref": "#/$defs/Project"
|
|
1025
|
+
},
|
|
1026
|
+
"description": "Projects are the projects the plugin serves."
|
|
1027
|
+
},
|
|
1028
|
+
"graph": {
|
|
1029
|
+
"type": "object",
|
|
1030
|
+
"additionalProperties": {
|
|
1031
|
+
"type": "array",
|
|
1032
|
+
"items": {
|
|
1033
|
+
"type": "string"
|
|
1034
|
+
}
|
|
1035
|
+
},
|
|
1036
|
+
"description": "Graph maps a project name to the names of the projects it depends on inside the workspace, sorted. The host resolved these edges: a plugin does not repeat that work."
|
|
1037
|
+
},
|
|
1038
|
+
"owned": {
|
|
1039
|
+
"type": "array",
|
|
1040
|
+
"items": {
|
|
1041
|
+
"type": "string"
|
|
1042
|
+
},
|
|
1043
|
+
"description": "Owned are the workspace-relative paths the host's ownership record says smith owns. A plugin proposes such a file again even when it is missing on disk, so deleting a derived file and deriving restores it. A file that is not owned and not on disk is not proposed."
|
|
1044
|
+
}
|
|
1045
|
+
},
|
|
1046
|
+
"required": [
|
|
1047
|
+
"projects"
|
|
1048
|
+
]
|
|
1049
|
+
},
|
|
1050
|
+
"DeriveResult": {
|
|
1051
|
+
"description": "DeriveResult carries the files a plugin derives.",
|
|
1052
|
+
"type": "object",
|
|
1053
|
+
"properties": {
|
|
1054
|
+
"files": {
|
|
1055
|
+
"type": "array",
|
|
1056
|
+
"items": {
|
|
1057
|
+
"$ref": "#/$defs/DerivedFile"
|
|
1058
|
+
}
|
|
1059
|
+
},
|
|
1060
|
+
"diverging": {
|
|
1061
|
+
"type": "array",
|
|
1062
|
+
"items": {
|
|
1063
|
+
"$ref": "#/$defs/DivergentFile"
|
|
1064
|
+
},
|
|
1065
|
+
"description": "Diverging are files a renderer looked at and left alone because they differ from the shape their siblings share. They are not drift: the project owns them. The host shows them in `smith derive --explain` and in the doctor, and never writes them."
|
|
1066
|
+
}
|
|
1067
|
+
},
|
|
1068
|
+
"required": [
|
|
1069
|
+
"files"
|
|
1070
|
+
]
|
|
1071
|
+
},
|
|
1072
|
+
"DerivedFile": {
|
|
1073
|
+
"description": "DerivedFile is the content one renderer derives for one file.",
|
|
1074
|
+
"type": "object",
|
|
1075
|
+
"properties": {
|
|
1076
|
+
"project": {
|
|
1077
|
+
"type": "string",
|
|
1078
|
+
"description": "Project is the project the file belongs to."
|
|
1079
|
+
},
|
|
1080
|
+
"path": {
|
|
1081
|
+
"type": "string",
|
|
1082
|
+
"description": "Path is workspace-relative, with forward slashes."
|
|
1083
|
+
},
|
|
1084
|
+
"mode": {
|
|
1085
|
+
"type": "string",
|
|
1086
|
+
"description": "Mode is DeriveFile, DeriveRegion or DeriveKeys."
|
|
1087
|
+
},
|
|
1088
|
+
"renderer": {
|
|
1089
|
+
"type": "string",
|
|
1090
|
+
"description": "Renderer is the stable id of the renderer, for example \"node.tsconfig.references\". It names the region markers."
|
|
1091
|
+
},
|
|
1092
|
+
"version": {
|
|
1093
|
+
"type": "integer",
|
|
1094
|
+
"description": "Version is the renderer's version. A new version means new output for the same inputs, so the host rewrites an unedited file."
|
|
1095
|
+
},
|
|
1096
|
+
"content": {
|
|
1097
|
+
"type": "string",
|
|
1098
|
+
"description": "Content is the whole file (DeriveFile) or the lines of the region (DeriveRegion), without the markers. Unused for DeriveKeys."
|
|
1099
|
+
},
|
|
1100
|
+
"comment": {
|
|
1101
|
+
"type": "string",
|
|
1102
|
+
"description": "Comment is the line comment leader of the file (\"//\", \"#\"): the host writes a generated header after it in a DeriveFile. Empty for a format without comments, then the file has no header."
|
|
1103
|
+
},
|
|
1104
|
+
"format": {
|
|
1105
|
+
"type": "string",
|
|
1106
|
+
"description": "Format is \"json\" or \"toml\" for DeriveKeys."
|
|
1107
|
+
},
|
|
1108
|
+
"table": {
|
|
1109
|
+
"type": "string",
|
|
1110
|
+
"description": "Table is the TOML table that holds the keys (\"tool.smith\"); required for \"toml\", unused for \"json\", whose keys are the top-level ones."
|
|
1111
|
+
},
|
|
1112
|
+
"keys": {
|
|
1113
|
+
"type": "object",
|
|
1114
|
+
"description": "Keys are the owned keys and their values (DeriveKeys). A TOML value is a string, a number, a boolean or an array of those."
|
|
1115
|
+
}
|
|
1116
|
+
},
|
|
1117
|
+
"required": [
|
|
1118
|
+
"project",
|
|
1119
|
+
"path",
|
|
1120
|
+
"mode",
|
|
1121
|
+
"renderer",
|
|
1122
|
+
"version"
|
|
1123
|
+
]
|
|
1124
|
+
},
|
|
859
1125
|
"DevcontainerFeature": {
|
|
860
1126
|
"description": "DevcontainerFeature is a dev container feature and its options (https://containers.dev/features).",
|
|
861
1127
|
"type": "object",
|
|
@@ -884,6 +1150,13 @@ _SCHEMA_JSON = r'''{
|
|
|
884
1150
|
"items": {
|
|
885
1151
|
"type": "string"
|
|
886
1152
|
}
|
|
1153
|
+
},
|
|
1154
|
+
"declared": {
|
|
1155
|
+
"type": "array",
|
|
1156
|
+
"items": {
|
|
1157
|
+
"$ref": "#/$defs/DeclaredProject"
|
|
1158
|
+
},
|
|
1159
|
+
"description": "Declared are the projects smith.toml declares for this plugin's language ([projects.<name>] with a root and a language): folders with no manifest of their own, such as a program that is a package of the Go module above it. The plugin describes each one in its result, or answers with an error saying why it cannot."
|
|
887
1160
|
}
|
|
888
1161
|
},
|
|
889
1162
|
"required": [
|
|
@@ -905,6 +1178,34 @@ _SCHEMA_JSON = r'''{
|
|
|
905
1178
|
"projects"
|
|
906
1179
|
]
|
|
907
1180
|
},
|
|
1181
|
+
"DivergentFile": {
|
|
1182
|
+
"description": "DivergentFile is a file a renderer does not derive because the project made it differ from its siblings.",
|
|
1183
|
+
"type": "object",
|
|
1184
|
+
"properties": {
|
|
1185
|
+
"project": {
|
|
1186
|
+
"type": "string",
|
|
1187
|
+
"description": "Project is the project the file belongs to."
|
|
1188
|
+
},
|
|
1189
|
+
"path": {
|
|
1190
|
+
"type": "string",
|
|
1191
|
+
"description": "Path is workspace-relative, with forward slashes."
|
|
1192
|
+
},
|
|
1193
|
+
"renderer": {
|
|
1194
|
+
"type": "string",
|
|
1195
|
+
"description": "Renderer is the stable id of the renderer that compared the file."
|
|
1196
|
+
},
|
|
1197
|
+
"detail": {
|
|
1198
|
+
"type": "string",
|
|
1199
|
+
"description": "Detail says in a sentence how the file differs from its siblings."
|
|
1200
|
+
}
|
|
1201
|
+
},
|
|
1202
|
+
"required": [
|
|
1203
|
+
"project",
|
|
1204
|
+
"path",
|
|
1205
|
+
"renderer",
|
|
1206
|
+
"detail"
|
|
1207
|
+
]
|
|
1208
|
+
},
|
|
908
1209
|
"DoctorParams": {
|
|
909
1210
|
"description": "DoctorParams gives the plugin its projects to check.",
|
|
910
1211
|
"type": "object",
|
|
@@ -1121,6 +1422,24 @@ _SCHEMA_JSON = r'''{
|
|
|
1121
1422
|
"settings": {
|
|
1122
1423
|
"type": "object",
|
|
1123
1424
|
"description": "Settings are this plugin's own settings for the new project, from the recipe the project is created from (its settings.<plugin> table); the same table is later the plugin's entry in Project.Settings. Nil when there are none."
|
|
1425
|
+
},
|
|
1426
|
+
"facts": {
|
|
1427
|
+
"type": "object",
|
|
1428
|
+
"description": "Facts are the shared facts that hold for the new project, from smith.toml: [projects.<name>.facts] over [facts]. A key that is absent was set by no one: the plugin scaffolds its own default. Set by the host; read only."
|
|
1429
|
+
},
|
|
1430
|
+
"shape": {
|
|
1431
|
+
"type": "object",
|
|
1432
|
+
"additionalProperties": {
|
|
1433
|
+
"type": "string"
|
|
1434
|
+
},
|
|
1435
|
+
"description": "Shape is the dialect the new project should have: the facts (see Project.Shape) that most projects of its kind and language agree on, as the host counted them. A plugin applies the keys it follows (see InitializeResult.Follows) and ignores the rest. Nil when there is nothing to follow, or the person asked for a fresh project."
|
|
1436
|
+
},
|
|
1437
|
+
"choices": {
|
|
1438
|
+
"type": "array",
|
|
1439
|
+
"items": {
|
|
1440
|
+
"type": "string"
|
|
1441
|
+
},
|
|
1442
|
+
"description": "Choices are the choices (see Choice) the new project is built from, the stack's Choices, in the order they apply: a choice comes after those it requires. A plugin applies the choices it owns and ignores the rest. Absent when the stack is not a selection. Set by the host; read only."
|
|
1124
1443
|
}
|
|
1125
1444
|
},
|
|
1126
1445
|
"required": [
|
|
@@ -1257,6 +1576,20 @@ _SCHEMA_JSON = r'''{
|
|
|
1257
1576
|
"$ref": "#/$defs/ProjectKind"
|
|
1258
1577
|
},
|
|
1259
1578
|
"description": "Kinds are the project kinds the plugin can scaffold with generate. Absent or empty means all three (app, lib and package): what every plugin that says nothing does. A plugin that scaffolds only some, such as an app, lists them, so the host offers and the conformance suite asks for just those."
|
|
1579
|
+
},
|
|
1580
|
+
"follows": {
|
|
1581
|
+
"type": "array",
|
|
1582
|
+
"items": {
|
|
1583
|
+
"type": "string"
|
|
1584
|
+
},
|
|
1585
|
+
"description": "Follows are the shape keys (see Project.Shape) the plugin applies when it generates a project with GenerateParams.Shape. Where siblings split on a key, the host asks the person only for a key that a plugin of the stack follows. Absent means the plugin follows none."
|
|
1586
|
+
},
|
|
1587
|
+
"choices": {
|
|
1588
|
+
"type": "array",
|
|
1589
|
+
"items": {
|
|
1590
|
+
"$ref": "#/$defs/Choice"
|
|
1591
|
+
},
|
|
1592
|
+
"description": "Choices are the options on an axis (framework, test, style) the plugin owns. The host lists them (smith choices) and checks a selection of them (smith add --with). Absent means the plugin owns none."
|
|
1260
1593
|
}
|
|
1261
1594
|
},
|
|
1262
1595
|
"required": [
|
|
@@ -1501,6 +1834,13 @@ _SCHEMA_JSON = r'''{
|
|
|
1501
1834
|
},
|
|
1502
1835
|
"description": "Settings are plugins' settings for this project from smith.toml, by plugin name: [projects.<project>.settings.<name>] (what a recipe's settings became when it created the project), and for a convention its [conventions.<name>] settings and the project's [projects.<project>.<name>] on top. Set by the host; a plugin reads its own entry."
|
|
1503
1836
|
},
|
|
1837
|
+
"shape": {
|
|
1838
|
+
"type": "object",
|
|
1839
|
+
"additionalProperties": {
|
|
1840
|
+
"type": "string"
|
|
1841
|
+
},
|
|
1842
|
+
"description": "Shape is the dialect of the project: named facts about how it is made (\"build.tool\": \"esbuild\", \"test.runner\": \"@swc/jest\", \"exports.target\": \"dist\"), each a short string, read from the manifest and files the plugin already reads in discovery. The host counts the shapes of the projects of one kind and language to let a new project follow what they do, and knows no key itself. Nil when the plugin does not describe shapes."
|
|
1843
|
+
},
|
|
1504
1844
|
"registries": {
|
|
1505
1845
|
"$ref": "#/$defs/Registries",
|
|
1506
1846
|
"description": "Registries are the private registries the project installs from and publishes to, from smith.toml [registries]; nil means the public ones. Set by the host."
|
|
@@ -1508,6 +1848,10 @@ _SCHEMA_JSON = r'''{
|
|
|
1508
1848
|
"releaseAssets": {
|
|
1509
1849
|
"$ref": "#/$defs/AssetSpec",
|
|
1510
1850
|
"description": "ReleaseAssets is what an app's release builds, from smith.toml [projects.<project>.release]: the platforms and file names, so a plugin can check (doctor) and prepare (CI) for them. Nil for a project that has no release files. Set by the host."
|
|
1851
|
+
},
|
|
1852
|
+
"facts": {
|
|
1853
|
+
"type": "object",
|
|
1854
|
+
"description": "Facts are the shared facts that hold for the project, merged by the host, narrowest scope first: [projects.<name>.facts], then [facts], then the defaults plugins published through Contribution.Facts. A key that is absent was set by no one: the plugin uses its own default. A request made before every plugin has contributed carries the smith.toml facts and the defaults published so far. Set by the host; read only."
|
|
1511
1855
|
}
|
|
1512
1856
|
},
|
|
1513
1857
|
"required": [
|
|
@@ -1557,6 +1901,10 @@ _SCHEMA_JSON = r'''{
|
|
|
1557
1901
|
},
|
|
1558
1902
|
"branch": {
|
|
1559
1903
|
"type": "string"
|
|
1904
|
+
},
|
|
1905
|
+
"tag": {
|
|
1906
|
+
"type": "string",
|
|
1907
|
+
"description": "Tag is the name of the release channel the version belongs to (npm's dist-tag \"beta\"). When set, the plugin publishes under it and leaves the registry's stable pointer where it is, or ignores it when its registry has no such pointer. Only sent to a plugin with the channels capability."
|
|
1560
1908
|
}
|
|
1561
1909
|
},
|
|
1562
1910
|
"required": [
|
|
@@ -1936,6 +2284,13 @@ _SCHEMA_JSON = r'''{
|
|
|
1936
2284
|
"items": {
|
|
1937
2285
|
"type": "string"
|
|
1938
2286
|
}
|
|
2287
|
+
},
|
|
2288
|
+
"choices": {
|
|
2289
|
+
"type": "array",
|
|
2290
|
+
"items": {
|
|
2291
|
+
"type": "string"
|
|
2292
|
+
},
|
|
2293
|
+
"description": "Choices make the stack a saved selection (see Choice). When they are set, the host derives the language, the scaffold and the toolchain from them, and Toolchain lists only the plugins to add after those. The plugins of the stack get the choices in GenerateParams.Choices."
|
|
1939
2294
|
}
|
|
1940
2295
|
},
|
|
1941
2296
|
"required": [
|