@manifest-configuration-language/language 0.1.5 → 0.1.6

package/README.md

@@ -2,6 +2,8 @@
 
 `@manifest-configuration-language/language` contains the MCL TextMate grammar and a Lezer-backed CodeMirror `LanguageSupport` export with standard bracket completion.
 
+The matching MCL release's CLI and standard-library reference Markdown is included under `reference/`.
+
 ```js
 import { mclLanguageSupport } from "@manifest-configuration-language/language";
 import mclTextMateGrammar from "@manifest-configuration-language/language/textmate" with { type: "json" };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@manifest-configuration-language/language",
-  "version": "0.1.5",
+  "version": "0.1.6",
   "description": "MCL TextMate grammar and CodeMirror language support.",
   "repository": {
     "type": "git",
@@ -11,6 +11,7 @@
   "license": "Apache-2.0",
   "files": [
     "src",
+    "reference",
     "README.md"
   ],
   "exports": {

package/reference/cli/mcl.md

@@ -0,0 +1,27 @@
+## mcl
+
+Manifest Configuration Language CLI
+
+```
+mcl [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for mcl
+```
+
+### SEE ALSO
+
+* [mcl check](mcl_check.md)	 - Validate rendered resources
+* [mcl completion](mcl_completion.md)	 - Generate shell completion scripts
+* [mcl diff](mcl_diff.md)	 - Compare rendered resources
+* [mcl explain](mcl_explain.md)	 - Explain a resource field and its source
+* [mcl fmt](mcl_fmt.md)	 - Format an MCL source file
+* [mcl lint](mcl_lint.md)	 - Report source diagnostics
+* [mcl lsp](mcl_lsp.md)	 - Start the Language Server Protocol server
+* [mcl render](mcl_render.md)	 - Render Kubernetes resources
+* [mcl update](mcl_update.md)	 - Update external dependencies and lock data
+* [mcl version](mcl_version.md)	 - Print build version information
+

package/reference/cli/mcl_check.md

@@ -0,0 +1,19 @@
+## mcl check
+
+Validate rendered resources
+
+```
+mcl check <file> [flags]
+```
+
+### Options
+
+```
+  -h, --help               help for check
+      --operation string   operation to check
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_completion.md

@@ -0,0 +1,26 @@
+## mcl completion
+
+Generate shell completion scripts
+
+### Synopsis
+
+Generate a completion script for the specified shell. Supported shells are bash, zsh, fish, and powershell.
+
+Examples:
+  mcl completion bash > mcl-completion.bash
+  source <(mcl completion bash)
+
+```
+mcl completion <bash|zsh|fish|powershell> [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for completion
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_diff.md

@@ -0,0 +1,19 @@
+## mcl diff
+
+Compare rendered resources
+
+```
+mcl diff <before-file> <after-file> [flags]
+```
+
+### Options
+
+```
+  -h, --help               help for diff
+      --operation string   operation to compare
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_explain.md

@@ -0,0 +1,25 @@
+## mcl explain
+
+Explain a resource field and its source
+
+```
+mcl explain <file> [flags]
+```
+
+### Options
+
+```
+      --api-version string   Kubernetes API version (required)
+  -h, --help                 help for explain
+      --kind string          Kubernetes resource kind (required)
+      --name string          Kubernetes resource name (required)
+      --namespace string     Kubernetes namespace
+      --operation string     operation to inspect
+      --path string          JSON Pointer within the resource
+      --phase string         lifecycle phase to inspect (default "main")
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_fmt.md

@@ -0,0 +1,20 @@
+## mcl fmt
+
+Format an MCL source file
+
+```
+mcl fmt <file> [flags]
+```
+
+### Options
+
+```
+      --check   return an error when source is not formatted
+  -h, --help    help for fmt
+  -w, --write   write formatted source to the input file
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_lint.md

@@ -0,0 +1,19 @@
+## mcl lint
+
+Report source diagnostics
+
+```
+mcl lint <file...> [flags]
+```
+
+### Options
+
+```
+      --deny-warnings   return an error when warnings are found
+  -h, --help            help for lint
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_lsp.md

@@ -0,0 +1,18 @@
+## mcl lsp
+
+Start the Language Server Protocol server
+
+```
+mcl lsp [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for lsp
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_render.md

@@ -0,0 +1,26 @@
+## mcl render
+
+Render Kubernetes resources
+
+### Synopsis
+
+Render one lifecycle phase or operation. --operation and --phase cannot be combined. --operation requires --output-dir.
+
+```
+mcl render <file> [flags]
+```
+
+### Options
+
+```
+      --format string       output format (yaml or json) (default "yaml")
+  -h, --help                help for render
+      --operation string    operation to render
+      --output-dir string   directory for operation output files
+      --phase string        lifecycle phase to render
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_update.md

@@ -0,0 +1,18 @@
+## mcl update
+
+Update external dependencies and lock data
+
+```
+mcl update [file] [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for update
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/cli/mcl_version.md

@@ -0,0 +1,18 @@
+## mcl version
+
+Print build version information
+
+```
+mcl version [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for version
+```
+
+### SEE ALSO
+
+* [mcl](mcl.md)	 - Manifest Configuration Language CLI
+

package/reference/stdlib-functions.md

@@ -0,0 +1,25 @@
+# Standard library function reference
+
+MCL version: `0.1.6`
+
+Function names, modules, and parameter names are generated from the standard-library registry. Function behavior and type semantics are documented in the hand-written language reference.
+
+| Module | Function | Parameters |
+| --- | --- | --- |
+| `std:core` | `len` | `value` |
+| `std:core` | `replace` | `value` |
+| `std:core` | `clone` | `value` |
+| `std:list` | `contains` | `values`, `value` |
+| `std:list` | `concat` | `first`, `second` |
+| `std:list` | `union` | `first`, `second` |
+| `std:list` | `replaceAt` | `values`, `index`, `value` |
+| `std:list` | `mergeByKey` | `existing`, `overrides`, `key` |
+| `std:list` | `map` | `values`, `transform` |
+| `std:list` | `filter` | `values`, `predicate` |
+| `std:list` | `exactlyOne` | `values`, `predicate` |
+| `std:list` | `fold` | `values`, `initial`, `combine` |
+| `std:map` | `keyOf` | `mapping`, `key` |
+| `std:kustomize` | `build` | `source`, `revision`, `directory` |
+| `std:manifest` | `load` | `source` |
+| `std:helm` | `render` | `source`, `options` |
+| `std:lifecycle` | `attach` | `value`, `events`, `priority`, `wait`, `cleanup` |