Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(vscode): add useUnionTypes setting #4348

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions extensions/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@
"default": true,
"description": "Whether to use sealed classes when creating a new bloc."
},
"bloc.newBlocTemplate.useUnionTypes": {
"type": "boolean",
"default": true,
"description": "Whether to use union types for state or a single class relying on copyWith. Only works with \"freezed\"."
},
"bloc.newCubitTemplate.type": {
"type": "string",
"default": "auto",
Expand All @@ -93,6 +98,11 @@
"type": "boolean",
"default": true,
"description": "Whether to use sealed classes when creating a new cubit."
},
"bloc.newCubitTemplate.useUnionTypes": {
"type": "boolean",
"default": true,
"description": "Whether to use union types for state or a single class relying on copyWith. Only works with \"freezed\"."
}
}
}
Expand Down
13 changes: 10 additions & 3 deletions extensions/vscode/src/commands/new-bloc.command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,11 @@ async function generateBlocCode(
const useSealedClasses = workspace
.getConfiguration("bloc")
.get<boolean>("newBlocTemplate.useSealedClasses", true);

const useUnionTypes = workspace
.getConfiguration("bloc")
.get<boolean>("newBlocTemplate.useUnionTypes", true);

await Promise.all([
createBlocEventTemplate(
blocName,
Expand All @@ -101,7 +106,8 @@ async function generateBlocCode(
blocName,
blocDirectoryPath,
type,
useSealedClasses
useSealedClasses,
useUnionTypes,
),
createBlocTemplate(blocName, blocDirectoryPath, type),
]);
Expand Down Expand Up @@ -149,7 +155,8 @@ function createBlocStateTemplate(
blocName: string,
targetDirectory: string,
type: BlocType,
useSealedClasses: boolean
useSealedClasses: boolean,
useUnionTypes: boolean,
) {
const snakeCaseBlocName = changeCase.snakeCase(blocName);
const targetPath = `${targetDirectory}/${snakeCaseBlocName}_state.dart`;
Expand All @@ -159,7 +166,7 @@ function createBlocStateTemplate(
return new Promise<void>(async (resolve, reject) => {
writeFile(
targetPath,
getBlocStateTemplate(blocName, type, useSealedClasses),
getBlocStateTemplate(blocName, type, useSealedClasses, useUnionTypes),
"utf8",
(error) => {
if (error) {
Expand Down
17 changes: 14 additions & 3 deletions extensions/vscode/src/commands/new-cubit.command.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,18 @@ async function generateCubitCode(
const useSealedClasses = workspace
.getConfiguration("bloc")
.get<boolean>("newCubitTemplate.useSealedClasses", true);

const useUnionTypes = workspace
.getConfiguration("bloc")
.get<boolean>("newCubitTemplate.useUnionTypes", true);
await Promise.all([
createCubitStateTemplate(cubitName, cubitDirectoryPath, type, useSealedClasses),
createCubitStateTemplate(
cubitName,
cubitDirectoryPath,
type,
useSealedClasses,
useUnionTypes,
),
createCubitTemplate(cubitName, cubitDirectoryPath, type),
]);
}
Expand All @@ -108,7 +118,8 @@ function createCubitStateTemplate(
cubitName: string,
targetDirectory: string,
type: BlocType,
useSealedClasses: boolean
useSealedClasses: boolean,
useUnionTypes: boolean,
) {
const snakeCaseCubitName = changeCase.snakeCase(cubitName);
const targetPath = `${targetDirectory}/${snakeCaseCubitName}_state.dart`;
Expand All @@ -118,7 +129,7 @@ function createCubitStateTemplate(
return new Promise<void>(async (resolve, reject) => {
writeFile(
targetPath,
getCubitStateTemplate(cubitName, type, useSealedClasses),
getCubitStateTemplate(cubitName, type, useSealedClasses, useUnionTypes),
"utf8",
(error) => {
if (error) {
Expand Down
30 changes: 25 additions & 5 deletions extensions/vscode/src/templates/bloc-state.template.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ import { BlocType } from "../utils";
export function getBlocStateTemplate(
blocName: string,
type: BlocType,
useSealedClasses: boolean
useSealedClasses: boolean,
useUnionTypes: boolean,
): string {
switch (type) {
case BlocType.Freezed:
return getFreezedBlocStateTemplate(blocName);
return getFreezedBlocStateTemplate(
blocName,
useSealedClasses,
useUnionTypes,
);
case BlocType.Equatable:
return getEquatableBlocStateTemplate(blocName, useSealedClasses);
default:
Expand Down Expand Up @@ -54,14 +59,29 @@ ${subclassPrefix}class ${pascalCaseBlocName}Initial extends ${pascalCaseBlocName
`;
}

function getFreezedBlocStateTemplate(blocName: string): string {
function getFreezedBlocStateTemplate(
blocName: string,
useSealedClasses: boolean,
useUnionTypes: boolean,
): string {
const pascalCaseBlocName = changeCase.pascalCase(blocName) + "State";
const snakeCaseBlocName = changeCase.snakeCase(blocName);
return `part of '${snakeCaseBlocName}_bloc.dart';
const classPrefix = useSealedClasses ? "sealed " : "";

if (useUnionTypes) {
return `part of '${snakeCaseBlocName}_bloc.dart';

@freezed
class ${pascalCaseBlocName} with _\$${pascalCaseBlocName} {
${classPrefix}class ${pascalCaseBlocName} with _\$${pascalCaseBlocName} {
const factory ${pascalCaseBlocName}.initial() = _Initial;
}
`;
}
return `part of '${snakeCaseBlocName}_bloc.dart';

@freezed
${classPrefix}class ${pascalCaseBlocName} with _\$${pascalCaseBlocName} {
const factory ${pascalCaseBlocName}() = _${pascalCaseBlocName};
}
`;
}
31 changes: 26 additions & 5 deletions extensions/vscode/src/templates/cubit-state.template.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,16 @@ import { BlocType } from "../utils";
export function getCubitStateTemplate(
cubitName: string,
type: BlocType,
useSealedClasses: boolean
useSealedClasses: boolean,
useUnionTypes: boolean,
): string {
switch (type) {
case BlocType.Freezed:
return getFreezedCubitStateTemplate(cubitName);
return getFreezedCubitStateTemplate(
cubitName,
useSealedClasses,
useUnionTypes,
);
case BlocType.Equatable:
return getEquatableCubitStateTemplate(cubitName, useSealedClasses);
default:
Expand Down Expand Up @@ -54,14 +59,30 @@ ${subclassPrefix}class ${pascalCaseCubitName}Initial extends ${pascalCaseCubitNa
`;
}

function getFreezedCubitStateTemplate(cubitName: string): string {
function getFreezedCubitStateTemplate(
cubitName: string,
useSealedClasses: boolean,
useUnionTypes: boolean,
): string {
const pascalCaseCubitName = changeCase.pascalCase(cubitName);
const snakeCaseCubitName = changeCase.snakeCase(cubitName);
return `part of '${snakeCaseCubitName}_cubit.dart';
const classPrefix = useSealedClasses ? "sealed " : "";

if (useUnionTypes) {
return `part of '${snakeCaseCubitName}_cubit.dart';

@freezed
class ${pascalCaseCubitName}State with _\$${pascalCaseCubitName}State {
${classPrefix}class ${pascalCaseCubitName}State with _\$${pascalCaseCubitName}State {
const factory ${pascalCaseCubitName}State.initial() = _Initial;
}
`;
}

return `part of '${snakeCaseCubitName}_cubit.dart';

@freezed
${classPrefix}class ${pascalCaseCubitName}State with _\$${pascalCaseCubitName}State {
const factory ${pascalCaseCubitName}State() = _${pascalCaseCubitName}State;
}
`;
}