习惯约定

Halsp 在很多方面都是约定大于配置

遵循这些约定可以避免很多配置和不必要的问题

本部分仅列举常见约定，其他约定详见各插件的介绍

统一启动文件 Startup

在 src 下需要有 startup.ts 文件，导出一个默认回调函数，此规则用于 @halsp/cli 正确解析代码，内容如

// startup.ts
export default function <T extends Startup>(startup: T, mode?: string) {
  return startup
    .use(async (ctx, next) => {
      ctx.res.set("mode", mode ?? "");
      await next();
    })
    .useInject()
    .useRouter();
}

mode 参数值为 @halsp/cli 的 build 或 start 命令传入的 --mode 参数，如 development、production 等

路由文件夹

@halsp/router 或 @halsp/mva 路由文件夹默认为 src/actions

当然你也可以指定其他文件夹，需配置 halsp-cli.config.ts，增加 routerActionsDir ，如

import { defineConfig, Configuration } from "@halsp/cli";
export default defineConfig(({ mode }) => {
  return {
    routerActionsDir: "custom-actions",
  } as Configuration;
});

视图文件夹

@halsp/view 或 @halsp/mva 视图文件夹默认为 views，其中的文件会被 @halsp/cli 自动打包

你也可以指定其他文件夹，设置 startup.useView() 的参数

startu.useView({
  dir: "custom-views",
})

并且如果修改默认视图文件夹，你还需要配置 halsp-cli.config.ts 以支持 @halsp/cli 的资源文件打包功能

import { defineConfig, Configuration } from "@halsp/cli";
export default defineConfig(({ mode }) => {
  return {
    build: {
      assets:[
        {
          include: 'custom-views/*'
        }
      ]
    }
  } as Configuration;
});

静态文件

@halsp/static 静态资源文件夹默认为 static，其中的文件会被 @halsp/cli 自动打包

你也可以指定其他文件夹，设置 startup.useStatic() 的参数

startup.useStatic({
  dir: "custom-static"
})

并且如果修改默认静态资源文件夹，你还需要配置 halsp-cli.config.ts 以支持 @halsp/cli 的资源文件打包功能

import { defineConfig, Configuration } from "@halsp/cli";
export default defineConfig(({ mode }) => {
  return {
    build: {
      assets:[
        {
          include: 'custom-static/*'
        }
      ]
    }
  } as Configuration;
});