diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d65daf33..8636c99a8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,15 +20,30 @@ yarn ``` ## 修改代码 -待补充: -- 多文件支持 -- Vue SFC 支持 ### 修改现有功能 - 启动[监视模式](##构建/监视) - 确认功能对应的代码文件, 通常根据目录结构就可以找到, 实在找不到可以在设置中可以通过检查元素查看到某项功能对应的 `data-key`, 这个 key 对应的是 `src/client/resource-manifest.js` 中的 key, 从而可以得知相应的代码文件名称 (`path` 属性) - 修改代码, 保存后会自动编译 +#### 夜间模式修改 +如果要改的是夜间模式, 改原有样式就原地改, 添加样式就进入数字最大的那个 `dark-slice-xxx.scss` 文件修改即可 + +> 你可能会发现, 旧的 slice 风格以多个不同地方的选择器 + 尽量少的样式声明组成; 新的 slice 里是按照修改的地方分开存放, 因为有 Sass 的 Mixin, 所以可以放心地随时添加样式声明, Mixin 列表见 `src/style/dark/_dark-definitions.scss` + +附一些要点: +- 尽可能遵照 b 站白天原有的元素风格, 除非原版实在太丑 +- 颜色相关的 Mixin 参数含义: + - 0个字符 `transparent` + - 1个字符 `e` -> `#eee` + - 2个字符 `e8` -> `#e8e8e8` + - 3/6个字符 `eee` -> `#eee` +- theme-color 相关的 Mixin 可以对各种属性应用主题色 +- foreground-color 相关的 Mixin 仅用于主题色做背景时的前景色 (对应设置中的 `文本颜色`) +- 避免写入名字过于宽泛的选择器, 比如 `.card`, 夜间模式作用于所有页面, 要尽可能避免选择器误伤. 遇到这种情况可以向上寻找元素的父级 class, 组成一个 `.xxx .card` 就比较好 +- 遇到纯色图片可以用 `@to-theme('pink')` / `@to-theme('blue')` 转换为主题色 (参数是原来的颜色, 目前就这两种, 放在 filter 上) +- 旧的 slice 基本都不符合这些要点, 不过我们也懒得改了( + ### 添加新功能 - 在 `src/client/settings.js` 中的 `settings` 对象上添加新的 key, 作为新功能的默认值 - 在 `@types/global/index.d.ts` 添加对应的类型声明 @@ -67,10 +82,126 @@ interface ResourceDefinition { } } ``` -- 写好代码后可以进行[编译](##构建/监视), 调试时需要多次改动代码也可以使用监视模式 +- 写好代码后可以进行[编译](##编译), 调试时需要多次改动代码也可以使用监视模式 - 在 `src/utils/gui-settings/gui-settings.html` 中添加对应的设置项, 可以使用 `` 或 `` 元素, 子选项需要增加 `indent` 值, 并在 `dependencies` 中指定父级的 key. -## 构建/监视 +### 多文件 +将重复逻辑提出一个单独文件是很好的做法, 但可惜本项目对多文件的支持十分有限. + +例子: 假设 `a.ts` `b.ts` 都想使用 `lib.ts` 中的函数 `foo`, 那么 `lib.ts` 需要写成这样: +```ts +// lib.ts +// 导出函数本身, 这样 VSCode 才能提供代码补全, 且通过 TypeScript 编译 +export const foo = () => console.log('foo') + +// 导出一个默认对象, 对象上声明一个固定的 export 属性, 值为一个对象, 包含当前文件所有要导出的内容 +// 这个是运行时实际获取导出内容的地方, 所以 export 这个名字不能更换 +export default { + export: { foo } +} +``` +> `export `(后面带一个空格) 会被编译器识别为导出, 并在最后生成的代码中删除, 因此你不能在其他任何地方使用 `export `, 包括字符串里也不行. 例如 `const html = 'link'` 会变成 `const html = 'link'`, 需要改成 `const html = 'link'` 才行. + +然后使用的时候, **必须**通过动态导入方式导入 `lib.ts` 中的功能 (`interface` 之类的运行时不存在的东西没有这个限制) +```ts +// a.ts / b.ts +(async () => { + const { foo } = await import('./lib') + foo() +})() +``` +`a.ts` 如果作为一项功能, 需要在 `src/client/resource-manifest.js` 中声明, `lib.ts` 只导出一些可重用的功能, 不需要声明. +如果 `lib.ts` 即是一项功能, 又导出函数给其他功能使用, 那么仍然需要声明. + +### Vue SFC 支持 (Vue 单文件组件) +Vue 的支持仅限内置的几种标签: `