f.spilla/typeorm-model-generator
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #241 from pc3b3r/feature/EOL-option

Browse Source 
Feature/eol option
This commit is contained in:
Kononnable 2020-02-09 22:39:05 +01:00 committed by GitHub
commit 8a09320345
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 90 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/IGenerationOptions.ts
View File

@ -1,3 +1,5 @@
import { EOL } from "os";
import path = require("path");
// TODO: change name
@ -10,6 +12,7 @@ export default interface IGenerationOptions {
convertCaseFile: "pascal" | "param" | "camel" | "none";
convertCaseEntity: "pascal" | "camel" | "none";
convertCaseProperty: "pascal" | "camel" | "none";
convertEol: "LF" | "CRLF";
propertyVisibility: "public" | "protected" | "private" | "none";
lazy: boolean;
activeRecord: boolean;
@ -21,6 +24,12 @@ export default interface IGenerationOptions {
indexFile: boolean;
exportType: "named" | "default";
}
export const eolConverter = {
LF: "\n",
CRLF: "\r\n"
};
export function getDefaultGenerationOptions(): IGenerationOptions {
const generationOptions: IGenerationOptions = {
resultsPath: path.resolve(process.cwd(), "output"),
@ -29,6 +38,7 @@ export function getDefaultGenerationOptions(): IGenerationOptions {
convertCaseFile: "pascal",
convertCaseEntity: "pascal",
convertCaseProperty: "camel",
convertEol: EOL === "\n" ? "LF" : "CRLF",
propertyVisibility: "none",
lazy: false,
activeRecord: false,

12
src/ModelGeneration.ts
View File

@ -3,8 +3,9 @@ import * as Prettier from "prettier";
import * as changeCase from "change-case";
import * as fs from "fs";
import * as path from "path";
import { EOL } from "os";
import IConnectionOptions from "./IConnectionOptions";
import IGenerationOptions from "./IGenerationOptions";
import IGenerationOptions, { eolConverter } from "./IGenerationOptions";
import { Entity } from "./models/Entity";
import { Relation } from "./models/Relation";
@ -71,7 +72,14 @@ function generateModels(
`${casedFileName}.ts`
);
const rendered = entityCompliedTemplate(element);
const withImportStatements = removeUnusedImports(rendered);
const withImportStatements = removeUnusedImports(
EOL !== eolConverter[generationOptions.convertEol]
? rendered.replace(
/(\r\n|\n|\r)/gm,
eolConverter[generationOptions.convertEol]
)
: rendered
);
const formatted = Prettier.format(withImportStatements, {
parser: "typescript"
});

24
src/index.ts
View File

@ -11,7 +11,6 @@ import IGenerationOptions, {
import fs = require("fs-extra");
import inquirer = require("inquirer");
import path = require("path");
// eslint-disable-next-line @typescript-eslint/no-floating-promises
CliLogic();
@ -215,6 +214,11 @@ function checkYargsParameters(options: options): options {
default: options.generationOptions.convertCaseProperty,
describe: "Convert property names to specified case"
},
eol: {
choices: ["LF", "CRLF"],
default: options.generationOptions.convertEol,
describe: "Force EOL to be LF or CRLF"
},
pv: {
alias: "property-visibility",
choices: ["public", "protected", "private", "none"],
@ -302,6 +306,7 @@ function checkYargsParameters(options: options): options {
options.generationOptions.convertCaseEntity = argv.ce as IGenerationOptions["convertCaseEntity"];
options.generationOptions.convertCaseFile = argv.cf as IGenerationOptions["convertCaseFile"];
options.generationOptions.convertCaseProperty = argv.cp as IGenerationOptions["convertCaseProperty"];
options.generationOptions.convertEol = argv.eol as IGenerationOptions["convertEol"];
options.generationOptions.lazy = argv.lazy;
options.generationOptions.customNamingStrategyPath = argv.namingStrategy;
options.generationOptions.noConfigs = argv.noConfig;
@ -525,6 +530,11 @@ async function useInquirer(options: options): Promise<options> {
options.generationOptions.convertCaseFile !==
defaultGenerationOptions.convertCaseFile
},
{
name: "Use specific EOL character",
value: "converteol",
checked: false
},
{
name:
"Pluralize OneToMany, ManyToMany relation names",
@ -659,6 +669,18 @@ async function useInquirer(options: options): Promise<options> {
options.generationOptions.convertCaseEntity =
namingConventions.entityCase;
}
if (customizations.includes("converteol")) {
const eolChoice = await inquirer.prompt([
{
choices: ["LF", "CRLF"],
default: options.generationOptions.convertEol,
message: "Force EOL to be:",
name: "eol",
type: "list"
}
]);
options.generationOptions.convertEol = eolChoice.eol;
}
}
const { saveConfig } = await inquirer.prompt([
{

47
test/modelCustomization/modelCustomization.test.ts
View File

@ -283,6 +283,53 @@ describe("Model customization phase", async () => {
compileGeneratedModel(generationOptions.resultsPath, [""]);
});
});
describe("EOL", async () => {
it("LF", () => {
const data = generateSampleData();
const generationOptions = generateGenerationOptions();
clearGenerationDir();
generationOptions.convertEol = "LF";
const customizedModel = modelCustomizationPhase(
data,
generationOptions,
{}
);
modelGenerationPhase(
getDefaultConnectionOptions(),
generationOptions,
customizedModel
);
const filesGenPath = path.resolve(resultsPath, "entities");
const postContent = fs
.readFileSync(path.resolve(filesGenPath, "Post.ts"))
.toString();
expect(postContent).to.not.contain("\r\n");
expect(postContent).to.contain("\n");
compileGeneratedModel(generationOptions.resultsPath, [""]);
});
it("CRLF", () => {
const data = generateSampleData();
const generationOptions = generateGenerationOptions();
clearGenerationDir();
generationOptions.convertEol = "CRLF";
const customizedModel = modelCustomizationPhase(
data,
generationOptions,
{}
);
modelGenerationPhase(
getDefaultConnectionOptions(),
generationOptions,
customizedModel
);
const filesGenPath = path.resolve(resultsPath, "entities");
const postContent = fs
.readFileSync(path.resolve(filesGenPath, "Post.ts"))
.toString();
expect(postContent).to.contain("\r\n");
compileGeneratedModel(generationOptions.resultsPath, [""]);
});
});
describe("property-visibility", () => {
it("public", () => {
const data = generateSampleData();