@viewdo/dxp-story-cli
Version:
README.md
232 lines • 13.1 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var copy_dir_1 = __importDefault(require("copy-dir"));
var execa_1 = __importDefault(require("execa"));
var node_watch_1 = __importDefault(require("node-watch"));
var listr_1 = __importDefault(require("listr"));
var path_1 = __importDefault(require("path"));
var fs_1 = __importDefault(require("fs"));
var TemplateManager = /** @class */ (function () {
function TemplateManager(_a, _b, configuration_manager) {
var _c = _a.root, root = _c === void 0 ? process.cwd() : _c, _d = _a.force, force = _d === void 0 ? false : _d;
var file_service = _b.file_service, task_service = _b.task_service;
this.root = root;
this.force = force;
this.configuration_manager = configuration_manager;
this.file_service = file_service;
this.task_service = task_service;
}
// SCAFFOLD API ----------------------------------------------
TemplateManager.prototype.scaffoldStory = function (story_key, organization_key) {
var fake_story = this._getFakeStory(story_key, organization_key);
var story_config = this.configuration_manager.setStoryConfig(fake_story);
this.configuration_manager.setStoryAssetConfig(story_config);
};
TemplateManager.prototype.watch = function (directory, file_collection, func) {
return node_watch_1.default(directory, {
recursive: true,
filter: function (file) { return file_collection.includes(file); }
}, function (event, filename) { return func(filename); });
};
// TODO: Convert to JSON and store in /.scaffold
TemplateManager.prototype._getFakeStory = function (story_key, organization_key) {
return {
name: story_key.toUpperCase(),
key: story_key,
organizationKey: organization_key,
milestones: [
"milestone-1"
],
events: [
"event-1"
],
externalEvents: [
{
"key": "xxx",
"name": "External Event",
"slug": "external-event",
"url": "https://dxp-xapi.develop.viewdo.run/v1/story/tech-sample/record-external-event/externy?xid="
}
],
emailTemplates: [{ key: 'example-email' }],
htmlTemplates: [{ key: 'example-html' }],
textTemplates: [
{ key: 'example-javascript', type: 'js' },
{ key: 'example-object', type: 'json' },
{ key: 'example-data', type: 'csv' },
{ key: 'example-text', type: 'text' },
{ key: 'example-page', type: 'html' },
{ key: 'example-less', type: 'less' },
{ key: 'example-styles', type: 'css' }
],
episodes: [
{
key: 'example-episode',
isEnabled: true,
jsonAttachmentKey: true,
cssAttachmentKey: true,
jsAttachmentKey: true
}
],
actions: [],
customLinks: [],
customKPIs: [],
inputMaps: []
};
};
TemplateManager.prototype.initRootFolder = function () {
var _this = this;
var subTasks = [{
title: 'Copy DXP Files',
task: function () {
var asset_folder = path_1.default.resolve(__dirname, '../../../assets/.dxp');
copy_dir_1.default.sync(asset_folder, _this.root + "/.dxp", { cover: true });
}
}, {
title: 'Copy Root Files',
skip: function () { return !_this.force; },
task: function () {
var asset_folder = path_1.default.resolve(__dirname, '../../../assets/root');
copy_dir_1.default.sync(asset_folder, _this.root, { cover: _this.force });
}
}, {
title: 'Merge .vscode extensions',
task: function () {
var extensions_path = path_1.default.resolve(__dirname, '../../../assets/.vscode/extensions.json');
var extensions = JSON.parse(fs_1.default.readFileSync(extensions_path).toString());
var existing_extensions_path = './.vscode/extensions.json';
if (_this.file_service.exists(existing_extensions_path)) {
var existing_extensions = JSON.parse(_this.file_service.read(existing_extensions_path));
extensions = Object.assign(existing_extensions, extensions);
}
_this.file_service.write(existing_extensions_path, JSON.stringify(extensions, null, 2));
}
}, {
title: 'Merge .vscode settings',
task: function () {
var settings_path = path_1.default.resolve(__dirname, '../../../assets/.vscode/settings.json');
var settings = JSON.parse(fs_1.default.readFileSync(settings_path).toString());
var existing_settings_path = './.vscode/settings.json';
if (_this.file_service.exists(existing_settings_path)) {
var existing_settings = JSON.parse(_this.file_service.read(existing_settings_path));
settings = Object.assign(existing_settings, settings);
}
_this.file_service.write(existing_settings_path, JSON.stringify(settings, null, 2));
}
}, {
/*
Make sure we have a package.json
maybe walk through that process of init
*/
title: 'Initialize NPM',
skip: function () {
var packagePath = "./package.json";
return _this.file_service.exists(packagePath);
},
task: function (ctx, task) {
// walk through the NPM init process
return execa_1.default('npm', ['init', '-y', '--scope', 'viewdo']);
}
}, {
/*
Go through all devDependencies and add them, one by one.
*/
title: 'Install Dependencies',
task: function (ctx, task) { return __awaiter(_this, void 0, void 0, function () {
var existingPackage, samplePackage, packages;
return __generator(this, function (_a) {
existingPackage = require(this.root + "/package.json");
if (!existingPackage.devDependencies)
existingPackage.devDependencies = {};
samplePackage = require(path_1.default.resolve(__dirname, '../../../assets/package.json'));
packages = Object.keys(samplePackage.devDependencies);
// go through all 'devDependencies' and install locally
return [2 /*return*/, new listr_1.default(this.task_service.createSubTasksFromCollection(packages, function (p) { return "Install " + p; }, function (p) { return existingPackage.devDependencies[p]; }, function (ctx, task, item) { return execa_1.default('npm', ['install', item, '--save-dev', '-f']); }))];
});
}); }
}];
return this.task_service.runTasks(subTasks);
};
TemplateManager.prototype.initStoryFolders = function (story_keys) {
var _this = this;
return this.task_service.runTasks(story_keys.map(function (story_key) { return _this._initStoryFolder(story_key); }))
.then(function (ctx) { return ctx.success == false ? 1 : 0; });
};
TemplateManager.prototype._initStoryFolder = function (story_key) {
var _this = this;
var story_config = this.configuration_manager.getStoryConfig(story_key);
return this.task_service.createTaskSet("Set up Build & Preview for " + story_key, function (ctx, task) {
return Promise.resolve([{
title: 'Copying build files',
task: function () {
// create build files over
var story_folder = "./stories/" + story_key;
if (_this.file_service.exists(story_folder + "/index.js"))
_this.file_service.rename(story_folder + "/index.js", story_folder + "/default.js");
else if (_this.file_service.exists(story_folder + "/story.js"))
_this.file_service.rename(story_folder + "/story.js", story_folder + "/default.js");
else
_this.file_service.ensure(story_folder + "/default.js");
if (_this.file_service.exists(story_folder + "/index.less"))
_this.file_service.rename(story_folder + "/index.less", story_folder + "/default.less");
else if (_this.file_service.exists(story_folder + "/story.less"))
_this.file_service.rename(story_folder + "/story.less", story_folder + "/default.less");
else
_this.file_service.ensure(story_folder + "/default.less");
story_config.episodes.forEach(function (e) {
if (e.cssAttachmentKey)
_this.file_service.ensure(story_folder + "/episode-" + e.key + ".less");
if (e.jsAttachmentKey)
_this.file_service.ensure(story_folder + "/episode-" + e.key + ".js");
});
// TODO: rename any old webpack configs before copying
var asset_folder = path_1.default.resolve(__dirname, '../../../assets/story');
var story_folder_path = path_1.default.resolve(process.cwd(), story_folder);
copy_dir_1.default.sync(asset_folder, story_folder_path, { cover: _this.force });
}
}]);
});
};
return TemplateManager;
}());
exports.default = TemplateManager;
//# sourceMappingURL=TemplateManager.js.map