@techdocs/cli 1.8.6 → 1.8.7
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/CHANGELOG.md +11 -0
- package/dist/cjs/{PublisherConfig-cbad5748.cjs.js → PublisherConfig-B9GYw8mh.cjs.js} +1 -1
- package/dist/cjs/{PublisherConfig-cbad5748.cjs.js.map → PublisherConfig-B9GYw8mh.cjs.js.map} +1 -1
- package/dist/cjs/{generate-f9a039d6.cjs.js → generate-ZiP9GGnN.cjs.js} +9 -9
- package/dist/cjs/{generate-f9a039d6.cjs.js.map → generate-ZiP9GGnN.cjs.js.map} +1 -1
- package/dist/cjs/{migrate-6884188f.cjs.js → migrate-CccqCfHt.cjs.js} +4 -4
- package/dist/cjs/{migrate-6884188f.cjs.js.map → migrate-CccqCfHt.cjs.js.map} +1 -1
- package/dist/cjs/{mkdocs-35db8d18.cjs.js → mkdocs-v2pfmOKh.cjs.js} +9 -9
- package/dist/cjs/{mkdocs-35db8d18.cjs.js.map → mkdocs-v2pfmOKh.cjs.js.map} +1 -1
- package/dist/cjs/{publish-009fdf9f.cjs.js → publish-D19dZg09.cjs.js} +4 -4
- package/dist/cjs/{publish-009fdf9f.cjs.js.map → publish-D19dZg09.cjs.js.map} +1 -1
- package/dist/cjs/{serve-c333b152.cjs.js → serve-C91gBkLm.cjs.js} +18 -18
- package/dist/cjs/{serve-c333b152.cjs.js.map → serve-C91gBkLm.cjs.js.map} +1 -1
- package/dist/cjs/{utility-3c0df5a9.cjs.js → utility-CsspJYjU.cjs.js} +5 -5
- package/dist/cjs/{utility-3c0df5a9.cjs.js.map → utility-CsspJYjU.cjs.js.map} +1 -1
- package/dist/cjs/{utils-8afb2c2c.cjs.js → utils-xnPYUjip.cjs.js} +1 -1
- package/dist/cjs/{utils-8afb2c2c.cjs.js.map → utils-xnPYUjip.cjs.js.map} +1 -1
- package/dist/embedded-app/.config-schema.json +115 -141
- package/dist/embedded-app/index.html +1 -1
- package/dist/embedded-app/static/{124.bcbbf0a4.chunk.js → 124.79598769.chunk.js} +2 -2
- package/dist/embedded-app/static/{124.bcbbf0a4.chunk.js.map → 124.79598769.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{2401.937251cb.chunk.js → 2401.1d69db66.chunk.js} +2 -2
- package/dist/embedded-app/static/{2401.937251cb.chunk.js.map → 2401.1d69db66.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{2420.940cc021.chunk.js → 2420.af0a138a.chunk.js} +2 -2
- package/dist/embedded-app/static/{2420.940cc021.chunk.js.map → 2420.af0a138a.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{287.4f1942e3.chunk.js → 287.e4086426.chunk.js} +2 -2
- package/dist/embedded-app/static/{287.4f1942e3.chunk.js.map → 287.e4086426.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{3632.135770ac.chunk.js → 3632.311321b8.chunk.js} +2 -2
- package/dist/embedded-app/static/{3632.135770ac.chunk.js.map → 3632.311321b8.chunk.js.map} +1 -1
- package/dist/embedded-app/static/4487.bd1aa826.chunk.js +3 -0
- package/dist/embedded-app/static/{4487.7a16d602.chunk.js.map → 4487.bd1aa826.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{4516.f764862f.chunk.js → 4516.88dfcdbc.chunk.js} +2 -2
- package/dist/embedded-app/static/{4516.f764862f.chunk.js.map → 4516.88dfcdbc.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{4992.7ed27cd6.chunk.js → 4992.cffa1169.chunk.js} +2 -2
- package/dist/embedded-app/static/{4992.7ed27cd6.chunk.js.map → 4992.cffa1169.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{6271.127ce25e.chunk.js → 6271.25bd2120.chunk.js} +2 -2
- package/dist/embedded-app/static/{6271.127ce25e.chunk.js.map → 6271.25bd2120.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{8384.7cb59b29.chunk.js → 8384.6e8b1108.chunk.js} +2 -2
- package/dist/embedded-app/static/{8384.7cb59b29.chunk.js.map → 8384.6e8b1108.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{9234.d9f1c8a3.chunk.js → 9234.2136bcf4.chunk.js} +2 -2
- package/dist/embedded-app/static/{9234.d9f1c8a3.chunk.js.map → 9234.2136bcf4.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{9652.b3a364b6.chunk.js → 9652.b4fc9f0c.chunk.js} +2 -2
- package/dist/embedded-app/static/{9652.b3a364b6.chunk.js.map → 9652.b4fc9f0c.chunk.js.map} +1 -1
- package/dist/embedded-app/static/{main.eafbd509.js → main.6a42e4f3.js} +6 -6
- package/dist/embedded-app/static/main.6a42e4f3.js.map +1 -0
- package/dist/embedded-app/static/{runtime.eafbd509.js → runtime.6a42e4f3.js} +2 -2
- package/dist/embedded-app/static/{runtime.eafbd509.js.map → runtime.6a42e4f3.js.map} +1 -1
- package/dist/embedded-app/static/vendor.6a42e4f3.js +160 -0
- package/dist/embedded-app/static/vendor.6a42e4f3.js.map +1 -0
- package/dist/index.cjs.js +6 -6
- package/package.json +4 -4
- package/dist/embedded-app/static/4487.7a16d602.chunk.js +0 -3
- package/dist/embedded-app/static/main.eafbd509.js.map +0 -1
- package/dist/embedded-app/static/vendor.eafbd509.js +0 -160
- package/dist/embedded-app/static/vendor.eafbd509.js.map +0 -1
package/dist/index.cjs.js
CHANGED
|
@@ -47,7 +47,7 @@ function registerCommands(program) {
|
|
|
47
47
|
"--runAsDefaultUser",
|
|
48
48
|
"Bypass setting the container user as the same user and group id as host for Linux and MacOS",
|
|
49
49
|
false
|
|
50
|
-
).alias("build").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-
|
|
50
|
+
).alias("build").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-ZiP9GGnN.cjs.js'); }).then((m) => m.default)));
|
|
51
51
|
program.command("migrate").description(
|
|
52
52
|
"Migrate objects with case-sensitive entity triplets to lower-case versions."
|
|
53
53
|
).requiredOption(
|
|
@@ -91,7 +91,7 @@ function registerCommands(program) {
|
|
|
91
91
|
"--concurrency <MAX CONCURRENT REQS>",
|
|
92
92
|
"Optional Controls the number of API requests allowed to be performed simultaneously.",
|
|
93
93
|
"25"
|
|
94
|
-
).option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/migrate-
|
|
94
|
+
).option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/migrate-CccqCfHt.cjs.js'); }).then((m) => m.default)));
|
|
95
95
|
program.command("publish").description(
|
|
96
96
|
"Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc."
|
|
97
97
|
).requiredOption(
|
|
@@ -147,7 +147,7 @@ function registerCommands(program) {
|
|
|
147
147
|
"--directory <PATH>",
|
|
148
148
|
"Path of the directory containing generated files to publish",
|
|
149
149
|
"./site/"
|
|
150
|
-
).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/publish-
|
|
150
|
+
).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/publish-D19dZg09.cjs.js'); }).then((m) => m.default)));
|
|
151
151
|
program.command("serve:mkdocs").description("Serve a documentation project locally using MkDocs serve.").option(
|
|
152
152
|
"-i, --docker-image <DOCKER_IMAGE>",
|
|
153
153
|
"The mkdocs docker container to use",
|
|
@@ -165,7 +165,7 @@ function registerCommands(program) {
|
|
|
165
165
|
"--site-name",
|
|
166
166
|
"Name for site when using default MkDocs config",
|
|
167
167
|
"Documentation Site"
|
|
168
|
-
).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/mkdocs-
|
|
168
|
+
).option("-p, --port <PORT>", "Port to serve documentation locally", "8000").option("-v --verbose", "Enable verbose output.", false).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/mkdocs-v2pfmOKh.cjs.js'); }).then((m) => m.default)));
|
|
169
169
|
program.command("serve").description(
|
|
170
170
|
"Serve a documentation project locally in a Backstage app-like environment"
|
|
171
171
|
).option(
|
|
@@ -213,7 +213,7 @@ function registerCommands(program) {
|
|
|
213
213
|
"--preview-app-port can only be used together with --preview-app-bundle-path"
|
|
214
214
|
);
|
|
215
215
|
}
|
|
216
|
-
}).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/serve-
|
|
216
|
+
}).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/serve-C91gBkLm.cjs.js'); }).then((m) => m.default)));
|
|
217
217
|
}
|
|
218
218
|
function lazy(getActionFunc) {
|
|
219
219
|
return async (...args) => {
|
|
@@ -228,7 +228,7 @@ function lazy(getActionFunc) {
|
|
|
228
228
|
};
|
|
229
229
|
}
|
|
230
230
|
|
|
231
|
-
var version = "1.8.
|
|
231
|
+
var version = "1.8.7";
|
|
232
232
|
|
|
233
233
|
const main = (argv) => {
|
|
234
234
|
commander.program.name("techdocs-cli").version(version);
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@techdocs/cli",
|
|
3
3
|
"description": "Utility CLI for managing TechDocs sites in Backstage.",
|
|
4
|
-
"version": "1.8.
|
|
4
|
+
"version": "1.8.7",
|
|
5
5
|
"publishConfig": {
|
|
6
6
|
"access": "public"
|
|
7
7
|
},
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"techdocs-cli": "bin/techdocs-cli"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"@backstage/cli": "^0.26.
|
|
38
|
+
"@backstage/cli": "^0.26.1",
|
|
39
39
|
"@types/commander": "^2.12.2",
|
|
40
40
|
"@types/fs-extra": "^11.0.0",
|
|
41
41
|
"@types/http-proxy": "^1.17.4",
|
|
@@ -56,11 +56,11 @@
|
|
|
56
56
|
"ext": "ts"
|
|
57
57
|
},
|
|
58
58
|
"dependencies": {
|
|
59
|
-
"@backstage/backend-common": "^0.21.
|
|
59
|
+
"@backstage/backend-common": "^0.21.5",
|
|
60
60
|
"@backstage/catalog-model": "^1.4.5",
|
|
61
61
|
"@backstage/cli-common": "^0.1.13",
|
|
62
62
|
"@backstage/config": "^1.2.0",
|
|
63
|
-
"@backstage/plugin-techdocs-node": "^1.12.
|
|
63
|
+
"@backstage/plugin-techdocs-node": "^1.12.1",
|
|
64
64
|
"@types/dockerode": "^3.3.0",
|
|
65
65
|
"commander": "^12.0.0",
|
|
66
66
|
"dockerode": "^4.0.0",
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
"use strict";(()=>{(self.webpackChunktechdocs_cli_embedded_app=self.webpackChunktechdocs_cli_embedded_app||[]).push([[4487],{94487:function(rt,j,e){e.r(j),e.d(j,{TechDocsCustomHome:function(){return ot}});var a=e(31085),m=e(14041),A=e(91638),v=e(58837),I=e(51372),P=e(6820),f=e(72427),B=e(16009),R=e(67871);function b(){const t=(0,f.gf)(B.K),{loading:o,value:n}=(0,A.default)(async()=>{const{ownershipEntityRefs:r}=await t.getBackstageIdentity();return r},[]),s=(0,m.useMemo)(()=>{const r=new Set(n!=null?n:[]);return c=>{const l=(0,R.t)(c,I.vv).map(P.U2);for(const i of l)if(r.has(i))return!0;return!1}},[n]);return{loading:o,isOwnedEntity:s}}var H=e(7341),D=e(86519),E=e(27125),O=e(82779),h=e(95768),W=e(9222),U=e(65461),p=e(10394),S=e(12398);const G=t=>(0,S.A)({root:{display:"grid",gridTemplateColumns:"repeat(auto-fill, minmax(22em, 1fr))",gridAutoRows:"1fr",gridGap:t.spacing(2)}}),N=(0,v.A)(G,{name:"BackstageItemCardGrid"});function V(t){const{children:o,...n}=t,s=N(n);return(0,a.jsx)(p.A,{className:s.root,...n,children:o})}var T=e(72501);const z=t=>(0,S.A)({root:{color:t.palette.common.white,padding:t.spacing(2,2,3),backgroundImage:t.getPageTheme({themeId:"card"}).backgroundImage,backgroundPosition:0,backgroundSize:"inherit"}}),F=(0,v.A)(z,{name:"BackstageItemCardHeader"});function L(t){const{title:o,subtitle:n,children:s}=t,r=F(t);return(0,a.jsxs)(p.A,{className:r.root,children:[n&&(0,a.jsx)(T.A,{variant:"subtitle2",component:"h3",children:n}),o&&(0,a.jsx)(T.A,{variant:"h6",component:"h4",children:o}),s]})}var M=e(73896),K=e(40703),Y=e(59469),$=e(48653),J=e(57369);const Q=t=>{const{entities:o}=t,n=(0,W.S)(O.Oc),s=(0,f.gf)(U.U);return o?(0,a.jsx)(V,{"data-testid":"docs-explore",children:o!=null&&o.length?o.map((r,c)=>{var l,i;return(0,a.jsxs)(K.A,{children:[(0,a.jsx)(J.A,{children:(0,a.jsx)(L,{title:(l=r.metadata.title)!==null&&l!==void 0?l:r.metadata.name})}),(0,a.jsx)($.A,{children:r.metadata.description}),(0,a.jsx)(Y.A,{children:(0,a.jsx)(M.z,{to:n({namespace:(0,h.V)((i=r.metadata.namespace)!==null&&i!==void 0?i:"default",s),kind:(0,h.V)(r.kind,s),name:(0,h.V)(r.metadata.name,s)}),color:"primary","data-testid":"read_docs",children:"Read Docs"})})]},c)}):null}):null};var y=e(81859),X=e(59428),Z=e(3851),x=e(26280),k=e(68146),w=e(88640),q=e(77310),_=e(38605),tt=e(31653);const et=(0,v.A)(t=>({tabsWrapper:{gridArea:"pageSubheader",backgroundColor:t.palette.background.paper,paddingLeft:t.spacing(3),minWidth:0},defaultTab:{...t.typography.caption,padding:t.spacing(3,3),textTransform:"uppercase",fontWeight:t.typography.fontWeightBold,color:t.palette.text.secondary},selected:{color:t.palette.text.primary},tabRoot:{"&:hover":{backgroundColor:t.palette.background.default,color:t.palette.text.primary}}}),{name:"BackstageHeaderTabs"});function at(t){const{tabs:o,onChange:n,selectedIndex:s}=t,[r,c]=(0,m.useState)(s!=null?s:0),l=et(),i=(0,m.useCallback)((u,d)=>{s===void 0&&c(d),n&&n(d)},[s,n]);return(0,m.useEffect)(()=>{s!==void 0&&c(s)},[s]),(0,a.jsx)(p.A,{className:l.tabsWrapper,children:(0,a.jsx)(tt.A,{indicatorColor:"primary",textColor:"inherit",variant:"scrollable",scrollButtons:"auto","aria-label":"tabs",onChange:i,value:r,children:o.map((u,d)=>(0,m.createElement)(_.A,{...u.tabProps,"data-testid":`header-tab-${d}`,label:u.label,key:u.id,value:d,className:l.defaultTab,classes:{selected:l.selected,root:l.tabRoot}}))})})}const nt={DocsTable:E.o,DocsCardGrid:Q},st=({config:t,entities:o,index:n})=>{const r=(0,v.A)({panelContainer:{marginBottom:"2rem",...t.panelCSS?t.panelCSS:{}}})(),{loading:c,isOwnedEntity:l}=b(),i=nt[t.panelType],u=o.filter(d=>t.filterPredicate==="ownedByUser"?c?!1:l(d):typeof t.filterPredicate=="function"&&t.filterPredicate(d));return(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)(X.d,{title:t.title,description:t.description,children:n===0?(0,a.jsx)(Z.Y,{children:"Discover documentation in your ecosystem."}):null}),(0,a.jsx)("div",{className:r.panelContainer,children:(0,a.jsx)(i,{"data-testid":"techdocs-custom-panel",entities:u})})]})},ot=t=>{const{tabsConfig:o}=t,[n,s]=(0,m.useState)(0),r=(0,f.gf)(H.v),{value:c,loading:l,error:i}=(0,A.default)(async()=>(await r.getEntities({filter:{"metadata.annotations.backstage.io/techdocs-ref":D.c},fields:["apiVersion","kind","metadata","relations","spec.owner","spec.type"]})).items.filter(g=>{var C;return!!(!((C=g.metadata.annotations)===null||C===void 0)&&C["backstage.io/techdocs-ref"])})),u=o[n];return l?(0,a.jsx)(y.S,{children:(0,a.jsx)(x.U,{children:(0,a.jsx)(k.k,{})})}):i?(0,a.jsx)(y.S,{children:(0,a.jsx)(x.U,{children:(0,a.jsx)(w.B,{severity:"error",title:"Could not load available documentation.",children:(0,a.jsx)(q.z,{language:"text",text:i.toString()})})})}):(0,a.jsxs)(y.S,{children:[(0,a.jsx)(at,{selectedIndex:n,onChange:d=>s(d),tabs:o.map(({label:d},g)=>({id:g.toString(),label:d}))}),(0,a.jsx)(x.U,{"data-testid":"techdocs-content",children:u.panels.map((d,g)=>(0,a.jsx)(st,{config:d,entities:c||[],index:g},g))})]})}}}]);})();
|
|
2
|
-
|
|
3
|
-
//# sourceMappingURL=4487.7a16d602.chunk.js.map
|