Skip to content

feat(): drop support for editor bricks #2205

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 9, 2022
Merged

feat(): drop support for editor bricks #2205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 0 additions & 5 deletions packages/brick-scripts/src/ask.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ import { askTargetType } from "./questions/askTargetType";
import { askPackageName } from "./questions/askPackageName";
import { askBrickName } from "./questions/askBrickName";
import { askProcessorName } from "./questions/askProcessorName";
import { askEditorBrickName } from "./questions/askEditorBrickName";
import { ask } from "./ask";

jest.mock("inquirer");
Expand All @@ -14,7 +13,6 @@ jest.mock("./questions/askTargetType");
jest.mock("./questions/askPackageName");
jest.mock("./questions/askBrickName");
jest.mock("./questions/askProcessorName");
jest.mock("./questions/askEditorBrickName");

(getEasyopsConfig as jest.Mock).mockReturnValue({
useLocalSdk: true,
Expand All @@ -24,7 +22,6 @@ const spyOnAskTargetType = askTargetType as jest.Mock;
const spyOnAskPackageName = askPackageName as jest.Mock;
const spyOnAskBrickName = askBrickName as jest.Mock;
const spyOnAskProcessorName = askProcessorName as jest.Mock;
const spyOnAskEditorBrickName = askEditorBrickName as jest.Mock;

describe("ask", () => {
beforeEach(() => {
Expand All @@ -38,7 +35,6 @@ describe("ask", () => {

test.each<[TargetType, string, string, string, string]>([
[TargetType.A_NEW_BRICK, "package-a", "brick-a", "", ""],
[TargetType.A_NEW_EDITOR_BRICK, "package-a", "", "", "brick-a"],
[TargetType.A_NEW_CUSTOM_PROVIDER, "package-a", "brick-b", "", ""],
[TargetType.A_NEW_CUSTOM_PROCESSOR, "package-a", "", "doSomething", ""],
[TargetType.A_NEW_PACKAGE_OF_LIBS, "lib-a", "", "", ""],
Expand All @@ -55,7 +51,6 @@ describe("ask", () => {
spyOnAskPackageName.mockReturnValue({ packageName });
spyOnAskBrickName.mockReturnValue({ brickName });
spyOnAskProcessorName.mockReturnValue({ processorName });
spyOnAskEditorBrickName.mockReturnValue({ brickName: editorBrickName });

expect(await ask("")).toEqual({
targetType,
Expand Down
11 changes: 0 additions & 11 deletions packages/brick-scripts/src/ask.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ import { askPackageName } from "./questions/askPackageName";
import { askBrickName } from "./questions/askBrickName";
import { askProcessorName } from "./questions/askProcessorName";
import { updateHistory } from "./loaders/loadHistory";
import { askEditorBrickName } from "./questions/askEditorBrickName";

export async function ask(
appRoot: string,
Expand Down Expand Up @@ -50,7 +49,6 @@ export async function ask(

switch (targetType) {
case TargetType.A_NEW_BRICK:
case TargetType.A_NEW_EDITOR_BRICK:
case TargetType.A_NEW_CUSTOM_TEMPLATE:
case TargetType.A_NEW_CUSTOM_PROVIDER:
case TargetType.A_NEW_CUSTOM_PROCESSOR:
Expand Down Expand Up @@ -101,15 +99,6 @@ export async function ask(
})
)
).processorName;
} else if (targetType === TargetType.A_NEW_EDITOR_BRICK) {
brickName = (
await inquirer.prompt(
askEditorBrickName({
packageName,
appRoot,
})
)
).brickName;
}

return {
Expand Down
1 change: 0 additions & 1 deletion packages/brick-scripts/src/constant.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ import { TargetType } from "./interface";

export const targetMap = {
[TargetType.A_NEW_BRICK]: "bricks",
[TargetType.A_NEW_EDITOR_BRICK]: "bricks",
[TargetType.A_NEW_CUSTOM_TEMPLATE]: "bricks",
[TargetType.A_NEW_PACKAGE_OF_BRICKS]: "bricks",
[TargetType.A_NEW_PACKAGE_OF_LIBS]: "libs",
Expand Down
2 changes: 0 additions & 2 deletions packages/brick-scripts/src/interface.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ export interface AskFlags {

export enum TargetType {
A_NEW_BRICK = "brick",
A_NEW_EDITOR_BRICK = "editor-brick",
A_NEW_PACKAGE_OF_BRICKS = "bricks",
A_NEW_PACKAGE_OF_LIBS = "libs",
// A_NEW_PACKAGE_OF_MICRO_APPS = "micro-apps",
Expand All @@ -24,7 +23,6 @@ export enum TargetType {

export const TargetTypeDisplay = {
[TargetType.A_NEW_BRICK]: "a new brick",
[TargetType.A_NEW_EDITOR_BRICK]: "a new editor brick",
[TargetType.A_NEW_PACKAGE_OF_BRICKS]: "a new package of bricks",
[TargetType.A_NEW_PACKAGE_OF_LIBS]: "a new package of libs",
// [TargetType.A_NEW_PACKAGE_OF_MICRO_APPS]: "a new package of micro-apps",
Expand Down
116 changes: 0 additions & 116 deletions packages/brick-scripts/src/loaders/__snapshots__/loadTemplate.spec.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,86 +198,6 @@ getRuntime().registerCustomTemplate(\\"for-good.for-better\\", {
]
`;

exports[`loadTemplate should create a new editor brick 1`] = `
Array [
Array [
"dist/for-better.editor.module.css",
".wrapper {
/* Try to use pre-defined css variables like \`var(--editor-...)\` */
/* See https://git.easyops.local/anyclouds/next-core/blob/master/packages/brick-container/src/styles/editor-bricks-variables.css */
border-radius: var(--editor-brick-border-radius);
background: var(--editor-brick-skeleton-bg-light);
}
",
],
Array [
"dist/for-better.editor.spec.tsx",
"import React from \\"react\\";
import { shallow } from \\"enzyme\\";
import * as helper from \\"@next-core/editor-bricks-helper\\";
import { ForBetterEditor } from \\"./for-better.editor\\";

const mockUseBuilderNode = jest.spyOn(helper, \\"useBuilderNode\\");

describe(\\"ForBetterEditor\\", () => {
it(\\"should work\\", () => {
mockUseBuilderNode.mockReturnValueOnce({
type: \\"brick\\",
id: \\"B-001\\",
brick: \\"for-better\\",
alias: \\"my-brick\\",
$$parsedProperties: {},
});
const wrapper = shallow(<ForBetterEditor nodeUid={1} />);
expect(wrapper.find(\\"div\\").text()).toBe(\\"my-brick\\");
});
});
",
],
Array [
"dist/for-better.editor.tsx",
"import React from \\"react\\";
import {
EditorComponentProps,
EditorContainer,
EditorElementFactory,
EditorSelfLayout,
useBuilderNode,
} from \\"@next-core/editor-bricks-helper\\";
import styles from \\"./for-better.editor.module.css\\";

// eslint-disable-next-line @typescript-eslint/no-empty-interface
interface ForBetterProperties {
// someProps?: string;
}

export function ForBetterEditor({
nodeUid,
}: EditorComponentProps): React.ReactElement {
const node = useBuilderNode<ForBetterProperties>({ nodeUid });
/**
* 提示：使用构件的属性配置来呈现该构件的关键 UI 特征。
* 例如：对于按钮构件，根据 \`buttonType\` 来显示对应的背景色。
*/
// const { someProps } = node.$$parsedProperties;
return (
<EditorContainer nodeUid={nodeUid}>
<div className={styles.wrapper}>{node.alias}</div>
</EditorContainer>
);
}

customElements.define(
\\"for-good.for-better--editor\\",
EditorElementFactory(ForBetterEditor, {
selfLayout: EditorSelfLayout.INLINE,
})
);
",
],
]
`;

exports[`loadTemplate should create a new package of bricks 1`] = `
Array [
Array [
Expand Down Expand Up @@ -315,10 +235,6 @@ preBuild(\\"bricks\\");
renameTarPackage();
",
],
Array [
"dist/src/editor-bricks/index.ts",
"",
],
Array [
"dist/src/i18n/constants.ts",
"export const NS_FOR_GOOD = \\"for-good\\";
Expand Down Expand Up @@ -417,20 +333,6 @@ module.exports = merge(
? webpackDevFactory()
: webpackProdFactory()
);
",
],
Array [
"dist/webpack.editors.js",
"const { bricks, merge } = require(\\"@next-core/webpack-config-factory\\");

const { webpackEditorsFactory, webpackDevFactory, webpackProdFactory } = bricks;

module.exports = merge(
webpackEditorsFactory(),
process.env.NODE_ENV === \\"development\\"
? webpackDevFactory()
: webpackProdFactory()
);
",
],
Array [
Expand Down Expand Up @@ -575,10 +477,6 @@ preBuild(\\"bricks\\");
renameTarPackage();
",
],
Array [
"dist/src/editor-bricks/index.ts",
"",
],
Array [
"dist/src/i18n/constants.ts",
"export const NS_FOR_GOOD = \\"for-good\\";
Expand Down Expand Up @@ -677,20 +575,6 @@ module.exports = merge(
? webpackDevFactory()
: webpackProdFactory()
);
",
],
Array [
"dist/webpack.editors.js",
"const { bricks, merge } = require(\\"@next-core/webpack-config-factory\\");

const { webpackEditorsFactory, webpackDevFactory, webpackProdFactory } = bricks;

module.exports = merge(
webpackEditorsFactory(),
process.env.NODE_ENV === \\"development\\"
? webpackDevFactory()
: webpackProdFactory()
);
",
],
]
Expand Down
10 changes: 0 additions & 10 deletions packages/brick-scripts/src/loaders/loadTemplate.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,6 @@ describe("loadTemplate", () => {
});
expect(files).toMatchSnapshot();
});
it("should create a new editor brick", async () => {
const files = await loadTemplate({
targetType: TargetType.A_NEW_EDITOR_BRICK,
packageName: "for-good",
brickName: "for-better",
processorName: "",
targetRoot: "dist",
});
expect(files).toMatchSnapshot();
});
it("should create a new custom template", async () => {
const files = await loadTemplate({
targetType: TargetType.A_NEW_CUSTOM_TEMPLATE,
Expand Down
4 changes: 1 addition & 3 deletions packages/brick-scripts/src/loaders/loadTemplate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ export async function loadTemplate({

const targetMap: { [key: string]: string } = {
[TargetType.A_NEW_BRICK]: "brick",
[TargetType.A_NEW_EDITOR_BRICK]: "editor-brick",
[TargetType.A_NEW_CUSTOM_TEMPLATE]: "custom-template",
[TargetType.A_NEW_PACKAGE_OF_BRICKS]: "bricks-pkg",
[TargetType.A_NEW_PACKAGE_OF_LIBS]: "libs-pkg",
Expand All @@ -109,9 +108,8 @@ export async function loadTemplate({
templateRoot,
targetMap[TargetType.A_NEW_PACKAGE_OF_BRICKS]
);
// Providers 库不需要 `src` 及 `webpack.editors.js`。
// Providers 库不需要 `src`。
ignores.push("template/bricks-pkg/src/");
ignores.push("template/bricks-pkg/webpack.editors.js");
sdkName = `${packageName.replace(/^providers-of-/, "")}-sdk`;
}

Expand Down
24 changes: 0 additions & 24 deletions packages/brick-scripts/src/main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,6 @@ export async function create(flags: AskFlags): Promise<void> {
case TargetType.A_NEW_BRICK:
targetRoot = path.join(pkgRoot, "src", brickName);
break;
case TargetType.A_NEW_EDITOR_BRICK:
targetRoot = path.join(pkgRoot, "src/editor-bricks", brickName);
break;
case TargetType.A_NEW_CUSTOM_TEMPLATE:
targetRoot = path.join(pkgRoot, "src/custom-templates");
break;
Expand Down Expand Up @@ -180,27 +177,6 @@ export async function create(flags: AskFlags): Promise<void> {
}
}
break;
case TargetType.A_NEW_EDITOR_BRICK:
{
const editorBricksIndexTs = path.join(
pkgRoot,
"src/editor-bricks/index.ts"
);
const importStatement = `import "./${brickName}/${brickName}.editor";${os.EOL}`;
const fileExisted = fs.existsSync(editorBricksIndexTs);
if (fileExisted) {
fs.appendFileSync(editorBricksIndexTs, importStatement);
} else {
fs.writeFileSync(editorBricksIndexTs, importStatement);
}

console.log(
`${chalk.bold(
`File ${fileExisted ? "updated" : "created"}`
)}: ./${path.relative(process.cwd(), editorBricksIndexTs)}`
);
}
break;
}

if (
Expand Down
76 changes: 0 additions & 76 deletions packages/brick-scripts/src/questions/askEditorBrickName.spec.ts
View file
Open in desktop

This file was deleted.

Loading