@pactosigna/records 0.1.3 → 0.1.4
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/dist/cli.js +76 -0
- package/dist/generate.d.ts.map +1 -1
- package/dist/generators/arc-generator.d.ts +4 -0
- package/dist/generators/arc-generator.d.ts.map +1 -0
- package/dist/generators/sdd-generator.d.ts +4 -0
- package/dist/generators/sdd-generator.d.ts.map +1 -0
- package/dist/index.js +76 -0
- package/package.json +1 -1
package/dist/cli.js
CHANGED
|
@@ -5241,6 +5241,80 @@ function generateRmr(input) {
|
|
|
5241
5241
|
});
|
|
5242
5242
|
}
|
|
5243
5243
|
|
|
5244
|
+
// src/generators/arc-generator.ts
|
|
5245
|
+
function generateArc(input) {
|
|
5246
|
+
const docs = readDocuments(input.rootDir, "docs/software/architecture");
|
|
5247
|
+
if (docs.length === 0) {
|
|
5248
|
+
console.warn("ARC: no approved/effective architecture documents found \u2014 skipping");
|
|
5249
|
+
return null;
|
|
5250
|
+
}
|
|
5251
|
+
const content = [];
|
|
5252
|
+
content.push({ text: "Table of Contents", style: "h2", margin: [0, 0, 0, 10] });
|
|
5253
|
+
content.push({
|
|
5254
|
+
ol: docs.map((d) => ({
|
|
5255
|
+
text: `${d.frontmatter.id}: ${d.frontmatter.title}`,
|
|
5256
|
+
margin: [0, 2, 0, 2]
|
|
5257
|
+
}))
|
|
5258
|
+
});
|
|
5259
|
+
content.push({ text: "", pageBreak: "after" });
|
|
5260
|
+
for (const doc of docs) {
|
|
5261
|
+
content.push({
|
|
5262
|
+
text: `${doc.frontmatter.id}: ${doc.frontmatter.title}`,
|
|
5263
|
+
style: "h2",
|
|
5264
|
+
margin: [0, 10, 0, 6]
|
|
5265
|
+
});
|
|
5266
|
+
content.push(...markdownToPdfmake(doc.body));
|
|
5267
|
+
content.push({ text: "", margin: [0, 20, 0, 0] });
|
|
5268
|
+
}
|
|
5269
|
+
return buildDocumentDefinition({
|
|
5270
|
+
config: input.config,
|
|
5271
|
+
rootDir: input.rootDir,
|
|
5272
|
+
recordTitle: "Software Architecture Description",
|
|
5273
|
+
recordId: "ARC",
|
|
5274
|
+
version: input.version,
|
|
5275
|
+
date: input.date,
|
|
5276
|
+
revisionHistory: input.revisionHistory,
|
|
5277
|
+
content
|
|
5278
|
+
});
|
|
5279
|
+
}
|
|
5280
|
+
|
|
5281
|
+
// src/generators/sdd-generator.ts
|
|
5282
|
+
function generateSdd(input) {
|
|
5283
|
+
const docs = readDocuments(input.rootDir, "docs/software/design");
|
|
5284
|
+
if (docs.length === 0) {
|
|
5285
|
+
console.warn("SDD: no approved/effective detailed design documents found \u2014 skipping");
|
|
5286
|
+
return null;
|
|
5287
|
+
}
|
|
5288
|
+
const content = [];
|
|
5289
|
+
content.push({ text: "Table of Contents", style: "h2", margin: [0, 0, 0, 10] });
|
|
5290
|
+
content.push({
|
|
5291
|
+
ol: docs.map((d) => ({
|
|
5292
|
+
text: `${d.frontmatter.id}: ${d.frontmatter.title}`,
|
|
5293
|
+
margin: [0, 2, 0, 2]
|
|
5294
|
+
}))
|
|
5295
|
+
});
|
|
5296
|
+
content.push({ text: "", pageBreak: "after" });
|
|
5297
|
+
for (const doc of docs) {
|
|
5298
|
+
content.push({
|
|
5299
|
+
text: `${doc.frontmatter.id}: ${doc.frontmatter.title}`,
|
|
5300
|
+
style: "h2",
|
|
5301
|
+
margin: [0, 10, 0, 6]
|
|
5302
|
+
});
|
|
5303
|
+
content.push(...markdownToPdfmake(doc.body));
|
|
5304
|
+
content.push({ text: "", margin: [0, 20, 0, 0] });
|
|
5305
|
+
}
|
|
5306
|
+
return buildDocumentDefinition({
|
|
5307
|
+
config: input.config,
|
|
5308
|
+
rootDir: input.rootDir,
|
|
5309
|
+
recordTitle: "Software Detailed Design",
|
|
5310
|
+
recordId: "SDD",
|
|
5311
|
+
version: input.version,
|
|
5312
|
+
date: input.date,
|
|
5313
|
+
revisionHistory: input.revisionHistory,
|
|
5314
|
+
content
|
|
5315
|
+
});
|
|
5316
|
+
}
|
|
5317
|
+
|
|
5244
5318
|
// src/github/changelog.ts
|
|
5245
5319
|
import { execFileSync } from "child_process";
|
|
5246
5320
|
import { resolve as resolve5 } from "path";
|
|
@@ -5296,6 +5370,8 @@ var RECORD_GENERATORS = [
|
|
|
5296
5370
|
{ name: "URS-User-Requirements-Specification", fn: generateUrs },
|
|
5297
5371
|
{ name: "PRS-Product-Requirements-Specification", fn: generatePrs },
|
|
5298
5372
|
{ name: "SRS-Software-Requirements-Specification", fn: generateSrs },
|
|
5373
|
+
{ name: "ARC-Software-Architecture-Description", fn: generateArc },
|
|
5374
|
+
{ name: "SDD-Software-Detailed-Design", fn: generateSdd },
|
|
5299
5375
|
{ name: "PTA-Product-Traceability-Analysis", fn: generatePta },
|
|
5300
5376
|
{ name: "RMR-Risk-Management-Report", fn: generateRmr }
|
|
5301
5377
|
];
|
package/dist/generate.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"generate.d.ts","sourceRoot":"","sources":["../src/generate.ts"],"names":[],"mappings":"AAqBA,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAkCD,wBAAsB,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CA8C1E"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"arc-generator.d.ts","sourceRoot":"","sources":["../../src/generators/arc-generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAI3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,wBAAgB,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,oBAAoB,GAAG,IAAI,CAwC9E"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sdd-generator.d.ts","sourceRoot":"","sources":["../../src/generators/sdd-generator.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAW,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAI3E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEzD,wBAAgB,WAAW,CAAC,KAAK,EAAE,cAAc,GAAG,oBAAoB,GAAG,IAAI,CAwC9E"}
|
package/dist/index.js
CHANGED
|
@@ -1119,6 +1119,80 @@ function generateRmr(input) {
|
|
|
1119
1119
|
});
|
|
1120
1120
|
}
|
|
1121
1121
|
|
|
1122
|
+
// src/generators/arc-generator.ts
|
|
1123
|
+
function generateArc(input) {
|
|
1124
|
+
const docs = readDocuments(input.rootDir, "docs/software/architecture");
|
|
1125
|
+
if (docs.length === 0) {
|
|
1126
|
+
console.warn("ARC: no approved/effective architecture documents found \u2014 skipping");
|
|
1127
|
+
return null;
|
|
1128
|
+
}
|
|
1129
|
+
const content = [];
|
|
1130
|
+
content.push({ text: "Table of Contents", style: "h2", margin: [0, 0, 0, 10] });
|
|
1131
|
+
content.push({
|
|
1132
|
+
ol: docs.map((d) => ({
|
|
1133
|
+
text: `${d.frontmatter.id}: ${d.frontmatter.title}`,
|
|
1134
|
+
margin: [0, 2, 0, 2]
|
|
1135
|
+
}))
|
|
1136
|
+
});
|
|
1137
|
+
content.push({ text: "", pageBreak: "after" });
|
|
1138
|
+
for (const doc of docs) {
|
|
1139
|
+
content.push({
|
|
1140
|
+
text: `${doc.frontmatter.id}: ${doc.frontmatter.title}`,
|
|
1141
|
+
style: "h2",
|
|
1142
|
+
margin: [0, 10, 0, 6]
|
|
1143
|
+
});
|
|
1144
|
+
content.push(...markdownToPdfmake(doc.body));
|
|
1145
|
+
content.push({ text: "", margin: [0, 20, 0, 0] });
|
|
1146
|
+
}
|
|
1147
|
+
return buildDocumentDefinition({
|
|
1148
|
+
config: input.config,
|
|
1149
|
+
rootDir: input.rootDir,
|
|
1150
|
+
recordTitle: "Software Architecture Description",
|
|
1151
|
+
recordId: "ARC",
|
|
1152
|
+
version: input.version,
|
|
1153
|
+
date: input.date,
|
|
1154
|
+
revisionHistory: input.revisionHistory,
|
|
1155
|
+
content
|
|
1156
|
+
});
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
// src/generators/sdd-generator.ts
|
|
1160
|
+
function generateSdd(input) {
|
|
1161
|
+
const docs = readDocuments(input.rootDir, "docs/software/design");
|
|
1162
|
+
if (docs.length === 0) {
|
|
1163
|
+
console.warn("SDD: no approved/effective detailed design documents found \u2014 skipping");
|
|
1164
|
+
return null;
|
|
1165
|
+
}
|
|
1166
|
+
const content = [];
|
|
1167
|
+
content.push({ text: "Table of Contents", style: "h2", margin: [0, 0, 0, 10] });
|
|
1168
|
+
content.push({
|
|
1169
|
+
ol: docs.map((d) => ({
|
|
1170
|
+
text: `${d.frontmatter.id}: ${d.frontmatter.title}`,
|
|
1171
|
+
margin: [0, 2, 0, 2]
|
|
1172
|
+
}))
|
|
1173
|
+
});
|
|
1174
|
+
content.push({ text: "", pageBreak: "after" });
|
|
1175
|
+
for (const doc of docs) {
|
|
1176
|
+
content.push({
|
|
1177
|
+
text: `${doc.frontmatter.id}: ${doc.frontmatter.title}`,
|
|
1178
|
+
style: "h2",
|
|
1179
|
+
margin: [0, 10, 0, 6]
|
|
1180
|
+
});
|
|
1181
|
+
content.push(...markdownToPdfmake(doc.body));
|
|
1182
|
+
content.push({ text: "", margin: [0, 20, 0, 0] });
|
|
1183
|
+
}
|
|
1184
|
+
return buildDocumentDefinition({
|
|
1185
|
+
config: input.config,
|
|
1186
|
+
rootDir: input.rootDir,
|
|
1187
|
+
recordTitle: "Software Detailed Design",
|
|
1188
|
+
recordId: "SDD",
|
|
1189
|
+
version: input.version,
|
|
1190
|
+
date: input.date,
|
|
1191
|
+
revisionHistory: input.revisionHistory,
|
|
1192
|
+
content
|
|
1193
|
+
});
|
|
1194
|
+
}
|
|
1195
|
+
|
|
1122
1196
|
// src/github/changelog.ts
|
|
1123
1197
|
import { execFileSync } from "child_process";
|
|
1124
1198
|
import { resolve as resolve5 } from "path";
|
|
@@ -1174,6 +1248,8 @@ var RECORD_GENERATORS = [
|
|
|
1174
1248
|
{ name: "URS-User-Requirements-Specification", fn: generateUrs },
|
|
1175
1249
|
{ name: "PRS-Product-Requirements-Specification", fn: generatePrs },
|
|
1176
1250
|
{ name: "SRS-Software-Requirements-Specification", fn: generateSrs },
|
|
1251
|
+
{ name: "ARC-Software-Architecture-Description", fn: generateArc },
|
|
1252
|
+
{ name: "SDD-Software-Detailed-Design", fn: generateSdd },
|
|
1177
1253
|
{ name: "PTA-Product-Traceability-Analysis", fn: generatePta },
|
|
1178
1254
|
{ name: "RMR-Risk-Management-Report", fn: generateRmr }
|
|
1179
1255
|
];
|