@kui-shell/plugin-tutorials
Version:
IBM Cloud shell plugin for tutorials
71 lines • 3.15 kB
JavaScript
/*
* Copyright 2018 IBM Corporation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
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());
});
};
import Debug from 'debug';
import { join, basename, dirname, resolve } from 'path';
const debug = Debug('plugins/tutorials/utils');
/** enclosing directory for tutorials */
const top = resolve(join(__dirname, '../../'));
export const contentDir = join(top, 'samples/@tutorials');
/** enclosing directory for a given tutorial */
export const projectHome = projectName => join(contentDir, projectName);
// eslint-disable-next-line @typescript-eslint/no-explicit-any
const readJSON = (projectHome, fileName) => new Promise((resolve, reject) => {
debug('readJSON');
try {
if (projectHome.indexOf('@tutorials') >= 0) {
const projectName = basename(projectHome);
debug('reading built-in', projectName, fileName);
// WARNING: webpack requires that the path prefix be an explicit string :(
// DO NOT try to be clever here
resolve(require('@kui-shell/plugin-tutorials/samples/@tutorials/' + projectName + '/' + fileName));
}
else {
debug('reading external', projectHome, fileName);
resolve(join(projectHome, fileName));
}
}
catch (err) {
reject(err);
}
});
/**
* Read the module metadata
*
*/
export const readProject = (projectHome) => __awaiter(void 0, void 0, void 0, function* () {
debug('readProject', projectHome);
if (basename(projectHome) === 'package.json') {
// maybe the user specified the filepath of the package.json?
return readProject(dirname(projectHome));
}
return Promise.all([readJSON(projectHome, 'package.json'), readJSON(projectHome, 'tutorial.json')]).then(([config, tutorial]) => {
return {
config: Object.assign({}, { projectName: config.name }, config),
tutorial,
projectHome
};
});
});
//# sourceMappingURL=util.js.map