generator-jhipster
Version:
Spring Boot + Angular/React/Vue in one handy generator
210 lines (189 loc) • 8.82 kB
JavaScript
/**
* Copyright 2013-2021 the original author or authors from the JHipster project.
*
* This file is part of the JHipster project, see https://www.jhipster.tech/
* for more information.
*
* 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
*
* https://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.
*/
/* eslint-disable consistent-return */
const _ = require('lodash');
const { writeFiles, addToMenu, replaceTranslations } = require('./files');
const { entityClientI18nFiles } = require('../entity-i18n/files');
const utils = require('../utils');
const BaseBlueprintGenerator = require('../generator-base-blueprint');
const {
SUPPORTED_CLIENT_FRAMEWORKS: { ANGULAR, REACT },
} = require('../generator-constants');
const { GENERATOR_ENTITY_CLIENT } = require('../generator-list');
const { POSTGRESQL, MARIADB } = require('../../jdl/jhipster/database-types');
let useBlueprints;
module.exports = class extends BaseBlueprintGenerator {
constructor(args, options, features) {
super(args, options, features);
this.entity = this.options.context;
this.jhipsterContext = this.options.jhipsterContext || this.options.context;
useBlueprints = !this.fromBlueprint && this.instantiateBlueprints(GENERATOR_ENTITY_CLIENT, { context: this.options.context });
}
// Public API method used by the getter and also by Blueprints
_preparing() {
return {
async loadNativeLanguage() {
await this._loadEntityClientTranslations(this.entity, this.jhipsterConfig);
},
};
}
get preparing() {
if (useBlueprints) return;
return this._preparing();
}
// Public API method used by the getter and also by Blueprints
_default() {
return {
...super._missingPreDefault(),
loadConfigIntoGenerator() {
utils.copyObjectProps(this, this.entity);
},
setup() {
if (!this.embedded) {
this.tsKeyType = this.getTypescriptKeyType(this.primaryKey.type);
}
},
setupCypress() {
// Blueprints may disable cypress relationships by setting to false.
this.cypressBootstrapEntities = true;
const entity = this.entity;
// Reactive with PostgreSQL doesn't allow insertion without data.
this.workaroundRelationshipReactivePostgress = entity.reactive && entity.prodDatabaseType === POSTGRESQL;
// Reactive with MariaDB doesn't allow null value at Instant fields.
this.workaroundInstantReactiveMariaDB = entity.reactive && entity.prodDatabaseType === MARIADB;
},
};
}
get default() {
if (useBlueprints) return;
return this._default();
}
// Public API method used by the getter and also by Blueprints
_writing() {
return {
cleanup() {
if (this.isJhipsterVersionLessThan('7.0.0-beta.0') && this.jhipsterConfig.clientFramework === ANGULAR) {
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}.route.ts`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}.component.ts`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}.component.html`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-detail.component.ts`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-detail.component.html`);
this.removeFile(
`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-delete-dialog.component.ts`
);
this.removeFile(
`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-delete-dialog.component.html`
);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-update.component.ts`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-update.component.html`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/shared/model/${this.entityModelFileName}.model.ts`);
this.fields.forEach(field => {
if (field.fieldIsEnum === true) {
const enumFileName = _.kebabCase(field.fieldType);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/shared/model/enumerations/${enumFileName}.model.ts`);
}
});
this.removeFile(
`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-routing-resolve.service.ts`
);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}-routing.module.ts`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}.service.ts`);
this.removeFile(`${this.CLIENT_MAIN_SRC_DIR}/app/entities/${this.entityFolderName}/${this.entityFileName}.service.spec.ts`);
this.removeFile(
`${this.CLIENT_TEST_SRC_DIR}/spec/app/entities/${this.entityFolderName}/${this.entityFileName}.component.spec.ts`
);
this.removeFile(
`${this.CLIENT_TEST_SRC_DIR}/spec/app/entities/${this.entityFolderName}/${this.entityFileName}-detail.component.spec.ts`
);
this.removeFile(
`${this.CLIENT_TEST_SRC_DIR}/spec/app/entities/${this.entityFolderName}/${this.entityFileName}-delete-dialog.component.spec.ts`
);
this.removeFile(
`${this.CLIENT_TEST_SRC_DIR}/spec/app/entities/${this.entityFolderName}/${this.entityFileName}-update.component.spec.ts`
);
this.removeFile(`${this.CLIENT_TEST_SRC_DIR}/spec/app/entities/${this.entityFolderName}/${this.entityFileName}.service.spec.ts`);
}
if (this.isJhipsterVersionLessThan('7.0.0-beta.1') && this.jhipsterConfig.clientFramework === REACT) {
this.removeFile(`${this.CLIENT_TEST_SRC_DIR}spec/app/entities/${this.entityFolderName}/${this.entityFileName}-reducer.spec.ts`);
}
},
...writeFiles(),
...super._missingPostWriting(),
};
}
get writing() {
if (useBlueprints) return;
return this._writing();
}
// Public API method used by the getter and also by Blueprints
_postWriting() {
return {
addToMenu() {
return addToMenu.call(this);
},
replaceTranslations() {
if (
this.skipClient ||
(this.jhipsterConfig.microfrontend && this.jhipsterConfig.applicationType === 'gateway' && this.microserviceName)
)
return undefined;
return replaceTranslations.call(this);
},
};
}
get postWriting() {
if (useBlueprints) return;
return this._postWriting();
}
/**
* @experimental
* Load entity client native translation.
*/
async _loadEntityClientTranslations(entity, configContext = this) {
const { frontendAppName = this.getFrontendAppName(), nativeLanguage = 'en' } = configContext;
entity.entityClientTranslations = entity.entityClientTranslations || {};
const { entityClientTranslations } = entity;
const rootTemplatesPath = this.fetchFromInstalledJHipster('entity-i18n/templates/');
const translationFiles = await this.writeFiles({
sections: entityClientI18nFiles,
rootTemplatesPath,
context: { ...entity, clientSrcDir: '__tmp__', frontendAppName, lang: 'en' },
});
if (nativeLanguage && nativeLanguage !== 'en') {
translationFiles.push(
...(await this.writeFiles({
sections: entityClientI18nFiles,
rootTemplatesPath,
context: { ...entity, clientSrcDir: '__tmp__', frontendAppName, lang: nativeLanguage },
}))
);
}
for (const translationFile of translationFiles) {
_.merge(entityClientTranslations, this.readDestinationJSON(translationFile));
delete this.env.sharedFs.get(translationFile).state;
}
}
/**
* @experimental
* Get translation value for a key.
*/
_getEntityClientTranslation(translationKey) {
return _.get(this.entityClientTranslations, translationKey, `Translation missing for ${translationKey}`);
}
};