@o3r/components
Version:
This module contains component-related features (Component replacement, CMS compatibility, helpers, pipes, debugging developer tools...) It comes with an integrated ng builder to help you generate components compatible with Otter features (CMS integration
159 lines • 8.41 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.defaultLibraryName = void 0;
const tslib_1 = require("tslib");
const fs = tslib_1.__importStar(require("node:fs"));
const path = tslib_1.__importStar(require("node:path"));
const architect_1 = require("@angular-devkit/architect");
const extractors_1 = require("@o3r/extractors");
const schematics_1 = require("@o3r/schematics");
const chokidar = tslib_1.__importStar(require("chokidar"));
const index_1 = require("./helpers/component/index");
/**
* Get the library name from package.json
* @param currentDir
*/
const defaultLibraryName = (currentDir = process.cwd()) => {
const packageJsonPath = path.resolve(currentDir, 'package.json');
return JSON.parse(fs.readFileSync(packageJsonPath).toString()).name;
};
exports.defaultLibraryName = defaultLibraryName;
/** Maximum number of steps */
const STEP_NUMBER = 5;
/**
* Ensure that all tuple (library,name) are unique
* @param configurations
* @param logger
* @param strictMode
*/
function checkUniquenessLibraryAndName(configurations, logger, strictMode = false) {
const setOfLibraryAndName = new Set();
let errors = '';
configurations.forEach((configuration) => {
if (setOfLibraryAndName.has(configuration.library + configuration.name)) {
errors += `Duplicate tuple found in the metadata file for library and name : (${configuration.library}, ${configuration.name})\n`;
}
else {
setOfLibraryAndName.add(configuration.library + configuration.name);
}
});
if (errors.length > 0) {
if (strictMode) {
throw new schematics_1.O3rCliError(`Duplicate (library, name) tuples are not allowed :\n ${errors}`);
}
logger.warn(`Duplicate (library, name) tuples found. Please fix it as it would throw an error in strict mode :\n ${errors}`);
}
}
exports.default = (0, architect_1.createBuilder)((0, extractors_1.createBuilderWithMetricsIfInstalled)(async (options, context) => {
context.reportRunning();
const execute = async () => {
context.reportProgress(0, STEP_NUMBER, 'Checking required options');
const tsConfig = path.resolve(context.workspaceRoot, options.tsConfig);
const tsconfigExists = fs.existsSync(tsConfig);
if (!tsconfigExists) {
context.logger.error(`${tsConfig} not found`);
return {
error: `${tsConfig} not found`,
success: false
};
}
context.reportProgress(1, STEP_NUMBER, 'Generating component parser');
const libraryName = options.name || (0, exports.defaultLibraryName)(context.currentDirectory);
const parser = new index_1.ComponentParser(libraryName, tsConfig, context.logger, options.strictMode, options.libraries, options.globalConfigCategories);
context.reportProgress(2, STEP_NUMBER, 'Gathering project data');
const parserOutput = await parser.parse();
if (parserOutput) {
const componentExtractor = new index_1.ComponentExtractor(libraryName, options.libraries, context.logger, context.workspaceRoot, options.strictMode);
try {
context.reportProgress(3, STEP_NUMBER, 'Extracting component metadata');
const componentMetadata = await componentExtractor.extract(parserOutput, options);
// Validate configuration part of components metadata
const configurationMetadataSchemaPath = require.resolve('@o3r/configuration/schemas/configuration.metadata.schema.json');
(0, extractors_1.validateJson)(componentMetadata.configurations, JSON.parse(fs.readFileSync(configurationMetadataSchemaPath, { encoding: 'utf8' })), 'The output of configuration metadata is not valid regarding the json schema, please check the details below : \n', options.strictMode);
// Validate components part of components metadata
(0, extractors_1.validateJson)(componentMetadata.components, JSON.parse(fs.readFileSync(path.resolve(__dirname, '../../schemas/component.metadata.schema.json'), { encoding: 'utf8' })), 'The output of components metadata is not valid regarding the json schema, please check the details below : \n', options.strictMode);
// Ensure that each tuple (library,name) is unique
checkUniquenessLibraryAndName(componentMetadata.configurations, context.logger);
context.reportProgress(4, STEP_NUMBER, `Writing components in ${options.configOutputFile}`);
try {
await fs.promises.mkdir(path.dirname(path.resolve(context.workspaceRoot, options.componentOutputFile)), { recursive: true });
}
catch { }
await fs.promises.writeFile(path.resolve(context.workspaceRoot, options.componentOutputFile), options.inline ? JSON.stringify(componentMetadata.components) : JSON.stringify(componentMetadata.components, null, 2));
context.reportProgress(5, STEP_NUMBER, `Writing configurations in ${options.configOutputFile}`);
await fs.promises.writeFile(path.resolve(context.workspaceRoot, options.configOutputFile), options.inline ? JSON.stringify(componentMetadata.configurations) : JSON.stringify(componentMetadata.configurations, null, 2));
}
catch (e) {
return {
success: false,
error: e.message || e.toString()
};
}
context.logger.info(`Component metadata extracted in ${options.componentOutputFile} and ${options.configOutputFile} ${options.libraries.length > 0 ? ` (imported from ${options.libraries.join(', ')})` : ''}.`);
}
else {
return {
success: false,
error: 'Parsing failed'
};
}
return {
success: true
};
};
/**
* Run a component metadata generation and report the result
*/
const generateWithReport = async () => {
const result = await execute();
if (result.success) {
context.logger.info('Component metadata updated');
}
else if (result.error) {
context.logger.error(result.error);
}
context.reportStatus('Waiting for changes...');
return result;
};
/**
* Watch file change in current code and libraries metadata
* @param libraries Libraries to watch
*/
const watchFiles = (libraries) => {
const simpleGlobConfigurationFiles = path.resolve(context.currentDirectory, options.filePattern).replace(/[/\\]/g, '/');
// Get metadata file for each library
const metadataFiles = libraries.map((library) => (0, extractors_1.getLibraryCmsMetadata)(library, context.currentDirectory));
const componentMetadataFiles = metadataFiles
.filter(({ componentFilePath }) => !!componentFilePath)
.map(({ componentFilePath }) => componentFilePath.replace(/[/\\]/g, '/'));
const configurationMetadataFiles = metadataFiles
.filter(({ configurationFilePath }) => !!configurationFilePath)
.map(({ configurationFilePath }) => configurationFilePath.replace(/[/\\]/g, '/'));
return chokidar.watch([...componentMetadataFiles, ...configurationMetadataFiles, simpleGlobConfigurationFiles]);
};
if (options.watch) {
const watcher = watchFiles(options.libraries);
let currentProcess;
watcher
.on('all', async (eventName, filePath) => {
if (currentProcess) {
context.logger.debug(`Ignored action ${eventName} on ${filePath}`);
}
else {
context.logger.debug(`Refreshed for action ${eventName} on ${filePath}`);
currentProcess = generateWithReport();
await currentProcess;
currentProcess = undefined;
}
});
context.addTeardown(() => watcher.close());
// Exit on watcher failure
return new Promise((_resolve, reject) => watcher
// TODO remove cast after https://github.com/paulmillr/chokidar/issues/1392
.on('error', (err) => reject(err)));
}
else {
return execute();
}
}));
//# sourceMappingURL=index.js.map