@fern-api/generator-cli 0.0.3 → 0.0.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.cjs +23 -5
- package/package.json +1 -1
package/dist/cli.cjs
CHANGED
|
@@ -7012,7 +7012,7 @@ var ReadmeGenerator = class {
|
|
|
7012
7012
|
this.readmeParser = readmeParser;
|
|
7013
7013
|
this.readmeConfig = readmeConfig;
|
|
7014
7014
|
this.originalReadme = originalReadme;
|
|
7015
|
-
this.languageTitle = this.readmeConfig.language
|
|
7015
|
+
this.languageTitle = languageToTitle(this.readmeConfig.language);
|
|
7016
7016
|
this.organizationPascalCase = pascalCase(this.readmeConfig.organization);
|
|
7017
7017
|
}
|
|
7018
7018
|
async generateReadme({ output }) {
|
|
@@ -7028,8 +7028,8 @@ var ReadmeGenerator = class {
|
|
|
7028
7028
|
}
|
|
7029
7029
|
generateBlocks() {
|
|
7030
7030
|
const blocks = [];
|
|
7031
|
-
if (this.readmeConfig.
|
|
7032
|
-
blocks.push(this.generateDocumentation({ docsLink: this.readmeConfig.
|
|
7031
|
+
if (this.readmeConfig.apiReferenceLink != null) {
|
|
7032
|
+
blocks.push(this.generateDocumentation({ docsLink: this.readmeConfig.apiReferenceLink }));
|
|
7033
7033
|
}
|
|
7034
7034
|
if (this.readmeConfig.requirements != null) {
|
|
7035
7035
|
blocks.push(this.generateRequirements({ requirements: this.readmeConfig.requirements }));
|
|
@@ -7061,7 +7061,7 @@ var ReadmeGenerator = class {
|
|
|
7061
7061
|
if (index > 0) {
|
|
7062
7062
|
writer.writeLine();
|
|
7063
7063
|
}
|
|
7064
|
-
writer.writeCodeBlock(this.readmeConfig.language.
|
|
7064
|
+
writer.writeCodeBlock(this.readmeConfig.language.type, snippet);
|
|
7065
7065
|
});
|
|
7066
7066
|
if (feature.addendum != null) {
|
|
7067
7067
|
writer.writeLine(feature.addendum);
|
|
@@ -7120,7 +7120,7 @@ var ReadmeGenerator = class {
|
|
|
7120
7120
|
const writer = new StringWriter();
|
|
7121
7121
|
writer.writeLine("## Documentation");
|
|
7122
7122
|
writer.writeLine();
|
|
7123
|
-
writer.writeLine(
|
|
7123
|
+
writer.writeLine(`API reference documentation is available [here](${docsLink}).`);
|
|
7124
7124
|
writer.writeLine();
|
|
7125
7125
|
return new Block({
|
|
7126
7126
|
id: "DOCUMENTATION",
|
|
@@ -7392,6 +7392,24 @@ On the other hand, contributions to the README are always very welcome!
|
|
|
7392
7392
|
return !feature.snippetsAreOptional && (feature.snippets == null || feature.snippets.length === 0);
|
|
7393
7393
|
}
|
|
7394
7394
|
};
|
|
7395
|
+
function languageToTitle(language) {
|
|
7396
|
+
switch (language.type) {
|
|
7397
|
+
case "typescript":
|
|
7398
|
+
return "TypeScript";
|
|
7399
|
+
case "python":
|
|
7400
|
+
return "Python";
|
|
7401
|
+
case "go":
|
|
7402
|
+
return "Go";
|
|
7403
|
+
case "java":
|
|
7404
|
+
return "Java";
|
|
7405
|
+
case "ruby":
|
|
7406
|
+
return "Ruby";
|
|
7407
|
+
case "csharp":
|
|
7408
|
+
return "C#";
|
|
7409
|
+
default:
|
|
7410
|
+
assertNever(language);
|
|
7411
|
+
}
|
|
7412
|
+
}
|
|
7395
7413
|
function featureIDToTitle(featureID) {
|
|
7396
7414
|
return featureID.split("_").map((s) => pascalCase(s)).join(" ");
|
|
7397
7415
|
}
|