Skip to content

feat: support for custom extension for docs-readme output target #1971

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
vidarc wants to merge 2 commits into from
Closed

feat: support for custom extension for docs-readme output target #1971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddd821f
support for custom readme doc extensions
vidarc Oct 26, 2019
17d6845
fix jest typing mismatch
vidarc Oct 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion src/compiler/docs/readme/output-docs.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,15 @@ export async function generateReadme(config: d.Config, compilerCtx: d.CompilerCt
await Promise.all(readmeOutputs.map(async readmeOutput => {
if (readmeOutput.dir) {
const readmeContent = generateMarkdown(config, userContent, docsData, cmps, readmeOutput.footer);
const relPath = config.sys.path.relative(config.srcDir, docsData.readmePath);

let relPath;
if (readmeOutput.extension) {
const readme = docsData.readmePath.split('.');
relPath = config.sys.path.relative(config.srcDir, `${readme[0]}.${readmeOutput.extension}`);
} else {
relPath = config.sys.path.relative(config.srcDir, docsData.readmePath);
}

const absPath = config.sys.path.join(readmeOutput.dir, relPath);
const results = await compilerCtx.fs.writeFile(absPath, readmeContent);
if (results.changedContent) {
Expand Down
1 change: 1 addition & 0 deletions src/declarations/output-targets.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ export interface OutputTargetDocsReadme extends OutputTargetBase {
dir?: string;
footer?: string;
strict?: boolean;
extension?: string;
}


Expand Down
2 changes: 1 addition & 1 deletion src/declarations/testing.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Build } from './build-conditionals';

declare global {
namespace jest {
interface Matchers<R> {
interface Matchers<R, T> {
/**
* Compares HTML, but first normalizes the HTML so all
* whitespace, attribute order and css class order are
Expand Down