阿里巴巴低代码引擎项目教程

1. 项目的目录结构及介绍

阿里巴巴低代码引擎项目的目录结构如下：

lowcode-engine/
├── docs/
├── modules/
├── packages/
├── scripts/
├── .editorconfig
├── .eslintignore
├── .eslintrc.js
├── .gitignore
├── .prettierrc.js
├── .stylelintignore
├── .stylelintrc.js
├── CONTRIBUTOR.md
├── LICENSE
├── README-zh_CN.md
├── README.md
├── abc.json
├── babel.config.js
├── commitlint.config.js
├── index.ts
├── lerna.json
├── package.json
└── tsconfig.json

目录结构介绍

• docs/: 存放项目的文档文件。
• modules/: 存放项目的模块文件。
• packages/: 存放项目的包文件。
• scripts/: 存放项目的脚本文件。
• .editorconfig: 配置编辑器的格式化规则。
• .eslintignore: 配置ESLint忽略的文件和目录。
• .eslintrc.js: 配置ESLint的规则。
• .gitignore: 配置Git忽略的文件和目录。
• .prettierrc.js: 配置Prettier的格式化规则。
• .stylelintignore: 配置Stylelint忽略的文件和目录。
• .stylelintrc.js: 配置Stylelint的规则。
• CONTRIBUTOR.md: 贡献者指南。
• LICENSE: 项目的开源许可证。
• README-zh_CN.md: 项目的中文README文件。
• README.md: 项目的英文README文件。
• abc.json: 项目的配置文件。
• babel.config.js: Babel的配置文件。
• commitlint.config.js: Commitlint的配置文件。
• index.ts: 项目的入口文件。
• lerna.json: Lerna的配置文件。
• package.json: 项目的npm包配置文件。
• tsconfig.json: TypeScript的配置文件。

2. 项目的启动文件介绍

项目的启动文件是index.ts。该文件是整个低代码引擎的入口点，负责初始化引擎并启动应用。

index.ts 文件内容概述

import { init, skeleton } from '@alilc/lowcode-engine';

skeleton.add({
  area: 'topArea',
  type: 'Widget',
  name: 'logo',
  content: YourFantasticLogo,
  contentProps: {
    logo: 'https://img.alicdn.com/tfs/TB1_SocGkT2gK0jSZFkXXcIQFXa-66-66.png',
    href: '/'
  },
  props: {
    align: 'left',
    width: 100
  }
});

init(document.getElementById('lce'));

启动文件功能

• 初始化引擎: 通过init函数初始化低代码引擎。
• 添加组件: 使用skeleton.add函数添加自定义组件，如logo组件。
• 启动应用: 通过init函数启动应用，并将应用挂载到指定的DOM元素上。

3. 项目的配置文件介绍

package.json

package.json是项目的npm包配置文件，包含了项目的依赖、脚本命令等信息。

{
  "name": "lowcode-engine",
  "version": "1.0.0",
  "description": "An enterprise-class low-code technology stack with scale-out design",
  "main": "index.ts",
  "scripts": {
    "start": "npm run setup && npm run dev",
    "setup": "npm install",
    "dev": "npm run build && npm run serve"
  },
  "dependencies": {
    "@alilc/lowcode-engine": "^1.0.18",
    "@alilc/lowcode-react-simulator-renderer": "^1.0.18"
  },
  "devDependencies": {
    "typescript": "^4.0.0"
  }
}

tsconfig.json

tsconfig.json是TypeScript的配置文件，用于配置TypeScript编译器的行为。

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "**/*.spec.ts"]
}

babel.config.js

babel.config.js是Babel的配置文件，用于配置Babel编译器的行为。

module.exports = {
  presets: [
    '@babel/preset-env',
    '@babel/preset-typescript'
  ],
  plugins: [
    '@babel/plugin-proposal-class-properties'
  ]
};

commitlint.config.js

commitlint.config.js是Commitlint的配置文件，用于配置Git提交信息的格式检查。

module.exports = {
  extends: ['@commitlint/config-conventional']
};

lerna.json

lerna.json是Lerna的配置文件，用于配置多包管理工具Lerna的行为。

{
  "packages": ["packages/*"],
  "version": "1.0.0"
}

通过以上配置文件，可以确保项目在开发、构建和发布过程中遵循统一的规范和标准。