@savvy-web/mcp 1.3.3 → 1.3.5
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.
- package/LICENSE +21 -0
- package/README.md +2 -2
- package/{public/content → content}/guides/api-docs-from-api-extractor.md +47 -33
- package/{public/content → content}/guides/building-a-github-action.md +2 -2
- package/content/guides/choosing-a-builder.md +93 -0
- package/content/manifest.json +10538 -0
- package/content/packages/bundler/api/function/build.md +18 -0
- package/content/packages/bundler/api/function/definebuild.md +18 -0
- package/content/packages/bundler/api/function/parseargs.md +18 -0
- package/content/packages/bundler/api/function/runbuild.md +18 -0
- package/content/packages/bundler/api/interface/buildconfig.md +147 -0
- package/content/packages/bundler/api/interface/buildconfiginput.md +153 -0
- package/content/packages/bundler/api/interface/buildentryoverride.md +86 -0
- package/content/packages/bundler/api/interface/outputconfig.md +34 -0
- package/content/packages/bundler/api/interface/parsedargs.md +44 -0
- package/content/packages/bundler/api/interface/runoptions.md +158 -0
- package/content/packages/bundler/api.md +28 -0
- package/content/packages/bundler/overview.md +89 -0
- package/content/packages/github-action-builder/api/class/actionymlmissing.md +30 -0
- package/content/packages/github-action-builder/api/class/actionymlpatherror.md +48 -0
- package/content/packages/github-action-builder/api/class/actionymlschemaerror.md +45 -0
- package/content/packages/github-action-builder/api/class/actionymlsyntaxerror.md +57 -0
- package/content/packages/github-action-builder/api/class/buildfailed.md +39 -0
- package/content/packages/github-action-builder/api/class/bundlefailed.md +39 -0
- package/content/packages/github-action-builder/api/class/cleanerror.md +39 -0
- package/content/packages/github-action-builder/api/class/configinvalid.md +39 -0
- package/content/packages/github-action-builder/api/class/configloadfailed.md +39 -0
- package/content/packages/github-action-builder/api/class/confignotfound.md +39 -0
- package/content/packages/github-action-builder/api/class/entryfilemissing.md +39 -0
- package/content/packages/github-action-builder/api/class/githubaction.md +101 -0
- package/content/packages/github-action-builder/api/class/mainentrymissing.md +39 -0
- package/content/packages/github-action-builder/api/class/persistlocalerror.md +39 -0
- package/content/packages/github-action-builder/api/class/validationfailed.md +48 -0
- package/content/packages/github-action-builder/api/class/workerentryinvalidname.md +37 -0
- package/content/packages/github-action-builder/api/class/workerentrymissing.md +44 -0
- package/content/packages/github-action-builder/api/class/writeerror.md +39 -0
- package/content/packages/github-action-builder/api/function/defineconfig.md +68 -0
- package/content/packages/github-action-builder/api/interface/buildservice.md +83 -0
- package/content/packages/github-action-builder/api/interface/configservice.md +66 -0
- package/content/packages/github-action-builder/api/interface/githubactionoptions.md +60 -0
- package/content/packages/github-action-builder/api/interface/loadconfigresult.md +44 -0
- package/content/packages/github-action-builder/api/interface/persistlocalservice.md +37 -0
- package/content/packages/github-action-builder/api/interface/validationservice.md +82 -0
- package/content/packages/github-action-builder/api/type/actionymlresult.md +18 -0
- package/content/packages/github-action-builder/api/type/apperror.md +18 -0
- package/content/packages/github-action-builder/api/type/builderror.md +18 -0
- package/content/packages/github-action-builder/api/type/buildoptions.md +18 -0
- package/content/packages/github-action-builder/api/type/buildresult.md +18 -0
- package/content/packages/github-action-builder/api/type/buildrunneroptions.md +18 -0
- package/content/packages/github-action-builder/api/type/bundleresult.md +18 -0
- package/content/packages/github-action-builder/api/type/bundlestats.md +18 -0
- package/content/packages/github-action-builder/api/type/config.md +18 -0
- package/content/packages/github-action-builder/api/type/configerror.md +18 -0
- package/content/packages/github-action-builder/api/type/configinput.md +18 -0
- package/content/packages/github-action-builder/api/type/detectedentry.md +18 -0
- package/content/packages/github-action-builder/api/type/detectentriesresult.md +18 -0
- package/content/packages/github-action-builder/api/type/entries.md +18 -0
- package/content/packages/github-action-builder/api/type/githubactionbuildresult.md +18 -0
- package/content/packages/github-action-builder/api/type/loadconfigoptions.md +18 -0
- package/content/packages/github-action-builder/api/type/persisterror.md +18 -0
- package/content/packages/github-action-builder/api/type/persistlocaloptions.md +18 -0
- package/content/packages/github-action-builder/api/type/persistlocalresult.md +18 -0
- package/content/packages/github-action-builder/api/type/persistlocalrunneroptions.md +18 -0
- package/content/packages/github-action-builder/api/type/validateoptions.md +18 -0
- package/content/packages/github-action-builder/api/type/validationerror.md +20 -0
- package/content/packages/github-action-builder/api/type/validationerroritem.md +18 -0
- package/content/packages/github-action-builder/api/type/validationoptions.md +18 -0
- package/content/packages/github-action-builder/api/type/validationresult.md +18 -0
- package/content/packages/github-action-builder/api/type/validationwarning.md +18 -0
- package/content/packages/github-action-builder/api/variable/actionymlmissingbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/actionymlpatherrorbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/actionymlresultschema.md +33 -0
- package/content/packages/github-action-builder/api/variable/actionymlschemaerrorbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/actionymlsyntaxerrorbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/applayer.md +38 -0
- package/content/packages/github-action-builder/api/variable/buildfailedbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/buildlayer.md +18 -0
- package/content/packages/github-action-builder/api/variable/buildoptionsschema.md +31 -0
- package/content/packages/github-action-builder/api/variable/buildresultschema.md +32 -0
- package/content/packages/github-action-builder/api/variable/buildrunneroptionsschema.md +21 -0
- package/content/packages/github-action-builder/api/variable/buildservice.md +18 -0
- package/content/packages/github-action-builder/api/variable/bundlefailedbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/bundleresultschema.md +27 -0
- package/content/packages/github-action-builder/api/variable/bundlestatsschema.md +23 -0
- package/content/packages/github-action-builder/api/variable/cleanerrorbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/configinputschema.md +41 -0
- package/content/packages/github-action-builder/api/variable/configinvalidbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/configlayer.md +18 -0
- package/content/packages/github-action-builder/api/variable/configloadfailedbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/confignotfoundbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/configschema.md +59 -0
- package/content/packages/github-action-builder/api/variable/configservice.md +18 -0
- package/content/packages/github-action-builder/api/variable/detectedentryschema.md +22 -0
- package/content/packages/github-action-builder/api/variable/detectentriesresultschema.md +25 -0
- package/content/packages/github-action-builder/api/variable/entriesschema.md +25 -0
- package/content/packages/github-action-builder/api/variable/entryfilemissingbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/githubactionbuildresultschema.md +60 -0
- package/content/packages/github-action-builder/api/variable/loadconfigoptionsschema.md +21 -0
- package/content/packages/github-action-builder/api/variable/mainentrymissingbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/persistlocalerrorbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/persistlocallayer.md +18 -0
- package/content/packages/github-action-builder/api/variable/persistlocaloptionsschema.md +28 -0
- package/content/packages/github-action-builder/api/variable/persistlocalresultschema.md +25 -0
- package/content/packages/github-action-builder/api/variable/persistlocalrunneroptionsschema.md +20 -0
- package/content/packages/github-action-builder/api/variable/persistlocalservice.md +18 -0
- package/content/packages/github-action-builder/api/variable/validateoptionsschema.md +21 -0
- package/content/packages/github-action-builder/api/variable/validationerrorschema.md +23 -0
- package/content/packages/github-action-builder/api/variable/validationfailedbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/validationlayer.md +18 -0
- package/content/packages/github-action-builder/api/variable/validationoptionsschema.md +24 -0
- package/content/packages/github-action-builder/api/variable/validationresultschema.md +32 -0
- package/content/packages/github-action-builder/api/variable/validationservice.md +18 -0
- package/content/packages/github-action-builder/api/variable/validationwarningschema.md +23 -0
- package/content/packages/github-action-builder/api/variable/workerentryinvalidnamebase.md +20 -0
- package/content/packages/github-action-builder/api/variable/workerentrymissingbase.md +20 -0
- package/content/packages/github-action-builder/api/variable/writeerrorbase.md +20 -0
- package/content/packages/github-action-builder/api.md +125 -0
- package/content/packages/github-action-effects/api/class/actioncache.md +18 -0
- package/content/packages/github-action-effects/api/class/actioncacheerror.md +44 -0
- package/content/packages/github-action-effects/api/class/actionenvironment.md +18 -0
- package/content/packages/github-action-effects/api/class/actionenvironmenterror.md +37 -0
- package/content/packages/github-action-effects/api/class/actioninputerror.md +44 -0
- package/content/packages/github-action-effects/api/class/actionlogger.md +18 -0
- package/content/packages/github-action-effects/api/class/actionoutputerror.md +37 -0
- package/content/packages/github-action-effects/api/class/actionoutputs.md +18 -0
- package/content/packages/github-action-effects/api/class/actionstate.md +18 -0
- package/content/packages/github-action-effects/api/class/actionstateerror.md +44 -0
- package/content/packages/github-action-effects/api/class/artifact.md +18 -0
- package/content/packages/github-action-effects/api/class/artifacterror.md +53 -0
- package/content/packages/github-action-effects/api/class/attest.md +18 -0
- package/content/packages/github-action-effects/api/class/attesterror.md +42 -0
- package/content/packages/github-action-effects/api/class/blobstore.md +18 -0
- package/content/packages/github-action-effects/api/class/blobstoreerror.md +44 -0
- package/content/packages/github-action-effects/api/class/changesetanalyzer.md +18 -0
- package/content/packages/github-action-effects/api/class/changeseterror.md +37 -0
- package/content/packages/github-action-effects/api/class/checkrun.md +18 -0
- package/content/packages/github-action-effects/api/class/checkrunerror.md +44 -0
- package/content/packages/github-action-effects/api/class/commandrunner.md +18 -0
- package/content/packages/github-action-effects/api/class/commandrunnererror.md +73 -0
- package/content/packages/github-action-effects/api/class/configloader.md +18 -0
- package/content/packages/github-action-effects/api/class/configloadererror.md +44 -0
- package/content/packages/github-action-effects/api/class/dryrun.md +18 -0
- package/content/packages/github-action-effects/api/class/gitbranch.md +18 -0
- package/content/packages/github-action-effects/api/class/gitbrancherror.md +44 -0
- package/content/packages/github-action-effects/api/class/gitcommit.md +18 -0
- package/content/packages/github-action-effects/api/class/gitcommiterror.md +37 -0
- package/content/packages/github-action-effects/api/class/githubapp.md +18 -0
- package/content/packages/github-action-effects/api/class/githubapperror.md +37 -0
- package/content/packages/github-action-effects/api/class/githubartifactmetadata.md +18 -0
- package/content/packages/github-action-effects/api/class/githubartifactmetadataerror.md +44 -0
- package/content/packages/github-action-effects/api/class/githubclient.md +18 -0
- package/content/packages/github-action-effects/api/class/githubclienterror.md +60 -0
- package/content/packages/github-action-effects/api/class/githubcommit.md +18 -0
- package/content/packages/github-action-effects/api/class/githubcommiterror.md +44 -0
- package/content/packages/github-action-effects/api/class/githubcontent.md +18 -0
- package/content/packages/github-action-effects/api/class/githubcontenterror.md +44 -0
- package/content/packages/github-action-effects/api/class/githubgraphql.md +18 -0
- package/content/packages/github-action-effects/api/class/githubgraphqlerror.md +48 -0
- package/content/packages/github-action-effects/api/class/githubissue.md +18 -0
- package/content/packages/github-action-effects/api/class/githubissueerror.md +51 -0
- package/content/packages/github-action-effects/api/class/githubrelease.md +18 -0
- package/content/packages/github-action-effects/api/class/githubreleaseerror.md +51 -0
- package/content/packages/github-action-effects/api/class/gittag.md +18 -0
- package/content/packages/github-action-effects/api/class/gittagerror.md +44 -0
- package/content/packages/github-action-effects/api/class/glob.md +18 -0
- package/content/packages/github-action-effects/api/class/globerror.md +44 -0
- package/content/packages/github-action-effects/api/class/intotostatement.md +18 -0
- package/content/packages/github-action-effects/api/class/intotosubject.md +18 -0
- package/content/packages/github-action-effects/api/class/ioerror.md +44 -0
- package/content/packages/github-action-effects/api/class/npmregistry.md +18 -0
- package/content/packages/github-action-effects/api/class/npmregistryerror.md +50 -0
- package/content/packages/github-action-effects/api/class/octokitauthapp.md +18 -0
- package/content/packages/github-action-effects/api/class/oidctokenerror.md +42 -0
- package/content/packages/github-action-effects/api/class/oidctokenissuer.md +18 -0
- package/content/packages/github-action-effects/api/class/packagemanageradapter.md +18 -0
- package/content/packages/github-action-effects/api/class/packagemanagererror.md +44 -0
- package/content/packages/github-action-effects/api/class/packagepublish.md +18 -0
- package/content/packages/github-action-effects/api/class/packagepublisherror.md +68 -0
- package/content/packages/github-action-effects/api/class/pullrequest.md +18 -0
- package/content/packages/github-action-effects/api/class/pullrequestcomment.md +18 -0
- package/content/packages/github-action-effects/api/class/pullrequestcommenterror.md +44 -0
- package/content/packages/github-action-effects/api/class/pullrequesterror.md +44 -0
- package/content/packages/github-action-effects/api/class/ratelimiter.md +18 -0
- package/content/packages/github-action-effects/api/class/ratelimiterror.md +51 -0
- package/content/packages/github-action-effects/api/class/runtimeenvironmenterror.md +37 -0
- package/content/packages/github-action-effects/api/class/sbom.md +18 -0
- package/content/packages/github-action-effects/api/class/sbomerror.md +42 -0
- package/content/packages/github-action-effects/api/class/semverresolvererror.md +44 -0
- package/content/packages/github-action-effects/api/class/sigstorebundle.md +18 -0
- package/content/packages/github-action-effects/api/class/sigstoresigner.md +18 -0
- package/content/packages/github-action-effects/api/class/sigstoresignererror.md +42 -0
- package/content/packages/github-action-effects/api/class/slsaerror.md +42 -0
- package/content/packages/github-action-effects/api/class/tokenpermissionchecker.md +18 -0
- package/content/packages/github-action-effects/api/class/tokenpermissionerror.md +58 -0
- package/content/packages/github-action-effects/api/class/toolinstaller.md +18 -0
- package/content/packages/github-action-effects/api/class/toolinstallererror.md +58 -0
- package/content/packages/github-action-effects/api/class/workflowdispatch.md +18 -0
- package/content/packages/github-action-effects/api/class/workflowdispatcherror.md +44 -0
- package/content/packages/github-action-effects/api/class/workspacedetector.md +18 -0
- package/content/packages/github-action-effects/api/class/workspacedetectorerror.md +35 -0
- package/content/packages/github-action-effects/api/function/attesttestfulllayer.md +19 -0
- package/content/packages/github-action-effects/api/function/buildslsaprovenancepredicate.md +23 -0
- package/content/packages/github-action-effects/api/function/buildstatement.md +29 -0
- package/content/packages/github-action-effects/api/function/decodejwtclaims.md +18 -0
- package/content/packages/github-action-effects/api/function/dryrunlive.md +18 -0
- package/content/packages/github-action-effects/api/function/generatepackageviewurl.md +27 -0
- package/content/packages/github-action-effects/api/function/getregistrydisplayname.md +26 -0
- package/content/packages/github-action-effects/api/function/getregistrytype.md +26 -0
- package/content/packages/github-action-effects/api/function/iscustomregistry.md +26 -0
- package/content/packages/github-action-effects/api/function/isgithubpackagesregistry.md +26 -0
- package/content/packages/github-action-effects/api/function/isjsrregistry.md +26 -0
- package/content/packages/github-action-effects/api/function/isnpmregistry.md +26 -0
- package/content/packages/github-action-effects/api/function/makeattestteststate.md +18 -0
- package/content/packages/github-action-effects/api/function/makesbomteststate.md +18 -0
- package/content/packages/github-action-effects/api/function/makesigstoresignerlive.md +18 -0
- package/content/packages/github-action-effects/api/function/npmpurl.md +18 -0
- package/content/packages/github-action-effects/api/function/resilienceschedule.md +18 -0
- package/content/packages/github-action-effects/api/function/s3blobstorelive.md +18 -0
- package/content/packages/github-action-effects/api/function/savetoken.md +18 -0
- package/content/packages/github-action-effects/api/function/serializestatement.md +18 -0
- package/content/packages/github-action-effects/api/function/subject.md +23 -0
- package/content/packages/github-action-effects/api/function/tokenpermissioncheckerlive.md +18 -0
- package/content/packages/github-action-effects/api/interface/accumulateresult.md +35 -0
- package/content/packages/github-action-effects/api/interface/actioncacheteststate.md +26 -0
- package/content/packages/github-action-effects/api/interface/actionloggerteststate.md +59 -0
- package/content/packages/github-action-effects/api/interface/actionoutputsteststate.md +56 -0
- package/content/packages/github-action-effects/api/interface/actionrunoptions.md +28 -0
- package/content/packages/github-action-effects/api/interface/actionstateteststate.md +28 -0
- package/content/packages/github-action-effects/api/interface/annotationproperties.md +68 -0
- package/content/packages/github-action-effects/api/interface/appauth.md +44 -0
- package/content/packages/github-action-effects/api/interface/artifactitem.md +44 -0
- package/content/packages/github-action-effects/api/interface/artifactteststate.md +38 -0
- package/content/packages/github-action-effects/api/interface/attestationlistentry.md +36 -0
- package/content/packages/github-action-effects/api/interface/attestationrecord.md +44 -0
- package/content/packages/github-action-effects/api/interface/attestinput.md +38 -0
- package/content/packages/github-action-effects/api/interface/attestteststate.md +111 -0
- package/content/packages/github-action-effects/api/interface/blobstoreteststate.md +26 -0
- package/content/packages/github-action-effects/api/interface/botidentity.md +32 -0
- package/content/packages/github-action-effects/api/interface/changesetanalyzerteststate.md +32 -0
- package/content/packages/github-action-effects/api/interface/checkrunannotation.md +56 -0
- package/content/packages/github-action-effects/api/interface/checkrundata.md +50 -0
- package/content/packages/github-action-effects/api/interface/checkrunoutput.md +44 -0
- package/content/packages/github-action-effects/api/interface/checkrunrecord.md +62 -0
- package/content/packages/github-action-effects/api/interface/checkrunteststate.md +32 -0
- package/content/packages/github-action-effects/api/interface/commandresponse.md +38 -0
- package/content/packages/github-action-effects/api/interface/commentrecord.md +32 -0
- package/content/packages/github-action-effects/api/interface/commitcomparison.md +32 -0
- package/content/packages/github-action-effects/api/interface/commitdetail.md +28 -0
- package/content/packages/github-action-effects/api/interface/commitfile.md +32 -0
- package/content/packages/github-action-effects/api/interface/commitsummary.md +38 -0
- package/content/packages/github-action-effects/api/interface/configloaderteststate.md +28 -0
- package/content/packages/github-action-effects/api/interface/dispatchrecord.md +38 -0
- package/content/packages/github-action-effects/api/interface/downloadoptions.md +28 -0
- package/content/packages/github-action-effects/api/interface/dryrunresult.md +60 -0
- package/content/packages/github-action-effects/api/interface/dryrunteststate.md +26 -0
- package/content/packages/github-action-effects/api/interface/execoptions.md +52 -0
- package/content/packages/github-action-effects/api/interface/execoutput.md +38 -0
- package/content/packages/github-action-effects/api/interface/findby.md +44 -0
- package/content/packages/github-action-effects/api/interface/gitbranchteststate.md +26 -0
- package/content/packages/github-action-effects/api/interface/gitcommitteststate.md +51 -0
- package/content/packages/github-action-effects/api/interface/githubappteststate.md +54 -0
- package/content/packages/github-action-effects/api/interface/githubartifactmetadatateststate.md +36 -0
- package/content/packages/github-action-effects/api/interface/githubclientteststate.md +47 -0
- package/content/packages/github-action-effects/api/interface/githubcommitteststate.md +52 -0
- package/content/packages/github-action-effects/api/interface/githubcontentteststate.md +28 -0
- package/content/packages/github-action-effects/api/interface/githubgraphqlteststate.md +52 -0
- package/content/packages/github-action-effects/api/interface/githubissueteststate.md +53 -0
- package/content/packages/github-action-effects/api/interface/githubreleaseteststate.md +52 -0
- package/content/packages/github-action-effects/api/interface/gittagteststate.md +41 -0
- package/content/packages/github-action-effects/api/interface/globoptions.md +52 -0
- package/content/packages/github-action-effects/api/interface/globteststate.md +32 -0
- package/content/packages/github-action-effects/api/interface/hashfilesoptions.md +36 -0
- package/content/packages/github-action-effects/api/interface/idempotentpublishinput.md +66 -0
- package/content/packages/github-action-effects/api/interface/idempotentpublishresult.md +48 -0
- package/content/packages/github-action-effects/api/interface/inflightpackage.md +38 -0
- package/content/packages/github-action-effects/api/interface/installoptions.md +36 -0
- package/content/packages/github-action-effects/api/interface/issuedata.md +60 -0
- package/content/packages/github-action-effects/api/interface/npmregistryteststate.md +32 -0
- package/content/packages/github-action-effects/api/interface/oidcclaims.md +98 -0
- package/content/packages/github-action-effects/api/interface/packagemanageradapterteststate.md +47 -0
- package/content/packages/github-action-effects/api/interface/packagepublishteststate.md +121 -0
- package/content/packages/github-action-effects/api/interface/packresult.md +84 -0
- package/content/packages/github-action-effects/api/interface/polloptions.md +36 -0
- package/content/packages/github-action-effects/api/interface/provenanceattestationinput.md +44 -0
- package/content/packages/github-action-effects/api/interface/provisionoptions.md +52 -0
- package/content/packages/github-action-effects/api/interface/publishtarballresult.md +28 -0
- package/content/packages/github-action-effects/api/interface/pullrequestcommentteststate.md +35 -0
- package/content/packages/github-action-effects/api/interface/pullrequestfile.md +32 -0
- package/content/packages/github-action-effects/api/interface/pullrequestinfo.md +106 -0
- package/content/packages/github-action-effects/api/interface/pullrequestlistoptions.md +60 -0
- package/content/packages/github-action-effects/api/interface/pullrequestrecord.md +74 -0
- package/content/packages/github-action-effects/api/interface/pullrequestteststate.md +54 -0
- package/content/packages/github-action-effects/api/interface/ratelimiterteststate.md +44 -0
- package/content/packages/github-action-effects/api/interface/registrytarget.md +52 -0
- package/content/packages/github-action-effects/api/interface/releaseasset.md +44 -0
- package/content/packages/github-action-effects/api/interface/releasedata.md +62 -0
- package/content/packages/github-action-effects/api/interface/report_2.md +76 -0
- package/content/packages/github-action-effects/api/interface/resilienceoptions.md +52 -0
- package/content/packages/github-action-effects/api/interface/resolveddependency.md +44 -0
- package/content/packages/github-action-effects/api/interface/restresponse.md +26 -0
- package/content/packages/github-action-effects/api/interface/s3blobstoreconfig.md +62 -0
- package/content/packages/github-action-effects/api/interface/sbomattestationinput.md +44 -0
- package/content/packages/github-action-effects/api/interface/sbomauthor.md +38 -0
- package/content/packages/github-action-effects/api/interface/sbomcontact.md +38 -0
- package/content/packages/github-action-effects/api/interface/sbominput.md +88 -0
- package/content/packages/github-action-effects/api/interface/sbomsupplier.md +44 -0
- package/content/packages/github-action-effects/api/interface/sbomteststate.md +52 -0
- package/content/packages/github-action-effects/api/interface/sigstoresignerconfig.md +32 -0
- package/content/packages/github-action-effects/api/interface/storagerecordinput.md +68 -0
- package/content/packages/github-action-effects/api/interface/tagref.md +34 -0
- package/content/packages/github-action-effects/api/interface/tokenpermissioncheckerteststate.md +32 -0
- package/content/packages/github-action-effects/api/interface/toolinstallerteststate.md +97 -0
- package/content/packages/github-action-effects/api/interface/uploadoptions.md +36 -0
- package/content/packages/github-action-effects/api/interface/uploadresult.md +32 -0
- package/content/packages/github-action-effects/api/interface/workflowdispatchteststate.md +40 -0
- package/content/packages/github-action-effects/api/interface/workflowrunstatus.md +32 -0
- package/content/packages/github-action-effects/api/interface/workspacedetectorteststate.md +32 -0
- package/content/packages/github-action-effects/api/namespace/step.md +16 -0
- package/content/packages/github-action-effects/api/type/actionloglevel.md +16 -0
- package/content/packages/github-action-effects/api/type/annotationlevel.md +18 -0
- package/content/packages/github-action-effects/api/type/bumptype.md +16 -0
- package/content/packages/github-action-effects/api/type/capturedoutput.md +16 -0
- package/content/packages/github-action-effects/api/type/changeset.md +16 -0
- package/content/packages/github-action-effects/api/type/changesetfile.md +16 -0
- package/content/packages/github-action-effects/api/type/checklistitem.md +16 -0
- package/content/packages/github-action-effects/api/type/checkrunconclusion.md +18 -0
- package/content/packages/github-action-effects/api/type/coreservices.md +18 -0
- package/content/packages/github-action-effects/api/type/cyclonedxbom.md +18 -0
- package/content/packages/github-action-effects/api/type/extrapermission.md +18 -0
- package/content/packages/github-action-effects/api/type/filechange.md +16 -0
- package/content/packages/github-action-effects/api/type/githubcontext.md +18 -0
- package/content/packages/github-action-effects/api/type/installationtoken.md +18 -0
- package/content/packages/github-action-effects/api/type/loglevelinput.md +16 -0
- package/content/packages/github-action-effects/api/type/npmpackageinfo.md +16 -0
- package/content/packages/github-action-effects/api/type/packagemanagerinfo.md +18 -0
- package/content/packages/github-action-effects/api/type/packagemanagername.md +18 -0
- package/content/packages/github-action-effects/api/type/permissioncheckresult.md +18 -0
- package/content/packages/github-action-effects/api/type/permissiongap.md +18 -0
- package/content/packages/github-action-effects/api/type/permissionlevel.md +18 -0
- package/content/packages/github-action-effects/api/type/ratelimitstatus.md +18 -0
- package/content/packages/github-action-effects/api/type/registrytype.md +18 -0
- package/content/packages/github-action-effects/api/type/runnercontext.md +18 -0
- package/content/packages/github-action-effects/api/type/status.md +16 -0
- package/content/packages/github-action-effects/api/type/treeentry.md +16 -0
- package/content/packages/github-action-effects/api/type/webhookpayload.md +18 -0
- package/content/packages/github-action-effects/api/type/workspaceinfo.md +16 -0
- package/content/packages/github-action-effects/api/type/workspacepackage.md +16 -0
- package/content/packages/github-action-effects/api/type/workspacetype.md +16 -0
- package/content/packages/github-action-effects/api/variable/action.md +41 -0
- package/content/packages/github-action-effects/api/variable/actioncachelive.md +18 -0
- package/content/packages/github-action-effects/api/variable/actioncachetest.md +29 -0
- package/content/packages/github-action-effects/api/variable/actionenvironmentlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/actionenvironmenttest.md +21 -0
- package/content/packages/github-action-effects/api/variable/actioninput.md +31 -0
- package/content/packages/github-action-effects/api/variable/actionloggerlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/actionloggertest.md +29 -0
- package/content/packages/github-action-effects/api/variable/actionloglevel.md +18 -0
- package/content/packages/github-action-effects/api/variable/actionoutputslive.md +16 -0
- package/content/packages/github-action-effects/api/variable/actionoutputstest.md +29 -0
- package/content/packages/github-action-effects/api/variable/actionsconfigprovider.md +27 -0
- package/content/packages/github-action-effects/api/variable/actionslogger.md +18 -0
- package/content/packages/github-action-effects/api/variable/actionsruntime.md +36 -0
- package/content/packages/github-action-effects/api/variable/actionstatelive.md +16 -0
- package/content/packages/github-action-effects/api/variable/actionstatetest.md +29 -0
- package/content/packages/github-action-effects/api/variable/artifactlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/artifacttest.md +29 -0
- package/content/packages/github-action-effects/api/variable/attestlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/attesttest.md +21 -0
- package/content/packages/github-action-effects/api/variable/automerge.md +21 -0
- package/content/packages/github-action-effects/api/variable/blobstoretest.md +21 -0
- package/content/packages/github-action-effects/api/variable/bumptype.md +18 -0
- package/content/packages/github-action-effects/api/variable/capturedoutput.md +21 -0
- package/content/packages/github-action-effects/api/variable/changeset.md +25 -0
- package/content/packages/github-action-effects/api/variable/changesetanalyzerlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/changesetanalyzertest.md +21 -0
- package/content/packages/github-action-effects/api/variable/changesetfile.md +21 -0
- package/content/packages/github-action-effects/api/variable/checklistitem.md +21 -0
- package/content/packages/github-action-effects/api/variable/checkrunlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/checkruntest.md +21 -0
- package/content/packages/github-action-effects/api/variable/commandrunnerlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/commandrunnertest.md +21 -0
- package/content/packages/github-action-effects/api/variable/configloaderlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/configloadertest.md +21 -0
- package/content/packages/github-action-effects/api/variable/cyclonedx_bom.md +18 -0
- package/content/packages/github-action-effects/api/variable/dryruntest.md +24 -0
- package/content/packages/github-action-effects/api/variable/erroraccumulator.md +21 -0
- package/content/packages/github-action-effects/api/variable/extrapermission.md +21 -0
- package/content/packages/github-action-effects/api/variable/filechange.md +24 -0
- package/content/packages/github-action-effects/api/variable/filechangecontent.md +21 -0
- package/content/packages/github-action-effects/api/variable/filechangedeletion.md +21 -0
- package/content/packages/github-action-effects/api/variable/gitbranchlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/gitbranchtest.md +21 -0
- package/content/packages/github-action-effects/api/variable/gitcommitlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/gitcommittest.md +21 -0
- package/content/packages/github-action-effects/api/variable/github_build_type.md +18 -0
- package/content/packages/github-action-effects/api/variable/githubapplive.md +18 -0
- package/content/packages/github-action-effects/api/variable/githubapptest.md +21 -0
- package/content/packages/github-action-effects/api/variable/githubartifactmetadatalive.md +18 -0
- package/content/packages/github-action-effects/api/variable/githubartifactmetadatatest.md +24 -0
- package/content/packages/github-action-effects/api/variable/githubblobstorelive.md +18 -0
- package/content/packages/github-action-effects/api/variable/githubclientlive.md +26 -0
- package/content/packages/github-action-effects/api/variable/githubclienttest.md +21 -0
- package/content/packages/github-action-effects/api/variable/githubcommitlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/githubcommittest.md +21 -0
- package/content/packages/github-action-effects/api/variable/githubcontentlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/githubcontenttest.md +21 -0
- package/content/packages/github-action-effects/api/variable/githubcontext.md +35 -0
- package/content/packages/github-action-effects/api/variable/githubgraphqllive.md +18 -0
- package/content/packages/github-action-effects/api/variable/githubgraphqltest.md +24 -0
- package/content/packages/github-action-effects/api/variable/githubissuelive.md +16 -0
- package/content/packages/github-action-effects/api/variable/githubissuetest.md +24 -0
- package/content/packages/github-action-effects/api/variable/githubmarkdown.md +45 -0
- package/content/packages/github-action-effects/api/variable/githubreleaselive.md +16 -0
- package/content/packages/github-action-effects/api/variable/githubreleasetest.md +24 -0
- package/content/packages/github-action-effects/api/variable/githubtoken.md +27 -0
- package/content/packages/github-action-effects/api/variable/gittaglive.md +16 -0
- package/content/packages/github-action-effects/api/variable/gittagtest.md +24 -0
- package/content/packages/github-action-effects/api/variable/globlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/globtest.md +30 -0
- package/content/packages/github-action-effects/api/variable/in_toto_payload_type.md +18 -0
- package/content/packages/github-action-effects/api/variable/in_toto_statement_v1.md +18 -0
- package/content/packages/github-action-effects/api/variable/installationtoken.md +28 -0
- package/content/packages/github-action-effects/api/variable/ioutil.md +22 -0
- package/content/packages/github-action-effects/api/variable/loglevelinput.md +18 -0
- package/content/packages/github-action-effects/api/variable/npmpackageinfo.md +24 -0
- package/content/packages/github-action-effects/api/variable/npmregistrylive.md +18 -0
- package/content/packages/github-action-effects/api/variable/npmregistrytest.md +21 -0
- package/content/packages/github-action-effects/api/variable/octokitauthapplive.md +18 -0
- package/content/packages/github-action-effects/api/variable/oidctokenissuerlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/oidctokenissuertest.md +18 -0
- package/content/packages/github-action-effects/api/variable/packagemanageradapterlive.md +19 -0
- package/content/packages/github-action-effects/api/variable/packagemanageradaptertest.md +21 -0
- package/content/packages/github-action-effects/api/variable/packagemanagerinfo.md +22 -0
- package/content/packages/github-action-effects/api/variable/packagemanagername.md +18 -0
- package/content/packages/github-action-effects/api/variable/packagepublishlive.md +19 -0
- package/content/packages/github-action-effects/api/variable/packagepublishtest.md +27 -0
- package/content/packages/github-action-effects/api/variable/pathutils.md +31 -0
- package/content/packages/github-action-effects/api/variable/permissioncheckresult.md +31 -0
- package/content/packages/github-action-effects/api/variable/permissiongap.md +22 -0
- package/content/packages/github-action-effects/api/variable/permissionlevel.md +18 -0
- package/content/packages/github-action-effects/api/variable/pullrequestcommentlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/pullrequestcommenttest.md +21 -0
- package/content/packages/github-action-effects/api/variable/pullrequestlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/pullrequesttest.md +21 -0
- package/content/packages/github-action-effects/api/variable/ratelimiterlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/ratelimitertest.md +21 -0
- package/content/packages/github-action-effects/api/variable/ratelimitstatus.md +23 -0
- package/content/packages/github-action-effects/api/variable/reportbuilder.md +33 -0
- package/content/packages/github-action-effects/api/variable/runnercontext.md +25 -0
- package/content/packages/github-action-effects/api/variable/sbomlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/sbomtest.md +21 -0
- package/content/packages/github-action-effects/api/variable/semverresolver.md +30 -0
- package/content/packages/github-action-effects/api/variable/sigstore_bundle_v0_3_media_type.md +18 -0
- package/content/packages/github-action-effects/api/variable/sigstore_oidc_audience.md +18 -0
- package/content/packages/github-action-effects/api/variable/sigstoresignerlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/sigstoresignertest.md +18 -0
- package/content/packages/github-action-effects/api/variable/slsa_provenance_v1.md +18 -0
- package/content/packages/github-action-effects/api/variable/spdx_v2_3.md +18 -0
- package/content/packages/github-action-effects/api/variable/status.md +18 -0
- package/content/packages/github-action-effects/api/variable/tokenpermissioncheckertest.md +21 -0
- package/content/packages/github-action-effects/api/variable/toolinstallerlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/toolinstallertest.md +21 -0
- package/content/packages/github-action-effects/api/variable/treeentry.md +26 -0
- package/content/packages/github-action-effects/api/variable/treeentrycontent.md +22 -0
- package/content/packages/github-action-effects/api/variable/treeentrydeletion.md +22 -0
- package/content/packages/github-action-effects/api/variable/webhookpayload.md +51 -0
- package/content/packages/github-action-effects/api/variable/workflowdispatchlive.md +16 -0
- package/content/packages/github-action-effects/api/variable/workflowdispatchtest.md +21 -0
- package/content/packages/github-action-effects/api/variable/workspacedetectorlive.md +18 -0
- package/content/packages/github-action-effects/api/variable/workspacedetectortest.md +21 -0
- package/content/packages/github-action-effects/api/variable/workspaceinfo.md +22 -0
- package/content/packages/github-action-effects/api/variable/workspacepackage.md +24 -0
- package/content/packages/github-action-effects/api/variable/workspacetype.md +18 -0
- package/content/packages/github-action-effects/api.md +386 -0
- package/content/packages/rspress-builder/api/function/build.md +18 -0
- package/content/packages/rspress-builder/api/function/defineplugin.md +18 -0
- package/content/packages/rspress-builder/api/interface/rspressbundleoptions.md +28 -0
- package/content/packages/rspress-builder/api/interface/rspresspluginoptions.md +76 -0
- package/content/packages/rspress-builder/api.md +22 -0
- package/content/packages/silk-effects/api/class/analyzedworkspace.md +121 -0
- package/content/packages/silk-effects/api/class/biomeschemasync.md +33 -0
- package/content/packages/silk-effects/api/class/biomesyncerror.md +41 -0
- package/content/packages/silk-effects/api/class/changesetconfig.md +28 -0
- package/content/packages/silk-effects/api/class/changesetconfigerror.md +41 -0
- package/content/packages/silk-effects/api/class/changesetconfigreader.md +33 -0
- package/content/packages/silk-effects/api/class/configdiscovery.md +33 -0
- package/content/packages/silk-effects/api/class/confignotfounderror.md +41 -0
- package/content/packages/silk-effects/api/class/managedsection.md +18 -0
- package/content/packages/silk-effects/api/class/resolvedtool.md +62 -0
- package/content/packages/silk-effects/api/class/sectionblock.md +95 -0
- package/content/packages/silk-effects/api/class/sectiondefinition.md +104 -0
- package/content/packages/silk-effects/api/class/sectionparseerror.md +41 -0
- package/content/packages/silk-effects/api/class/sectionvalidationerror.md +41 -0
- package/content/packages/silk-effects/api/class/sectionwriteerror.md +41 -0
- package/content/packages/silk-effects/api/class/shellsectiondefinition.md +56 -0
- package/content/packages/silk-effects/api/class/silkpublishability.md +46 -0
- package/content/packages/silk-effects/api/class/silkpublishconfig.md +18 -0
- package/content/packages/silk-effects/api/class/silkworkspaceanalyzer.md +33 -0
- package/content/packages/silk-effects/api/class/tagformaterror.md +48 -0
- package/content/packages/silk-effects/api/class/tagstrategy.md +32 -0
- package/content/packages/silk-effects/api/class/toolcommand.md +76 -0
- package/content/packages/silk-effects/api/class/tooldefinition.md +73 -0
- package/content/packages/silk-effects/api/class/tooldiscovery.md +35 -0
- package/content/packages/silk-effects/api/class/toolnotfounderror.md +39 -0
- package/content/packages/silk-effects/api/class/toolresolutionerror.md +39 -0
- package/content/packages/silk-effects/api/class/toolversionmismatcherror.md +46 -0
- package/content/packages/silk-effects/api/class/versioningdetectionerror.md +34 -0
- package/content/packages/silk-effects/api/class/versioningstrategy.md +34 -0
- package/content/packages/silk-effects/api/class/workspaceanalysis.md +94 -0
- package/content/packages/silk-effects/api/class/workspaceanalysiserror.md +41 -0
- package/content/packages/silk-effects/api/function/buildschemaurl.md +26 -0
- package/content/packages/silk-effects/api/function/extractsemver.md +26 -0
- package/content/packages/silk-effects/api/function/readtargetsbinding.md +23 -0
- package/content/packages/silk-effects/api/function/savvybasepreamble.md +22 -0
- package/content/packages/silk-effects/api/function/savvyhookshygiene.md +22 -0
- package/content/packages/silk-effects/api/function/savvytoolsection.md +37 -0
- package/content/packages/silk-effects/api/interface/commitlintplugin.md +26 -0
- package/content/packages/silk-effects/api/interface/commitlintuserconfig.md +76 -0
- package/content/packages/silk-effects/api/interface/promptconfig.md +38 -0
- package/content/packages/silk-effects/api/interface/promptsettings.md +32 -0
- package/content/packages/silk-effects/api/interface/publishablepackage.md +44 -0
- package/content/packages/silk-effects/api/interface/rawpackagejson.md +44 -0
- package/content/packages/silk-effects/api/interface/rawpublishconfig.md +44 -0
- package/content/packages/silk-effects/api/interface/rawtargetobject.md +44 -0
- package/content/packages/silk-effects/api/interface/rulesconfig.md +26 -0
- package/content/packages/silk-effects/api/interface/targetbinding.md +52 -0
- package/content/packages/silk-effects/api/interface/targetgroupbinding.md +44 -0
- package/content/packages/silk-effects/api/interface/targetsbinding.md +32 -0
- package/content/packages/silk-effects/api/namespace/changesets.md +16 -0
- package/content/packages/silk-effects/api/namespace/commitlint.md +16 -0
- package/content/packages/silk-effects/api/namespace/lint.md +16 -0
- package/content/packages/silk-effects/api/namespace/turbo.md +16 -0
- package/content/packages/silk-effects/api/type/biomesyncoptions.md +16 -0
- package/content/packages/silk-effects/api/type/biomesyncresult.md +16 -0
- package/content/packages/silk-effects/api/type/changesetconfigfile.md +16 -0
- package/content/packages/silk-effects/api/type/changesetmode.md +18 -0
- package/content/packages/silk-effects/api/type/checkresult.md +16 -0
- package/content/packages/silk-effects/api/type/checkresultdefinition.md +24 -0
- package/content/packages/silk-effects/api/type/commentstyle.md +16 -0
- package/content/packages/silk-effects/api/type/configdiscoveryoptions.md +16 -0
- package/content/packages/silk-effects/api/type/configlocation.md +16 -0
- package/content/packages/silk-effects/api/type/configsource.md +16 -0
- package/content/packages/silk-effects/api/type/rawpublishtargets.md +18 -0
- package/content/packages/silk-effects/api/type/rawtargetvalue.md +18 -0
- package/content/packages/silk-effects/api/type/resolutionpolicy.md +16 -0
- package/content/packages/silk-effects/api/type/resolutionpolicydefinition.md +23 -0
- package/content/packages/silk-effects/api/type/ruleapplicability.md +18 -0
- package/content/packages/silk-effects/api/type/ruleconfigtuple.md +18 -0
- package/content/packages/silk-effects/api/type/ruleseverity.md +18 -0
- package/content/packages/silk-effects/api/type/sectiondiff.md +16 -0
- package/content/packages/silk-effects/api/type/sectiondiffdefinition.md +24 -0
- package/content/packages/silk-effects/api/type/silkchangesetconfigfile.md +16 -0
- package/content/packages/silk-effects/api/type/sourcerequirement.md +16 -0
- package/content/packages/silk-effects/api/type/sourcerequirementdefinition.md +23 -0
- package/content/packages/silk-effects/api/type/syncresult.md +16 -0
- package/content/packages/silk-effects/api/type/syncresultdefinition.md +24 -0
- package/content/packages/silk-effects/api/type/tagstrategytype.md +16 -0
- package/content/packages/silk-effects/api/type/toolsource.md +16 -0
- package/content/packages/silk-effects/api/type/versionextractor.md +16 -0
- package/content/packages/silk-effects/api/type/versionextractordefinition.md +28 -0
- package/content/packages/silk-effects/api/type/versioningstrategyresult.md +16 -0
- package/content/packages/silk-effects/api/type/versioningstrategytype.md +16 -0
- package/content/packages/silk-effects/api/variable/biomeschemasynclive.md +18 -0
- package/content/packages/silk-effects/api/variable/biomesyncoptions.md +23 -0
- package/content/packages/silk-effects/api/variable/biomesyncresult.md +22 -0
- package/content/packages/silk-effects/api/variable/changesetconfigfile.md +36 -0
- package/content/packages/silk-effects/api/variable/changesetconfiglive.md +18 -0
- package/content/packages/silk-effects/api/variable/changesetconfigreaderlive.md +18 -0
- package/content/packages/silk-effects/api/variable/checkresult.md +70 -0
- package/content/packages/silk-effects/api/variable/commentstyle.md +18 -0
- package/content/packages/silk-effects/api/variable/configdiscoverylive.md +18 -0
- package/content/packages/silk-effects/api/variable/configdiscoveryoptions.md +21 -0
- package/content/packages/silk-effects/api/variable/configlocation.md +21 -0
- package/content/packages/silk-effects/api/variable/configsource.md +18 -0
- package/content/packages/silk-effects/api/variable/managedsectionlive.md +18 -0
- package/content/packages/silk-effects/api/variable/publishabilitydetectoradaptivelive.md +19 -0
- package/content/packages/silk-effects/api/variable/resolutionpolicy.md +92 -0
- package/content/packages/silk-effects/api/variable/savvybasesection.md +25 -0
- package/content/packages/silk-effects/api/variable/savvyhookssection.md +18 -0
- package/content/packages/silk-effects/api/variable/sectiondiff.md +70 -0
- package/content/packages/silk-effects/api/variable/silkchangesetconfigfile.md +40 -0
- package/content/packages/silk-effects/api/variable/silkpublishabilitydetectorlive.md +18 -0
- package/content/packages/silk-effects/api/variable/silkworkspaceanalyzerlive.md +20 -0
- package/content/packages/silk-effects/api/variable/sourcerequirement.md +92 -0
- package/content/packages/silk-effects/api/variable/syncresult.md +81 -0
- package/content/packages/silk-effects/api/variable/tagstrategylive.md +18 -0
- package/content/packages/silk-effects/api/variable/tagstrategytype.md +18 -0
- package/content/packages/silk-effects/api/variable/tooldiscoverylive.md +19 -0
- package/content/packages/silk-effects/api/variable/toolsource.md +18 -0
- package/content/packages/silk-effects/api/variable/versionextractor.md +99 -0
- package/content/packages/silk-effects/api/variable/versioningstrategylive.md +18 -0
- package/content/packages/silk-effects/api/variable/versioningstrategyresult.md +22 -0
- package/content/packages/silk-effects/api/variable/versioningstrategytype.md +18 -0
- package/content/packages/silk-effects/api.md +144 -0
- package/content/packages/templates/api/function/createbiome.md +26 -0
- package/content/packages/templates/api/function/createchangeset.md +26 -0
- package/content/packages/templates/api/function/creategitignore.md +26 -0
- package/content/packages/templates/api/function/createpackagejson.md +26 -0
- package/content/packages/templates/api/function/createpnpmworkspace.md +26 -0
- package/content/packages/templates/api/function/createreadme.md +26 -0
- package/content/packages/templates/api/function/createtsconfig.md +26 -0
- package/content/packages/templates/api/function/createturboroot.md +26 -0
- package/content/packages/templates/api/function/createturboworkspace.md +26 -0
- package/content/packages/templates/api/function/createvscode.md +26 -0
- package/content/packages/templates/api/function/createworkspace.md +26 -0
- package/content/packages/templates/api/interface/templateentry.md +44 -0
- package/content/packages/templates/api/type/biomeoptionstype.md +18 -0
- package/content/packages/templates/api/type/changesetoptionstype.md +18 -0
- package/content/packages/templates/api/type/gitignoreoptionstype.md +18 -0
- package/content/packages/templates/api/type/packagejsonoptionstype.md +18 -0
- package/content/packages/templates/api/type/pnpmworkspaceoptionstype.md +18 -0
- package/content/packages/templates/api/type/readmeoptionstype.md +18 -0
- package/content/packages/templates/api/type/template.md +18 -0
- package/content/packages/templates/api/type/tsconfigoptionstype.md +18 -0
- package/content/packages/templates/api/type/turborootoptionstype.md +18 -0
- package/content/packages/templates/api/type/turboworkspaceoptionstype.md +18 -0
- package/content/packages/templates/api/type/updatetemplate.md +18 -0
- package/content/packages/templates/api/type/vscodeoptionstype.md +18 -0
- package/content/packages/templates/api/type/workspaceoptionstype.md +18 -0
- package/content/packages/templates/api/variable/biomeoptions.md +22 -0
- package/content/packages/templates/api/variable/changesetoptions.md +29 -0
- package/content/packages/templates/api/variable/gitignoreoptions.md +27 -0
- package/content/packages/templates/api/variable/packagejsonoptions.md +60 -0
- package/content/packages/templates/api/variable/pnpmworkspaceoptions.md +23 -0
- package/content/packages/templates/api/variable/readmeoptions.md +21 -0
- package/content/packages/templates/api/variable/tsconfigoptions.md +26 -0
- package/content/packages/templates/api/variable/turborootoptions.md +25 -0
- package/content/packages/templates/api/variable/turboworkspaceoptions.md +20 -0
- package/content/packages/templates/api/variable/vscodeoptions.md +25 -0
- package/content/packages/templates/api/variable/workspaceoptions.md +33 -0
- package/content/packages/templates/api.md +60 -0
- package/content/packages/tsdown-plugins/api/class/buildcollector.md +62 -0
- package/content/packages/tsdown-plugins/api/class/buildcollectortag.md +16 -0
- package/content/packages/tsdown-plugins/api/class/buildreport.md +16 -0
- package/content/packages/tsdown-plugins/api/class/configvalidationerror.md +41 -0
- package/content/packages/tsdown-plugins/api/class/configvalidator.md +18 -0
- package/content/packages/tsdown-plugins/api/class/diagnosticentry.md +18 -0
- package/content/packages/tsdown-plugins/api/class/emittedfile.md +18 -0
- package/content/packages/tsdown-plugins/api/class/environmentdetector.md +16 -0
- package/content/packages/tsdown-plugins/api/class/executorresolver.md +16 -0
- package/content/packages/tsdown-plugins/api/class/formatselector.md +16 -0
- package/content/packages/tsdown-plugins/api/class/metagenerationerror.md +41 -0
- package/content/packages/tsdown-plugins/api/class/outputrenderer.md +16 -0
- package/content/packages/tsdown-plugins/api/class/passreport.md +18 -0
- package/content/packages/tsdown-plugins/api/class/reporttimings.md +16 -0
- package/content/packages/tsdown-plugins/api/class/targetgroupreport.md +16 -0
- package/content/packages/tsdown-plugins/api/class/tsconfigresolver.md +84 -0
- package/content/packages/tsdown-plugins/api/function/ambientoutname.md +18 -0
- package/content/packages/tsdown-plugins/api/function/analyzereexportbarrel.md +18 -0
- package/content/packages/tsdown-plugins/api/function/applysubdirmetaentries.md +21 -0
- package/content/packages/tsdown-plugins/api/function/assertnoentrycollisions.md +18 -0
- package/content/packages/tsdown-plugins/api/function/buildemittedmanifest.md +18 -0
- package/content/packages/tsdown-plugins/api/function/buildmetricsplugin.md +18 -0
- package/content/packages/tsdown-plugins/api/function/buildresolvedtsconfig.md +18 -0
- package/content/packages/tsdown-plugins/api/function/buildtargetgroups.md +18 -0
- package/content/packages/tsdown-plugins/api/function/cjsdefaultinterop.md +18 -0
- package/content/packages/tsdown-plugins/api/function/classifydtsexport.md +18 -0
- package/content/packages/tsdown-plugins/api/function/collectexportnames.md +18 -0
- package/content/packages/tsdown-plugins/api/function/computeexefilename.md +18 -0
- package/content/packages/tsdown-plugins/api/function/copyambientdts.md +18 -0
- package/content/packages/tsdown-plugins/api/function/copypublicdir.md +18 -0
- package/content/packages/tsdown-plugins/api/function/createtimer.md +18 -0
- package/content/packages/tsdown-plugins/api/function/createtsdownlogger.md +18 -0
- package/content/packages/tsdown-plugins/api/function/declarationext.md +18 -0
- package/content/packages/tsdown-plugins/api/function/defaultmanifesttransform.md +20 -0
- package/content/packages/tsdown-plugins/api/function/deriveexportpaths.md +18 -0
- package/content/packages/tsdown-plugins/api/function/derivetargetgroupoptions.md +18 -0
- package/content/packages/tsdown-plugins/api/function/emitmanifest.md +18 -0
- package/content/packages/tsdown-plugins/api/function/extractambientdts.md +18 -0
- package/content/packages/tsdown-plugins/api/function/extractentries.md +16 -0
- package/content/packages/tsdown-plugins/api/function/findrelativespecifiers.md +21 -0
- package/content/packages/tsdown-plugins/api/function/flattenissues.md +21 -0
- package/content/packages/tsdown-plugins/api/function/formattime.md +16 -0
- package/content/packages/tsdown-plugins/api/function/generatemeta.md +18 -0
- package/content/packages/tsdown-plugins/api/function/istargetobject.md +18 -0
- package/content/packages/tsdown-plugins/api/function/mixeddtsexporterror.md +18 -0
- package/content/packages/tsdown-plugins/api/function/nodebuiltindefaultinterop.md +18 -0
- package/content/packages/tsdown-plugins/api/function/normalizebinpaths.md +18 -0
- package/content/packages/tsdown-plugins/api/function/normalizeexeoptions.md +18 -0
- package/content/packages/tsdown-plugins/api/function/normalizeloosefiles.md +18 -0
- package/content/packages/tsdown-plugins/api/function/normalizemetaoptions.md +21 -0
- package/content/packages/tsdown-plugins/api/function/packagejsonentries.md +18 -0
- package/content/packages/tsdown-plugins/api/function/readtsconfigjsx.md +18 -0
- package/content/packages/tsdown-plugins/api/function/removedeclarationmaps.md +18 -0
- package/content/packages/tsdown-plugins/api/function/renderreexportstub.md +22 -0
- package/content/packages/tsdown-plugins/api/function/renderreport.md +17 -0
- package/content/packages/tsdown-plugins/api/function/resolvejsxconfig.md +18 -0
- package/content/packages/tsdown-plugins/api/function/resolvemanifest.md +18 -0
- package/content/packages/tsdown-plugins/api/function/resolvenextversions.md +18 -0
- package/content/packages/tsdown-plugins/api/function/resolveportabletsconfig.md +27 -0
- package/content/packages/tsdown-plugins/api/function/resolvetargets.md +21 -0
- package/content/packages/tsdown-plugins/api/function/rewritemetaversions.md +18 -0
- package/content/packages/tsdown-plugins/api/function/runexebuild.md +18 -0
- package/content/packages/tsdown-plugins/api/function/runmetapass.md +18 -0
- package/content/packages/tsdown-plugins/api/function/serializeissues.md +18 -0
- package/content/packages/tsdown-plugins/api/function/transformbin.md +18 -0
- package/content/packages/tsdown-plugins/api/function/transformexports.md +18 -0
- package/content/packages/tsdown-plugins/api/function/transformmanifest.md +18 -0
- package/content/packages/tsdown-plugins/api/function/writedtsemittsconfig.md +18 -0
- package/content/packages/tsdown-plugins/api/function/writeissuesartifact.md +23 -0
- package/content/packages/tsdown-plugins/api/function/writeresolvedtsconfig.md +18 -0
- package/content/packages/tsdown-plugins/api/function/writetargetsbinding.md +18 -0
- package/content/packages/tsdown-plugins/api/interface/ambientdtsentry.md +38 -0
- package/content/packages/tsdown-plugins/api/interface/buildemittedmanifestoptions.md +69 -0
- package/content/packages/tsdown-plugins/api/interface/buildgroupspec.md +32 -0
- package/content/packages/tsdown-plugins/api/interface/buildissues.md +56 -0
- package/content/packages/tsdown-plugins/api/interface/buildtargetgroupsoptions.md +205 -0
- package/content/packages/tsdown-plugins/api/interface/copyambientdtsoptions.md +42 -0
- package/content/packages/tsdown-plugins/api/interface/cssoptions.md +36 -0
- package/content/packages/tsdown-plugins/api/interface/derivedtsdownoptions.md +106 -0
- package/content/packages/tsdown-plugins/api/interface/deriveoptions.md +100 -0
- package/content/packages/tsdown-plugins/api/interface/diagnosticinput.md +66 -0
- package/content/packages/tsdown-plugins/api/interface/emitmanifestoptions.md +71 -0
- package/content/packages/tsdown-plugins/api/interface/entryoverride.md +86 -0
- package/content/packages/tsdown-plugins/api/interface/execonfig.md +60 -0
- package/content/packages/tsdown-plugins/api/interface/exerewrite.md +44 -0
- package/content/packages/tsdown-plugins/api/interface/exeseaconfig.md +38 -0
- package/content/packages/tsdown-plugins/api/interface/exetarget.md +38 -0
- package/content/packages/tsdown-plugins/api/interface/exetargetinput.md +32 -0
- package/content/packages/tsdown-plugins/api/interface/extractambientoptions.md +24 -0
- package/content/packages/tsdown-plugins/api/interface/extractoptions.md +32 -0
- package/content/packages/tsdown-plugins/api/interface/extractresult.md +34 -0
- package/content/packages/tsdown-plugins/api/interface/formatter.md +30 -0
- package/content/packages/tsdown-plugins/api/interface/formattercontext.md +30 -0
- package/content/packages/tsdown-plugins/api/interface/generatemetaoptions.md +124 -0
- package/content/packages/tsdown-plugins/api/interface/jsxconfig.md +36 -0
- package/content/packages/tsdown-plugins/api/interface/loosefilespec.md +36 -0
- package/content/packages/tsdown-plugins/api/interface/metaoptions.md +42 -0
- package/content/packages/tsdown-plugins/api/interface/metaresult.md +30 -0
- package/content/packages/tsdown-plugins/api/interface/moduleexportnames.md +34 -0
- package/content/packages/tsdown-plugins/api/interface/nextversions.md +36 -0
- package/content/packages/tsdown-plugins/api/interface/normalizedexe.md +48 -0
- package/content/packages/tsdown-plugins/api/interface/normalizedloosefile.md +60 -0
- package/content/packages/tsdown-plugins/api/interface/normalizedmeta.md +41 -0
- package/content/packages/tsdown-plugins/api/interface/packagejsonentriesoptions.md +34 -0
- package/content/packages/tsdown-plugins/api/interface/packagejsonlike.md +30 -0
- package/content/packages/tsdown-plugins/api/interface/pkgoscpu.md +32 -0
- package/content/packages/tsdown-plugins/api/interface/plaindiagnostic.md +68 -0
- package/content/packages/tsdown-plugins/api/interface/portabletsconfig.md +36 -0
- package/content/packages/tsdown-plugins/api/interface/publishtargetobject.md +44 -0
- package/content/packages/tsdown-plugins/api/interface/reexportbarrelanalysis.md +44 -0
- package/content/packages/tsdown-plugins/api/interface/renderedoutput.md +36 -0
- package/content/packages/tsdown-plugins/api/interface/renderreportoptions.md +44 -0
- package/content/packages/tsdown-plugins/api/interface/resolvedcompileroptions.md +26 -0
- package/content/packages/tsdown-plugins/api/interface/resolvedgroup.md +44 -0
- package/content/packages/tsdown-plugins/api/interface/resolvedtarget.md +52 -0
- package/content/packages/tsdown-plugins/api/interface/resolvedtsconfig.md +36 -0
- package/content/packages/tsdown-plugins/api/interface/resolvedtsconfigoptions.md +50 -0
- package/content/packages/tsdown-plugins/api/interface/runexebuildoptions.md +74 -0
- package/content/packages/tsdown-plugins/api/interface/runmetapassoptions.md +104 -0
- package/content/packages/tsdown-plugins/api/interface/targetgroupref.md +38 -0
- package/content/packages/tsdown-plugins/api/interface/targetresolution.md +32 -0
- package/content/packages/tsdown-plugins/api/interface/timer.md +30 -0
- package/content/packages/tsdown-plugins/api/interface/transformmanifestoptions.md +50 -0
- package/content/packages/tsdown-plugins/api/interface/tsconfigjsx.md +32 -0
- package/content/packages/tsdown-plugins/api/interface/tsdocoptions.md +32 -0
- package/content/packages/tsdown-plugins/api/interface/tsdoctagdefinition.md +38 -0
- package/content/packages/tsdown-plugins/api/interface/tsdownlogger.md +62 -0
- package/content/packages/tsdown-plugins/api/interface/validationinput.md +69 -0
- package/content/packages/tsdown-plugins/api/interface/warningsuppressionrule.md +32 -0
- package/content/packages/tsdown-plugins/api/type/buildformat.md +18 -0
- package/content/packages/tsdown-plugins/api/type/buildplatform.md +18 -0
- package/content/packages/tsdown-plugins/api/type/dtsexportclass.md +25 -0
- package/content/packages/tsdown-plugins/api/type/dualexports.md +18 -0
- package/content/packages/tsdown-plugins/api/type/environment.md +16 -0
- package/content/packages/tsdown-plugins/api/type/exebuild.md +18 -0
- package/content/packages/tsdown-plugins/api/type/executor.md +16 -0
- package/content/packages/tsdown-plugins/api/type/json.md +16 -0
- package/content/packages/tsdown-plugins/api/type/loosefiles.md +18 -0
- package/content/packages/tsdown-plugins/api/type/outputformat.md +16 -0
- package/content/packages/tsdown-plugins/api/type/passkind.md +16 -0
- package/content/packages/tsdown-plugins/api/type/publishtargets.md +18 -0
- package/content/packages/tsdown-plugins/api/type/publishtargetvalue.md +18 -0
- package/content/packages/tsdown-plugins/api/type/targetgroupid.md +18 -0
- package/content/packages/tsdown-plugins/api/type/tsdownbuild.md +18 -0
- package/content/packages/tsdown-plugins/api/variable/ciannotationsformatter.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/configvalidatorlive.md +18 -0
- package/content/packages/tsdown-plugins/api/variable/default_exe_node_version.md +18 -0
- package/content/packages/tsdown-plugins/api/variable/environmentdetectorlive.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/executorresolverlive.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/formatselectorlive.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/jsonformatter.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/markdownformatter.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/outputrendererlive.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/reportpipelinelive.md +17 -0
- package/content/packages/tsdown-plugins/api/variable/silentformatter.md +16 -0
- package/content/packages/tsdown-plugins/api/variable/terminalformatter.md +16 -0
- package/content/packages/tsdown-plugins/api.md +183 -0
- package/{public/content → content}/standards/api-model-pipeline.md +6 -5
- package/index.d.ts +6 -6
- package/package.json +2 -2
- package/resources/doc-index.js +2 -2
- package/resources/index.js +10 -1
- package/resources/load.js +4 -4
- package/tools/docs-search.js +1 -1
- package/public/content/guides/choosing-a-builder.md +0 -140
- package/public/content/manifest.json +0 -414
- package/public/content/packages/rslib-builder/overview.md +0 -68
- /package/{public/content → content}/_templates/guides.md +0 -0
- /package/{public/content → content}/_templates/packages.md +0 -0
- /package/{public/content → content}/_templates/standards.md +0 -0
- /package/{public/content → content}/guides/llm-friendly-json-schemas.md +0 -0
- /package/{public/content → content}/packages/cli/command-tree.md +0 -0
- /package/{public/content → content}/packages/cli/init-and-check.md +0 -0
- /package/{public/content → content}/packages/mcp/resource-taxonomy.md +0 -0
- /package/{public/content → content}/packages/silk/export-map.md +0 -0
- /package/{public/content → content}/packages/silk/install-and-setup.md +0 -0
- /package/{public/content → content}/packages/silk-effects/index.md +0 -0
- /package/{public/content → content}/packages/silk-effects/managed-section.md +0 -0
- /package/{public/content → content}/packages/silk-effects/platform-layers.md +0 -0
- /package/{public/content → content}/standards/catalog-usage.md +0 -0
- /package/{public/content → content}/standards/changeset-discipline.md +0 -0
- /package/{public/content → content}/standards/changeset-format.md +0 -0
- /package/{public/content → content}/standards/commit-contract.md +0 -0
- /package/{public/content → content}/standards/dependency-conventions.md +0 -0
- /package/{public/content → content}/standards/linting-conventions.md +0 -0
- /package/{public/content → content}/standards/publishability.md +0 -0
- /package/{public/content → content}/standards/semver.md +0 -0
- /package/{public/content → content}/standards/test-classification.md +0 -0
- /package/{public/content → content}/standards/turbo/best-practices.md +0 -0
- /package/{public/content → content}/standards/turbo/boundaries.md +0 -0
- /package/{public/content → content}/standards/turbo/ci.md +0 -0
- /package/{public/content → content}/standards/turbo/environment.md +0 -0
- /package/{public/content → content}/standards/turbo/filtering.md +0 -0
- /package/{public/content → content}/standards/turbo/watch.md +0 -0
- /package/{public/content → content}/tags.json +0 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Savvy Web Strategy, LLC
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -42,7 +42,7 @@ npx @modelcontextprotocol/inspector savvy-mcp .
|
|
|
42
42
|
## Tools
|
|
43
43
|
|
|
44
44
|
- `workspace_info` — returns a flat, structured projection of the workspace analysis: linked and fixed package groups as name arrays plus resolved registry targets. Backed by the same `silk-effects` analyzer the `savvy` CLI uses.
|
|
45
|
-
- `silk_docs_search` — ranks documents in the corpus against a plain keyword or phrase query and returns hits with a normalized confidence score plus a high/medium/low label.
|
|
45
|
+
- `silk_docs_search` — ranks documents in the corpus against a plain keyword or phrase query and returns hits with a normalized confidence score plus a high/medium/low label. A query that matches nothing returns an empty result set, pointing the agent at `silk://catalog` to choose a doc by reasoning.
|
|
46
46
|
- `turbo_inspect` — read-only Turborepo inspection over `turbo --dry`: diagnose a task's per-package cache hits, derive the task graph or list the packages affected by recent changes. It never runs a task. Backed by the same `silk-effects` `Turbo` inspector an agent would otherwise drive by hand.
|
|
47
47
|
- `changeset_inspect` — read-only changeset analysis for release work: `mode=branch` diffs the current branch against its base and attributes every changed file to its owning package, `mode=config` surfaces the resolved `.changeset/config.json` with its release surfaces, version files and ignore list, and `mode=classify` reports how the branch's pending changesets classify each package's bump. It never writes a changeset. Backed by the same `silk-effects` changeset services the `savvy` CLI uses.
|
|
48
48
|
- `changeset_validate` — read-only validation of the files in a changeset directory against the section-aware rules, returning typed diagnostics (file, rule, line, column, message) plus an ok flag and error count. Use it instead of shelling out to `savvy changeset lint`.
|
|
@@ -56,7 +56,7 @@ The server exposes a curated markdown corpus behind the `silk://` URI scheme:
|
|
|
56
56
|
- `silk://catalog` — a single fixed resource listing every document grouped by tier with a "load when …" hint. The agent's mandated first read.
|
|
57
57
|
- `silk://{+path}` — a template resolving any document by its stable id, covering Silk development standards (`silk://standards/<topic>`), per-package API and usage docs (`silk://packages/<pkg>/<topic>`) and conceptual guides (`silk://guides/<slug>`).
|
|
58
58
|
|
|
59
|
-
Per-package API-reference docs under `silk://packages/<pkg>/api/*` are generated from API Extractor models and shipped with the package.
|
|
59
|
+
Per-package API-reference docs under `silk://packages/<pkg>/api/*` are generated from API Extractor models and shipped with the package, with a bare `silk://packages/<pkg>/api` index page listing each package's symbols.
|
|
60
60
|
|
|
61
61
|
## License
|
|
62
62
|
|
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
---
|
|
2
2
|
id: guides/api-docs-from-api-extractor
|
|
3
3
|
title: Generating API docs from API Extractor
|
|
4
|
-
summary: Configure
|
|
4
|
+
summary: Configure the meta option, build the model, and render LLM-lean markdown with api-extractor-llms.
|
|
5
5
|
tier: guides
|
|
6
6
|
source: hand
|
|
7
7
|
tags: [api, build]
|
|
8
8
|
priority: 0.5
|
|
9
|
-
related: [standards/api-model-pipeline, packages/
|
|
9
|
+
related: [standards/api-model-pipeline, packages/bundler/overview]
|
|
10
10
|
---
|
|
11
11
|
|
|
12
12
|
## Overview
|
|
@@ -19,30 +19,38 @@ This guide walks through each stage as implemented in this repo.
|
|
|
19
19
|
For the policy contract (what is generated, what must not be edited, where docs
|
|
20
20
|
land), see `silk://standards/api-model-pipeline`.
|
|
21
21
|
|
|
22
|
-
## Step 1 —
|
|
22
|
+
## Step 1 — Emit the API model from the build
|
|
23
23
|
|
|
24
|
-
A library
|
|
24
|
+
A library built by `@savvy-web/bundler` emits an API Extractor model on its
|
|
25
|
+
production build by default — there is nothing to enable. The model is controlled
|
|
26
|
+
by the `meta` option in `savvy.build.ts`:
|
|
25
27
|
|
|
26
28
|
```typescript
|
|
27
|
-
import {
|
|
29
|
+
import { defineBuild, runBuild } from "@savvy-web/bundler";
|
|
28
30
|
|
|
29
|
-
|
|
30
|
-
|
|
31
|
+
const config = defineBuild({
|
|
32
|
+
// meta omitted → API model is generated with default options on --target prod.
|
|
33
|
+
// Pass an object only to override defaults, e.g. to register custom TSDoc tags:
|
|
34
|
+
meta: {
|
|
31
35
|
tsdoc: {
|
|
32
36
|
tagDefinitions: [{ tagName: "@since", syntaxKind: "block" }],
|
|
33
37
|
},
|
|
34
38
|
},
|
|
35
39
|
});
|
|
36
|
-
```
|
|
37
40
|
|
|
38
|
-
|
|
39
|
-
`apiModel` are forwarded to the API Extractor TSDoc runner. A plain `apiModel: true`
|
|
40
|
-
works when no custom tag definitions are needed.
|
|
41
|
+
export default config;
|
|
41
42
|
|
|
42
|
-
|
|
43
|
-
|
|
43
|
+
if (import.meta.main) {
|
|
44
|
+
await runBuild(config, { cwd: import.meta.dirname, argv: process.argv.slice(2) });
|
|
45
|
+
}
|
|
46
|
+
```
|
|
44
47
|
|
|
45
|
-
|
|
48
|
+
Omitting `meta` generates the model with defaults; pass `false` to opt out
|
|
49
|
+
entirely (the MCP server itself does this — it is an executable host, not a
|
|
50
|
+
documented API). The entry point and package name are derived from `exports`.
|
|
51
|
+
Only public surfaces are captured; members annotated `@internal` are excluded.
|
|
52
|
+
|
|
53
|
+
See `silk://packages/bundler/overview` for the full builder surface.
|
|
46
54
|
|
|
47
55
|
## Step 2 — Build the model
|
|
48
56
|
|
|
@@ -50,12 +58,12 @@ See `silk://packages/rslib-builder/overview` for full builder configuration.
|
|
|
50
58
|
pnpm --filter @savvy-web/your-package run build:prod
|
|
51
59
|
```
|
|
52
60
|
|
|
53
|
-
The production build writes `dist/npm/<unscoped-name>.api.json
|
|
54
|
-
|
|
55
|
-
is
|
|
56
|
-
|
|
57
|
-
`
|
|
58
|
-
|
|
61
|
+
The production build writes `dist/prod/npm/meta/<unscoped-name>.api.json` and
|
|
62
|
+
stages a copy into each consumer declared in `meta.localPaths` — for the MCP
|
|
63
|
+
corpus that is `packages/mcp/lib/models/<dir>/<unscoped-name>.api.json`. For
|
|
64
|
+
example, `@savvy-web/silk-effects` emits `silk-effects.api.json`. The generator
|
|
65
|
+
reads the staged copy under `lib/models/`, so its inputs stay inside the mcp
|
|
66
|
+
package and Turborepo can cache it.
|
|
59
67
|
|
|
60
68
|
## Step 3 — Render with `api-extractor-llms`
|
|
61
69
|
|
|
@@ -103,11 +111,13 @@ across all consumers.
|
|
|
103
111
|
|
|
104
112
|
## Step 4 — The MCP generator script
|
|
105
113
|
|
|
106
|
-
`packages/mcp/scripts/generate-api-docs.ts` is the reference implementation of
|
|
114
|
+
`packages/mcp/lib/scripts/generate-api-docs.ts` is the reference implementation of
|
|
107
115
|
steps 3 and 4 for the MCP resource corpus. It iterates `API_TARGETS` (defined in
|
|
108
|
-
`packages/mcp/scripts/api-targets.ts`), loads each model, injects silk-specific
|
|
109
|
-
frontmatter and `silk://` crosslink routes,
|
|
110
|
-
`content/packages/<dir>/api/<kind>/<slug>.md
|
|
116
|
+
`packages/mcp/lib/scripts/api-targets.ts`), loads each model, injects silk-specific
|
|
117
|
+
frontmatter and `silk://` crosslink routes, writes one page per symbol under
|
|
118
|
+
`public/content/packages/<dir>/api/<kind>/<slug>.md`, and writes a per-package
|
|
119
|
+
index page at `public/content/packages/<dir>/api.md` (served at the bare
|
|
120
|
+
`silk://packages/<dir>/api` URI).
|
|
111
121
|
|
|
112
122
|
```typescript
|
|
113
123
|
// The silk crosslink scheme
|
|
@@ -125,20 +135,24 @@ const docs = renderPackage(pkg, {
|
|
|
125
135
|
```
|
|
126
136
|
|
|
127
137
|
Current targets (from `api-targets.ts`): `silk-effects`, `templates`,
|
|
128
|
-
`github-action-effects`, `github-action-builder
|
|
129
|
-
|
|
130
|
-
and silk are
|
|
138
|
+
`github-action-effects`, `github-action-builder`, `bundler`, `tsdown-plugins`,
|
|
139
|
+
`rspress-builder`. The MCP package itself and `cli`/`silk` are excluded (a
|
|
140
|
+
generate→mcp build dependency would create a Turborepo cycle; cli and silk are
|
|
141
|
+
not library APIs).
|
|
131
142
|
|
|
132
143
|
## Step 5 — Compile into the corpus
|
|
133
144
|
|
|
134
145
|
After `generate-api-docs.ts` writes the markdown files, `build:catalog` picks them
|
|
135
146
|
up along with hand-authored docs and compiles the unified manifest. Generated docs
|
|
136
|
-
appear in `silk://catalog` marked `(generated)`.
|
|
147
|
+
appear in `silk://catalog` marked `(generated)`. The rendered markdown and the
|
|
148
|
+
inflated manifest are committed tracked source — only the raw `.api.json` models
|
|
149
|
+
under `lib/models/` are gitignored — so the published package ships the corpus
|
|
150
|
+
even though a release machine does not regenerate it.
|
|
137
151
|
|
|
138
152
|
In Turborepo the pipeline is:
|
|
139
153
|
|
|
140
154
|
```text
|
|
141
|
-
build:prod (each library) → generate-api-docs → build:catalog
|
|
155
|
+
build:prod (each library) → generate-api-docs → build:catalog → mcp build:prod
|
|
142
156
|
```
|
|
143
157
|
|
|
144
158
|
## Authoring notes
|
|
@@ -149,12 +163,12 @@ build:prod (each library) → generate-api-docs → build:catalog
|
|
|
149
163
|
`silk://packages/foo/api/class/myservice`.
|
|
150
164
|
- Cross-links in prose (`{@link OtherClass}`) resolve only if `OtherClass` is in
|
|
151
165
|
the same package's rendered set.
|
|
152
|
-
- Do not edit
|
|
153
|
-
overwritten on the next `generate-api-docs` run
|
|
166
|
+
- Do not hand-edit files under `public/content/packages/*/api/` (or the `api.md`
|
|
167
|
+
index) — they are overwritten on the next `generate-api-docs` run; change the
|
|
168
|
+
source TSDoc instead.
|
|
154
169
|
|
|
155
170
|
## See also
|
|
156
171
|
|
|
157
172
|
- `silk://standards/api-model-pipeline` — policy: what is generated, provenance
|
|
158
173
|
markers, coverage scope
|
|
159
|
-
- `silk://packages/
|
|
160
|
-
the model
|
|
174
|
+
- `silk://packages/bundler/overview` — configuring the builder that emits the model
|
|
@@ -24,8 +24,8 @@ Neither package depends on the other at build time. The builder bundles whatever
|
|
|
24
24
|
action code you write; the effects library provides the services that code uses.
|
|
25
25
|
|
|
26
26
|
For choosing the right builder, see `silk://guides/choosing-a-builder`. The
|
|
27
|
-
github-action-builder is separate from
|
|
28
|
-
|
|
27
|
+
github-action-builder is separate from the library bundler — it targets a
|
|
28
|
+
different output shape (single-file committed ESM bundles, not npm-published
|
|
29
29
|
libraries).
|
|
30
30
|
|
|
31
31
|
## Step 1 — Project structure
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: guides/choosing-a-builder
|
|
3
|
+
title: Choosing a builder
|
|
4
|
+
summary: When to reach for @savvy-web/bundler, @savvy-web/rspress-builder, or @savvy-web/github-action-builder for a Silk package.
|
|
5
|
+
tier: guides
|
|
6
|
+
source: hand
|
|
7
|
+
tags: [build]
|
|
8
|
+
priority: 0.5
|
|
9
|
+
related: [packages/bundler/overview, guides/building-a-github-action]
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Overview
|
|
13
|
+
|
|
14
|
+
The Silk Suite has three zero-config build tools, each targeting a different
|
|
15
|
+
output shape. Pick by what the package produces, not by personal preference.
|
|
16
|
+
|
|
17
|
+
| Package | Builds | Output |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| `@savvy-web/bundler` | TypeScript libraries | npm-published `dist/dev` + `dist/prod` |
|
|
20
|
+
| `@savvy-web/rspress-builder` | RSPress doc-site plugins | npm-published plugin package |
|
|
21
|
+
| `@savvy-web/github-action-builder` | Node.js 24 GitHub Actions | committed single-file ESM bundles |
|
|
22
|
+
|
|
23
|
+
All three auto-detect their inputs, emit a transformed publish-ready
|
|
24
|
+
`package.json` where applicable, and resolve `catalog:` and `workspace:` protocol
|
|
25
|
+
references. They differ in what they emit and how it is consumed.
|
|
26
|
+
|
|
27
|
+
## `@savvy-web/bundler`
|
|
28
|
+
|
|
29
|
+
The **default** for any TypeScript library inside `savvy-web/systems` (or any
|
|
30
|
+
pnpm-managed Silk Suite package). It is the tsdown-based build orchestrator: it
|
|
31
|
+
reads `exports` to discover entry points, builds `dist/dev/` and per-target
|
|
32
|
+
`dist/prod/<target>/`, emits a bundled self-contained `.d.ts` per public entry,
|
|
33
|
+
and on `--target prod` emits an API Extractor model for MCP and website doc
|
|
34
|
+
generation.
|
|
35
|
+
|
|
36
|
+
A package opts in with a self-executing `savvy.build.ts` that calls `defineBuild`
|
|
37
|
+
and `runBuild`, with `node savvy.build.ts --target dev` / `--target prod` build
|
|
38
|
+
scripts. See `silk://packages/bundler/overview` for the full surface.
|
|
39
|
+
|
|
40
|
+
### When to use it
|
|
41
|
+
|
|
42
|
+
- You are building a library inside `savvy-web/systems` (or a pnpm-based Silk repo)
|
|
43
|
+
- You publish to npm and want bundled type declarations
|
|
44
|
+
- You want API Extractor model emission for MCP doc generation
|
|
45
|
+
- The package uses `pnpm catalog:` or `workspace:` protocol in its dependencies
|
|
46
|
+
|
|
47
|
+
## `@savvy-web/rspress-builder`
|
|
48
|
+
|
|
49
|
+
A thin sibling to the bundler for **RSPress documentation-site plugins**. It
|
|
50
|
+
applies the same entry-point discovery and publish transform, tuned for the
|
|
51
|
+
shape an RSPress plugin package ships. Reach for it only when the package is an
|
|
52
|
+
RSPress plugin; for every other library, use the bundler.
|
|
53
|
+
|
|
54
|
+
## `@savvy-web/github-action-builder`
|
|
55
|
+
|
|
56
|
+
For **Node.js 24 GitHub Actions**, whose output is a different shape entirely:
|
|
57
|
+
self-contained ESM bundles committed to the repository (not an npm package) so a
|
|
58
|
+
runner can execute them directly. It bundles `src/main.ts` (plus optional
|
|
59
|
+
`pre.ts`/`post.ts`) into flat `dist/*.js` files and validates `action.yml`. See
|
|
60
|
+
`silk://guides/building-a-github-action`.
|
|
61
|
+
|
|
62
|
+
### When to use it
|
|
63
|
+
|
|
64
|
+
- You are building a GitHub Action, not a published library
|
|
65
|
+
- The output must be a committed single-file bundle referenced from `action.yml`
|
|
66
|
+
|
|
67
|
+
## Decision guide
|
|
68
|
+
|
|
69
|
+
```text
|
|
70
|
+
Is the package a GitHub Action (committed Node.js 24 bundle)?
|
|
71
|
+
Yes → github-action-builder
|
|
72
|
+
|
|
73
|
+
Is the package an RSPress doc-site plugin?
|
|
74
|
+
Yes → rspress-builder
|
|
75
|
+
|
|
76
|
+
Otherwise (any npm-published TypeScript library)
|
|
77
|
+
→ bundler
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Common pitfalls
|
|
81
|
+
|
|
82
|
+
**bundler / rspress-builder:** Relative imports inside source must use `.js`
|
|
83
|
+
extensions (the ESM requirement). The build reports "cannot find module" on a
|
|
84
|
+
missing extension.
|
|
85
|
+
|
|
86
|
+
**github-action-builder:** The `dist/` bundle must be committed so GitHub runners
|
|
87
|
+
can execute it; `action.yml` must declare `runs.using: "node24"`.
|
|
88
|
+
|
|
89
|
+
## See also
|
|
90
|
+
|
|
91
|
+
- `silk://packages/bundler/overview` — the library build front door in full
|
|
92
|
+
- `silk://guides/building-a-github-action` — GitHub Actions use a separate builder
|
|
93
|
+
- `silk://standards/api-model-pipeline` — how the bundler's prod API model becomes docs
|