You can also download this example.
'; } return { @@ -72,24 +73,29 @@ angularIO.directive('liveExample', ['$location', function ($location) { if (attrs['title'] == undefined) { tElement[0].setAttribute('title', text); } // set default title (tooltip) var ex = attrs.name || NgIoUtil.getExampleName($location); var embedded = attrs.hasOwnProperty('embedded'); + var noDownload = attrs.hasOwnProperty('nodownload') || attrs.hasOwnProperty('noDownload'); var flatStyle = attrs.hasOwnProperty('flatstyle') || attrs.hasOwnProperty('flatStyle'); var embeddedStyle = embedded || attrs.hasOwnProperty('embeddedstyle') || attrs.hasOwnProperty('embeddedStyle'); var plnkr = (embeddedStyle || !flatStyle) ? 'eplnkr' : 'plnkr'; + var zipHref = ex; var imageBase = '/resources/images/'; var defaultImg = 'plunker/placeholder.png'; if (attrs.plnkr) { plnkr = attrs.plnkr + '.' + plnkr; + zipHref = attrs.plnkr + '.' + zipHref; } var isForDart = attrs.lang === 'dart' || NgIoUtil.isDoc($location, 'dart'); var isForJs = attrs.lang === 'js' || NgIoUtil.isDoc($location, 'js'); var exLang = isForDart ? 'dart' : isForJs ? 'js' : 'ts'; + zipHref = '/resources/zips/' + ex + '/' + zipHref + '.zip'; + if (embedded && !isForDart) { href = '/resources/live-examples/' + ex + '/' + exLang + '/' + plnkr + '.html'; img = imageBase + (attrs.img || defaultImg); - template = embeddedTemplate(href, img); + template = embeddedTemplate(href, img, zipHref); } else { var href = isForDart ? 'http://angular-examples.github.io/' + ex @@ -98,6 +104,10 @@ angularIO.directive('liveExample', ['$location', function ($location) { // Link to live example. var template = a(text, { href: href, target: '_blank' }); + if (!noDownload) { + template += ' / ' + a('downloadable example', { href: zipHref, target: '_blank' }); + } + // The hosted example and sources are in different locations for Dart. // Also show link to sources for Dart, unless noSource is specified. if (isForDart && !attrs.hasOwnProperty('nosource')) { diff --git a/tools/_example-zipper/Ideas.md b/tools/_example-zipper/Ideas.md deleted file mode 100644 index ee41ef8094..0000000000 --- a/tools/_example-zipper/Ideas.md +++ /dev/null @@ -1,15 +0,0 @@ -Summary: - - 1) if we discover a 'zipconfig.json' file or an 'xxx.zipconfig.json' file with the following structure - - { - "zipRegion": "zip", - "files": [ "foo.js", "**/**/.css", "!xxx.css"] - } - - where "zipRegion" is optional. - - Then we zip up all of the files specified, cleaning and removing extra doc tags. If the specified 'zipRegion' - is discovered in any file then we only zip that region. Otherwise we zip the entire file. - - \ No newline at end of file diff --git a/tools/_example-zipper/exampleZipper.js b/tools/_example-zipper/exampleZipper.js deleted file mode 100644 index 303933e4e0..0000000000 --- a/tools/_example-zipper/exampleZipper.js +++ /dev/null @@ -1,100 +0,0 @@ -// Canonical path provides a consistent path (i.e. always forward slashes) across different OSes -var path = require('canonical-path'); -var jsonfile = require('jsonfile'); -var assert = require('assert-plus'); -// adm-zip does not work properly on Windows -// var Zip = require('adm-zip'); -var archiver = require('archiver'); - -var fs = require('fs'); -var mkdirp = require('mkdirp'); -var globby = require('globby'); - -var regionExtractor = require('../doc-shredder/regionExtractor'); - - -// globs is an array of globs -function zipExamples(sourceDirName, outputDirName) { - var gpath = path.join(sourceDirName, '**/*zipconfig.json'); - var configFileNames = globby.sync([gpath], { ignore: ['**/node_modules/**'] }); - configFileNames.forEach(function(configFileName) { - zipExample(configFileName, sourceDirName, outputDirName); - }); -} - -function zipExample(configFileName, sourceDirName, outputDirName) { - var json = jsonfile.readFileSync(configFileName); - var fileGlobs = json.files; - var zipRegionName = json.zipRegion; - - // assert that fileGlobs is an array - assert.arrayOfString(fileGlobs, 'files property should be an array of strings'); - - // backup two from the relative configFileName - var relativeDirName = path.dirname(path.dirname(path.relative(sourceDirName, configFileName))); - var configDirName = path.dirname(configFileName); - // use the dir name of the folder containing the config file as the base file name of the zip file - var baseFileName = path.basename(configDirName); - // check if there is a prefix name before zipconfig.json - if (configFileName.indexOf('.zipconfig.json') >= 0) { - // if so use it as a suffix to the baseFileName - var extraName = path.basename(configFileName, '.zipconfig.json'); - baseFileName = baseFileName + "." + extraName; - } - - var outputFileName = path.join(outputDirName, relativeDirName, baseFileName + ".zip"); - // old code - // var fileNames = globule.find(fileGlobs, { srcBase: configDirName, prefixBase: configDirName }); - fileGlobs = fileGlobs.map(function(fileGlob) { - return path.join(configDirName, fileGlob); - }); - var fileNames = globby.sync(fileGlobs, { ignore: ["**/node_modules/**"] }); - - var zip = createZipArchive(outputFileName); - fileNames.forEach(function(fileName) { - var relativePath = path.relative(configDirName, fileName); - var content = fs.readFileSync(fileName, 'utf8'); - var extn = path.extname(fileName).substr(1); - // if we don't need to clean up the file then we can do the following. - // zip.append(fs.createReadStream(fileName), { name: relativePath }); - var output; - // if no zipRegion or zipRegion is not in content then just clean the content - if (zipRegionName != null) { - output = regionExtractor.getRegionDoc(content, extn, zipRegionName); - } - if (!output) { - output = regionExtractor.removeDocTags(content, extn); - } - - zip.append(output, { name: relativePath } ) - }); - - zip.finalize(); -} - -function createZipArchive(zipFileName) { - var dirName = path.dirname(zipFileName); - // insure that the folder exists. - if (!fs.existsSync(dirName)) { - mkdirp.sync(dirName); - } - var output = fs.createWriteStream(zipFileName); - var archive = archiver('zip'); - - output.on('close', function () { - console.log('zip created: ' + zipFileName + ' (' + archive.pointer() + ' total bytes)'); - }); - - archive.on('error', function (err) { - throw err; - }); - - archive.pipe(output); - return archive; -} - - -module.exports = { - zipExamples: zipExamples, - zipExample: zipExample -}; \ No newline at end of file diff --git a/tools/example-zipper/exampleZipper.js b/tools/example-zipper/exampleZipper.js new file mode 100644 index 0000000000..a92e45983a --- /dev/null +++ b/tools/example-zipper/exampleZipper.js @@ -0,0 +1,146 @@ +// Canonical path provides a consistent path (i.e. always forward slashes) across different OSes +var path = require('canonical-path'); +var jsonfile = require('jsonfile'); +var assert = require('assert-plus'); +// adm-zip does not work properly on Windows +// var Zip = require('adm-zip'); +var archiver = require('archiver'); + +var fs = require('fs'); +var mkdirp = require('mkdirp'); +var globby = require('globby'); + +var regionExtractor = require('../doc-shredder/regionExtractor'); + +class ExampleZipper { + constructor(sourceDirName, outputDirName) { + let gpathPlnkr = path.join(sourceDirName, '**/*plnkr.json'); + let gpathZipper = path.join(sourceDirName, '**/zipper.json'); + let configFileNames = globby.sync([gpathPlnkr, gpathZipper], { ignore: ['**/node_modules/**'] }); + // we only need typescript examples + configFileNames = configFileNames.filter((configFileName) => { + return configFileName.indexOf('ts') != -1; + }); + configFileNames.forEach((configFileName) => { + this._zipExample(configFileName, sourceDirName, outputDirName); + }); + } + + _changeTypeRoots(tsconfig) { + return tsconfig.replace('../../../', '../'); + } + + _createZipArchive(zipFileName) { + let dirName = path.dirname(zipFileName); + // ensure that the folder exists. + if (!fs.existsSync(dirName)) { + mkdirp.sync(dirName); + } + let output = fs.createWriteStream(zipFileName); + let archive = archiver('zip'); + + output.on('close', function () { + console.log('zip created: ' + zipFileName + ' (' + archive.pointer() + ' total bytes)'); + }); + + archive.on('error', function (err) { + throw err; + }); + + archive.pipe(output); + return archive; + } + + _zipExample(configFileName, sourceDirName, outputDirName) { + let json = JSON.parse(fs.readFileSync(configFileName, 'utf-8')); + const basePath = json.basePath || ''; + const jsonFileName = configFileName.replace(/^.*[\\\/]/, ''); + const relativeDirName = path.dirname(path.dirname(path.relative(sourceDirName, configFileName))); + const exampleDirName = path.dirname(configFileName); + const examplesPackageJson = 'public/docs/_examples/package.json'; + const examplesSystemjsConfig = 'public/docs/_examples/_boilerplate/src/systemjs.config.js'; + const exampleTsconfig = 'public/docs/_examples/_boilerplate/src/tsconfig.json'; + let exampleZipName = jsonFileName.replace(/(plnkr|zipper).json/, relativeDirName); + const outputFileName = path.join(outputDirName, relativeDirName, exampleZipName + '.zip'); + let defaultIncludes = ['**/*.ts', '**/*.js', '**/*.css', '**/*.html', '**/*.md', '**/*.json', '**/*.png']; + let alwaysIncludes = ['bs-config.json', 'tslint.json', 'karma-test-shim.js', 'karma.conf.js', 'src/testing/**/*']; + var defaultExcludes = [ + '!**/bs-config.e2e.json', + '!**/*plnkr.*', + '!**/*zipper.*', + '!**/systemjs.config.js', + '!**/npm-debug.log', + '!**/package.json', + '!**/example-config.json', + '!**/wallaby.js', + '!**/tsconfig.json', + '!**/package.webpack.json', + // AoT related files + '!**/aot/**/*.*', + '!**/*-aot.*' + ]; + + if (json.files) { + if (json.files.length > 0) { + json.files = json.files.map(file => { + if (file.startsWith('!')) { + if (file.startsWith('!**')) { + return file; + } + + return '!' + basePath + file.substr(1); + } + + return basePath + file; + }); + + if (json.files[0].substr(0, 1) === '!') { + json.files = defaultIncludes.concat(json.files); + } + } + } else { + json.files = defaultIncludes; + } + + json.files = json.files.concat(alwaysIncludes); + + let gpaths = json.files.map((fileName) => { + fileName = fileName.trim(); + if (fileName.substr(0, 1) === '!') { + return '!' + path.join(exampleDirName, fileName.substr(1)); + } else { + return path.join(exampleDirName, fileName); + } + }); + + Array.prototype.push.apply(gpaths, defaultExcludes); + + let fileNames = globby.sync(gpaths, { ignore: ['**/node_modules/**']}); + + let zip = this._createZipArchive(outputFileName); + fileNames.forEach((fileName) => { + let relativePath = path.relative(exampleDirName, fileName); + let content = fs.readFileSync(fileName, 'utf8'); + let extn = path.extname(fileName).substr(1); + // if we don't need to clean up the file then we can do the following. + // zip.append(fs.createReadStream(fileName), { name: relativePath }); + let output = regionExtractor.removeDocTags(content, extn); + + zip.append(output, { name: relativePath } ) + }); + + // we need the package.json from _examples root, not the _boilerplate one + zip.append(fs.readFileSync(examplesPackageJson, 'utf8'), { name: 'package.json' }); + // also a systemjs config + if (!json.removeSystemJsConfig) { + zip.append(fs.readFileSync(examplesSystemjsConfig, 'utf8'), { name: 'src/systemjs.config.js' }); + } + // a modified tsconfig + let tsconfig = fs.readFileSync(exampleTsconfig, 'utf8'); + zip.append(this._changeTypeRoots(tsconfig), {name: 'src/tsconfig.json'}); + + zip.finalize(); + } +} + +module.exports = ExampleZipper; diff --git a/tools/_example-zipper/test/gulpfile.js b/tools/example-zipper/test/gulpfile.js similarity index 100% rename from tools/_example-zipper/test/gulpfile.js rename to tools/example-zipper/test/gulpfile.js