cargdev/angular
1
0
Fork 0
Code Issues 8 Pull Requests Actions Packages Projects Releases Wiki Activity

build(aio): check for obsolete plnkr.json and missing main files (#20165)

Browse Source 
Also, remove `plnkr.json` for `service-worker-getting-started` guide,
since it is not used and ServiceWorker cannot work correctly in
plnkr/stackblitz anyway (e.g. no build step to re-compute hashes).
A zipper might be useful and can be added in a subsequent PR, but it is
currently broken (e.g. no dependency on `@angular/service-worker`).

PR Close #20165
This commit is contained in:
George Kalpakas
2018-01-22 14:42:59 +02:00
committed by Miško Hevery
parent 6d9fcd62de
commit 5894f6ee1c
25 changed files with 77 additions and 232 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
aio/tools/stackblitz-builder/builder.js
View File

@ -29,6 +29,8 @@ class StackblitzBuilder {
}
build() {
this._checkForOutdatedConfig();
// When testing it sometimes helps to look a just one example directory like so:
// var stackblitzPaths = path.join(this.basePath, '**/testing/*stackblitz.json');
var stackblitzPaths = path.join(this.basePath, '**/*stackblitz.json');
@ -62,7 +64,7 @@ class StackblitzBuilder {
// description: string - description of this stackblitz - defaults to the title in the index.html page.
// tags: string[] - optional array of stackblitz tags (for searchability)
// main: string - name of file that will become index.html in the stackblitz - defaults to index.html
// file: string - name of file to display within the stackblitz as in "open": "app/app.module.ts"
// file: string - name of file to display within the stackblitz (e.g. `"file": "app/app.module.ts"`)
_buildStackblitzFrom(configFileName) {
// replace ending 'stackblitz.json' with 'stackblitz.no-link.html' to create output file name;
var outputFileName = `stackblitz.no-link.html`;
@ -74,7 +76,7 @@ class StackblitzBuilder {
}
try {
var config = this._initConfigAndCollectFileNames(configFileName);
var postData = this._createPostData(config);
var postData = this._createPostData(config, configFileName);
this._addDependencies(postData);
var html = this._createStackblitzHtml(config, postData);
fs.writeFileSync(outputFileName, html, 'utf-8');
@ -95,6 +97,24 @@ class StackblitzBuilder {
}
}
_checkForOutdatedConfig() {
// Ensure that nobody is trying to use the old config filenames (i.e. `plnkr.json`).
var plunkerPaths = path.join(this.basePath, '**/*plnkr.json');
var fileNames = globby.sync(plunkerPaths, { ignore: ['**/node_modules/**'] });
if (fileNames.length) {
const readmePath = path.join(__dirname, 'README.md');
const errorMessage =
'One or more examples are still trying to use \'plnkr.json\' files for configuring ' +
'live examples. This is not supported any more. \'stackblitz.json\' should be used ' +
'instead.\n' +
`(Slight modifications may be required. See '${readmePath}' for more info.\n\n` +
fileNames.map(name => `- ${name}`).join('\n');
throw Error(errorMessage);
}
}
_createBaseStackblitzHtml(config) {
var file = '';
@ -122,8 +142,14 @@ class StackblitzBuilder {
return html;
}
_createPostData(config) {
_createPostData(config, configFileName) {
var postData = {};
// If `config.main` is specified, ensure that it points to an existing file.
if (config.main && !this._existsSync(path.join(config.basePath, config.main))) {
throw Error(`The main file ('${config.main}') specified in '${configFileName}' does not exist.`);
}
config.fileNames.forEach((fileName) => {
var content;
var extn = path.extname(fileName);