mirror of https://github.com/toeverything/AFFiNE.git synced 2026-02-15 05:37:32 +00:00

Files

Peng Xiao a21f1c943e feat(core): comment panel (#12989 )

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Introduced a full-featured document comment system with sidebar for
viewing, filtering, replying, resolving, and managing comments and
replies.
* Added a rich text comment editor supporting editable and read-only
modes.
  * Enabled comment-based navigation and highlighting within documents.
* Integrated comment functionality into the workspace sidebar (excluding
local workspaces).
* Added internationalization support and new UI strings for comment
features.
* Added new feature flag `enable_comment` for toggling comment
functionality.
  * Enhanced editor focus to support comment-related selections.
  * Added snapshot and store helpers for comment content management.
* Implemented backend GraphQL support for comment and reply operations.
* Added services for comment entity management and comment panel
behavior.
* Extended comment configuration to support optional framework
providers.
* Added preview generation from user selections when creating comments.
  * Enabled automatic sidebar opening on new pending comments.
  * Added comment-related query parameter support for navigation.
  * Included inline comment module exports for integration.
* Improved comment provider implementation with full lifecycle
management and UI integration.
* Added comment highlight state tracking and refined selection handling
in inline comments.

* **Style**
* Added comprehensive styles for the comment editor and sidebar
components.

* **Chores**
  * Updated language completeness percentages for multiple locales.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: L-Sun <zover.v@gmail.com>

2025-07-02 15:47:00 +00:00

src

feat(core): comment panel (#12989 )

2025-07-02 15:47:00 +00:00

.gitignore

refactor(i18n): lazy load languages (#8456 )

2024-10-10 09:03:06 +00:00

.i18n-codegen.json

chore: add monorepo tools (#9196 )

2024-12-24 15:29:48 +08:00

build.ts

feat(i18n): introduce server error i18n (#9953 )

2025-02-05 12:30:19 +00:00

cleanup.mjs

chore(i18n): cleanup i18n file (#8318 )

2024-09-20 06:25:17 +00:00

crowdin.yml

feat: sync i18n with crowdin (#8293 )

2024-09-19 05:30:18 +00:00

package.json

chore: bump base version

2025-06-24 14:43:39 +08:00

README.md

refactor(i18n): new hook api (#7273 )

2024-06-20 02:19:41 +00:00

tsconfig.json

chore(server): stdout is enough for collecting server logging (#9964 )

2025-02-05 13:25:11 +00:00

README.md

i18n

Usages

Update missing translations into the base resources, a.k.a the src/resources/en.json
Replace literal text with translation keys

import { useI18n, LOCALES } from '@affine/i18n';
// src/resources/en.json
// {
//     'Text': 'some text',
//     'Switch to language': 'Switch to {{language}}', // <- you can interpolation by curly brackets
// };

const App = () => {
  const i18n = useI18n();
  const changeLanguage = (language: string) => {
    i18n.changeLanguage(language);
  };

  return (
    <div>
      <div>{i18n['Workspace Settings']()}</div>
      <>
        {LOCALES.map(option => {
          return (
            <button
              key={option.name}
              onClick={() => {
                changeLanguage(option.tag);
              }}
            >
              {option.originalName}
            </button>
          );
        })}
      </>
    </div>
  );
};

How the i18n workflow works?

When the src/resources/en.json(base language) updated and merged to the develop branch, will trigger the languages-sync action.
The languages-sync action will check the base language and add missing translations to the Tolgee platform.
This way, partners from the community can update the translations.

How to sync translations manually

Set token as environment variable

export TOLGEE_API_KEY=tgpak_XXXXXXX

Run the sync-languages:check to check all languages
Run the sync-languages script to add new keys to the Tolgee platform
Run the download-resources script to download the latest full-translation translation resources from the Tolgee platform

README.md

i18n

Usages

How the i18n workflow works?

How to sync translations manually

References