Skip to content

Fix code-viewer JSON paths and add boilerplate files for StackBlitz sdk.openProject() #1221

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

Open
dobromirts wants to merge 1 commit into
base: vnext
Choose a base branch
from
Open

Fix code-viewer JSON paths and add boilerplate files for StackBlitz sdk.openProject() #1221

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 26 additions & 5 deletions scripts/generate-code-viewer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,10 @@ async function collectSampleFiles(folderPath, group, component, name) {

const mainTsPath = path.join(srcDir, 'index.ts');
const htmlPath = path.join(folderPath, 'index.html');
const mainTsRelPath = `./samples/${group}/${component}/${name}/src/index.ts`;
const htmlRelPath = `./samples/${group}/${component}/${name}/index.html`;
// Use project-relative paths so StackBlitz sdk.openProject() receives "src/index.ts"
// instead of "./samples/{group}/{component}/{name}/src/index.ts".
const mainTsRelPath = `src/index.ts`;
const htmlRelPath = `index.html`;

const items = [];

Expand Down Expand Up @@ -112,7 +114,7 @@ async function collectSampleFiles(folderPath, group, component, name) {
.map(async file => {
const ext = path.extname(file).slice(1).toLowerCase();
const filePath = path.join(srcDir, file);
const relPath = `./samples/${group}/${component}/${name}/src/${file}`;
const relPath = `src/${file}`;

if (!INCLUDE_EXTS.has('.' + ext)) return null;

Expand Down Expand Up @@ -161,14 +163,13 @@ async function collectSampleFiles(folderPath, group, component, name) {
if (dataFileItems.length === 1) {
items.push(dataFileItems[0]);
} else if (dataFileItems.length > 1) {
const dataFolder = `./samples/${group}/${component}/${name}/src`;
let combinedContent = '// NOTE this file contains multiple data sources:';
for (let i = 0; i < dataFileItems.length; i++) {
combinedContent += `\n\n// Data Source #${i + 1}\n`;
combinedContent += dataFileItems[i].content + '\n';
}
items.push({
path: `${dataFolder}/DataSources.ts`,
path: `src/DataSources.ts`,
content: combinedContent,
fileExtension: 'ts',
fileHeader: 'DATA',
Expand All @@ -177,6 +178,26 @@ async function collectSampleFiles(folderPath, group, component, name) {
});
}

// 4. Boilerplate files so StackBlitz sdk.openProject() has a complete runnable project.
const boilerplate = [
{ file: 'tsconfig.json', ext: 'json', header: 'json' },
{ file: 'webpack.config.js', ext: 'js', header: 'js' },
{ file: 'package.json', ext: 'json', header: 'json' },
];
for (const b of boilerplate) {
const bPath = path.join(folderPath, b.file);
if (await fileExists(bPath)) {
items.push({
path: b.file,
content: await fsp.readFile(bPath, 'utf8'),
fileExtension: b.ext,
fileHeader: b.header,
isMain: false,
hasRelativeAssetsUrls: false,
});
}
}

return items;
}

Expand Down
Loading