Merge pull request #171 from pie-framework/feature/mk-item-app-archiveable

Feature/mk item app archiveable

Author: edeustace

package-lock.json

@@ -74,6 +74,7 @@
   },
   "dependencies": {
     "@pie-cli-libs/installer": "^1.5.4",
+    "@pie-cli-libs/hash": "^1.5.1",
     "ajv": "^5.2.1",
     "archiver": "^2.0.0",
     "babel-core": "^6.24.0",

package.json

@@ -12,24 +12,25 @@ const logger = buildLogger();
 
 export function archiveIgnores(dir: string) {
   const gitIgnorePath = join(dir, '.gitignore');
-  const gitIgnores = existsSync(gitIgnorePath) ?
-    readFileSync(gitIgnorePath, 'utf8').split('\n').map(s => s.trim()) : [];
-
-  return _(gitIgnores).concat([
-    '.pie',
-    '\.*',
-    'package.json',
-    '*.tar.gz'
-  ]).uniq().value();
+  const gitIgnores = existsSync(gitIgnorePath)
+    ? readFileSync(gitIgnorePath, 'utf8')
+        .split('\n')
+        .map(s => s.trim())
+    : [];
+
+  return _(gitIgnores)
+    .concat(['.pie', '.*', 'package.json', '*.tar.gz'])
+    .uniq()
+    .value();
 }
 
 export function createArchive(
   name: string,
   cwd: string,
   ignore: string[],
-  addExtras: (a: any) => void): Promise<string> {
+  addExtras?: (a: any) => void
+): Promise<string> {
   return new Promise<string>((resolve, reject) => {
-
     const archiveName = name.endsWith('.tar.gz') ? name : `${name}.tar.gz`;
 
     const output = createWriteStream(archiveName);
@@ -40,15 +41,17 @@ export function createArchive(
       resolve(archiveName);
     });
 
-    archive.on('error', (err) => {
+    archive.on('error', err => {
       reject(err);
     });
 
     archive.pipe(output);
 
     archive.glob('**', { cwd, ignore });
 
-    addExtras(archive);
+    if (addExtras) {
+      addExtras(archive);
+    }
 
     archive.finalize();
   });

src/apps/create-archive.ts

@@ -2,7 +2,14 @@ import * as _ from 'lodash';
 import * as generators from './src-generators';
 import * as pug from 'pug';
 
-import { App, Buildable, DefaultOpts, MakeManifest, ManifestOpts } from '../types';
+import {
+  App,
+  Buildable,
+  DefaultOpts,
+  MakeManifest,
+  ManifestOpts,
+  Archivable
+} from '../types';
 import { ElementDeclaration, buildWebpack, writeConfig } from '../../code-gen';
 import Install, {
   Dirs,
@@ -16,20 +23,26 @@ import { join, resolve } from 'path';
 
 import { SupportConfig } from '../../framework-support';
 import { promise as report } from '../../cli/report';
-import { webpackConfig } from '../common';
+import { webpackConfig, Out } from '../common';
 import { writeFileSync } from 'fs-extra';
+import { archiveIgnores, createArchive } from '../create-archive';
+import { addExtras } from '../catalog';
+import { buildLogger } from 'log-factory';
 
+const logger = buildLogger();
 const basicExample = join(__dirname, 'views/example.pug');
 
 const ENCODING = { encoding: 'utf8' };
 
-const writeFile = (name: string, contents: string) => writeFileSync(name, contents, ENCODING);
+const writeFile = (name: string, contents: string) =>
+  writeFileSync(name, contents, ENCODING);
 
 export default class DefaultApp
-  implements Buildable<string[], DefaultOpts>,
-  App,
-  MakeManifest {
-
+  implements
+    Buildable<string[], DefaultOpts>,
+    App,
+    MakeManifest,
+    Archivable<Pkg[]> {
   public static generatedFiles: string[] = [
     'pie-item.js',
     'pie-view.js',
@@ -38,20 +51,29 @@ export default class DefaultApp
     'example.html'
   ];
 
-  public static build(args: any, loadSupport: (JsonConfig) => Promise<SupportConfig>): Promise<DefaultApp> {
+  public static build(
+    args: any,
+    loadSupport: (JsonConfig) => Promise<SupportConfig>
+  ): Promise<DefaultApp> {
     const dir = resolve(args.dir || args.d || process.cwd());
     const config = JsonConfig.build(dir, args);
-    return loadSupport(config).then(s => new DefaultApp(config, s));
+    const outNames = Out.build(args);
+    return loadSupport(config).then(s => new DefaultApp(config, s, outNames));
   }
 
   private static CONFIGURE_ENTRY = 'default.configure.entry.js';
   private static CONFIGURE_BUNDLE = 'pie-configure.js';
-  private static CONFIGURE_WEBPACK_CONFIG = 'default.configure.webpack.config.js';
+  private static CONFIGURE_WEBPACK_CONFIG =
+    'default.configure.webpack.config.js';
 
   private template: pug.compileTemplate;
   private installer: Install;
 
-  constructor(readonly config: JsonConfig, private support: SupportConfig) {
+  constructor(
+    readonly config: JsonConfig,
+    private support: SupportConfig,
+    private outNames: Out
+  ) {
     this.template = pug.compileFile(basicExample, { pretty: true });
     this.installer = new Install(config.dir, config.raw);
   }
@@ -64,13 +86,27 @@ export default class DefaultApp
     const forceInstall = opts ? opts.forceInstall : false;
 
     const { pkgs, dirs } = await this.installer.install(forceInstall);
-    const client = await report('building client', this.buildClient(dirs, pkgs, opts.addPlayerAndControlPanel));
-    const controllers = await report('building controllers', this.buildControllers(dirs, opts.pieName, pkgs));
-    const configure = await report('building configure', this.buildConfigure(dirs, pkgs));
-    const allInOne = opts.includeComplete ?
-      await report('building all-in-one', this.buildAllInOne(dirs, opts.pieName, pkgs)) : [];
-    const example = opts.includeComplete ?
-      await report('building example', this.buildExample()) : [];
+    const client = await report(
+      'building client',
+      this.buildClient(dirs, pkgs, opts.addPlayerAndControlPanel)
+    );
+    const controllers = await report(
+      'building controllers',
+      this.buildControllers(dirs, opts.pieName, pkgs)
+    );
+    const configure = await report(
+      'building configure',
+      this.buildConfigure(dirs, pkgs)
+    );
+    const allInOne = opts.includeComplete
+      ? await report(
+          'building all-in-one',
+          this.buildAllInOne(dirs, opts.pieName, pkgs)
+        )
+      : [];
+    const example = opts.includeComplete
+      ? await report('building example', this.buildExample())
+      : [];
 
     return _.concat(client, controllers, configure, allInOne, example);
   }
@@ -79,17 +115,44 @@ export default class DefaultApp
     return Promise.reject(new Error('todo'));
   }
 
-  private async buildConfigure(dirs: Dirs, pkgs: Pkg[]): Promise<string[]> {
+  public async createArchive(buildInfo: Pkg[]): Promise<string> {
+    const archivePath = resolve(join(this.config.dir, this.outNames.archive));
+
+    /* TODO: ignore config/markup? */
+    const ignores = archiveIgnores(this.config.dir);
 
-    const js = configureDeclarations(pkgs).map(e => e.js).join('\n');
+    logger.silly(
+      'call createArchive',
+      archivePath,
+      this.config.dir,
+      ignores,
+      addExtras
+    );
+
+    logger.silly('callAddExtras...');
+
+    return createArchive(archivePath, this.config.dir, ignores).catch(e => {
+      const msg = `Error creating the archive: ${e.message}`;
+      logger.error(msg);
+      logger.info(e.stack);
+      throw new Error(msg);
+    });
+  }
+
+  private async buildConfigure(dirs: Dirs, pkgs: Pkg[]): Promise<string[]> {
+    const js = configureDeclarations(pkgs)
+      .map(e => e.js)
+      .join('\n');
 
     writeFile(join(dirs.root, DefaultApp.CONFIGURE_ENTRY), js);
 
-    const config = webpackConfig(dirs,
+    const config = webpackConfig(
+      dirs,
       this.support,
       DefaultApp.CONFIGURE_ENTRY,
       DefaultApp.CONFIGURE_BUNDLE,
-      this.config.dir);
+      this.config.dir
+    );
 
     await buildWebpack(config, DefaultApp.CONFIGURE_WEBPACK_CONFIG);
     return [DefaultApp.CONFIGURE_BUNDLE];
@@ -98,23 +161,38 @@ export default class DefaultApp
   private async buildClient(
     dirs: Dirs,
     pkgs: Pkg[],
-    addPlayerAndControlPanel: boolean): Promise<string[]> {
-
-    const js = generators.client(toDeclarations(pkgs).concat(addPlayerAndControlPanel ? [
-      new ElementDeclaration('pie-player'),
-      new ElementDeclaration('pie-control-panel')
-    ] : []));
+    addPlayerAndControlPanel: boolean
+  ): Promise<string[]> {
+    const js = generators.client(
+      toDeclarations(pkgs).concat(
+        addPlayerAndControlPanel
+          ? [
+              new ElementDeclaration('pie-player'),
+              new ElementDeclaration('pie-control-panel')
+            ]
+          : []
+      )
+    );
 
     writeFile(join(dirs.root, 'client.entry.js'), js);
-    const config = webpackConfig(dirs, this.support, 'client.entry.js', 'pie-view.js', this.config.dir);
+    const config = webpackConfig(
+      dirs,
+      this.support,
+      'client.entry.js',
+      'pie-view.js',
+      this.config.dir
+    );
 
     writeConfig(join(dirs.root, 'client.webpack.config.js'), config);
     await buildWebpack(config);
     return ['pie-view.js'];
   }
 
-  private async buildControllers(dirs: Dirs, pieName: string, pkgs: Pkg[]): Promise<string[]> {
-
+  private async buildControllers(
+    dirs: Dirs,
+    pieName: string,
+    pkgs: Pkg[]
+  ): Promise<string[]> {
     const controllers = controllerTargets(pkgs);
 
     const js = generators.controllers(controllers);
@@ -124,7 +202,8 @@ export default class DefaultApp
       this.support,
       'controllers.entry.js',
       'pie-controllers.js',
-      this.config.dir);
+      this.config.dir
+    );
 
     config.output.library = `pie-controller-${pieName}`;
     config.output.libraryTarget = 'umd';
@@ -134,10 +213,15 @@ export default class DefaultApp
     return ['pie-controllers.js'];
   }
 
-  private async buildAllInOne(dirs: Dirs, pieName: string, pkgs: Pkg[]): Promise<string[]> {
-
+  private async buildAllInOne(
+    dirs: Dirs,
+    pieName: string,
+    pkgs: Pkg[]
+  ): Promise<string[]> {
     if (!pieName) {
-      throw new Error('You must specify a `pieName` in the args when using `--includeComplete`');
+      throw new Error(
+        'You must specify a `pieName` in the args when using `--includeComplete`'
+      );
     }
 
     const controllerMap = controllerTargets(pkgs);
@@ -160,7 +244,8 @@ export default class DefaultApp
       this.support,
       'all-in-one.entry.js',
       'pie-item.js',
-      this.config.dir);
+      this.config.dir
+    );
 
     writeConfig(join(dirs.root, 'all-in-one.webpack.config.js'), config);
     await buildWebpack(config);

src/apps/default/index.ts

@@ -1,10 +1,6 @@
-import {
-  types as apps,
-  clean,
-  loadApp,
-} from '../apps';
+import { types as apps, clean, loadApp } from '../apps';
 
-import { BuildOpts } from "../apps/types";
+import { BuildOpts } from '../apps/types';
 import CliCommand from './cli-command';
 import { buildLogger } from 'log-factory';
 import report from './report';
@@ -20,23 +16,34 @@ class PackCommand extends CliCommand {
     const a: apps.App = await loadApp(args);
 
     if (apps.isBuildable<T, BuildOpts>(a)) {
-
       const buildOpts = a.buildOpts(args);
 
       if (buildOpts.clean) {
         await report.promise('removing files', clean(a.config.dir));
       }
 
+      if (buildOpts.createArchive && !apps.isArchivable(a)) {
+        report.failure(
+          'tried to create an archive but this isnt supported with this app'
+        );
+        return;
+      }
+
       const result: T = await a.build(buildOpts);
       this.cliLogger.info('build complete, run manifest...');
 
       if (buildOpts.createArchive) {
         if (apps.isArchivable(a)) {
           this.cliLogger.info('creating archive...');
-          const zip = await report.promise('creating archive', a.createArchive(result));
+          const zip = await report.promise(
+            'creating archive',
+            a.createArchive(result)
+          );
           this.cliLogger.info('archive: ', zip);
         } else {
-          logger.warn('tried to create an archive but this app type isnt archivable');
+          report.failure(
+            'tried to create an archive but this app type isnt archivable'
+          );
         }
       }
 
@@ -50,7 +57,6 @@ class PackCommand extends CliCommand {
       return {
         msg: 'pack complete'
       };
-
     } else {
       logger.warn('this app isnt buildable');
     }