Files
AFFiNE-Mirror/packages/frontend/templates/README.md
T
DarkSky 0c7b20dc18 chore: migrate oxlint & oxfmt (#15464)
#### PR Dependency Tree


* **PR #15464** 👈

This tree was auto-generated by
[Charcoal](https://github.com/danerwilliams/charcoal)

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

## Summary by CodeRabbit

* **Chores**
* Replaced the project’s formatting and linting workflow with Oxfmt and
Oxlint.
* Added shared formatting and linting configuration, editor integration,
and updated automated checks.
* Updated generated files, scripts, and lint guidance to use the new
tooling.

* **Style**
* Reformatted templates, source code, examples, and configuration files
for consistent readability.
  * No user-facing functionality or rendering behavior changed.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-08-10 23:51:28 +08:00

1.4 KiB

@affine/templates

Manages template files for use in AFFiNE. For now we only support onboarding templates.

How to update

Before we offer a better solution, to update the onboarding templates:

  1. run AFFiNE core locally (dev mode)
  2. expose ZipTransformer to window. e.g., import {ZipTransformer} from '@blocksuite/affine/blocks/root'; window.ZipTransformer = ZipTransformer;
  3. run the following script
    (async () => {
      // make sure ZipTransformer is imported and attached to window
      const { ZipTransformer } = window;
      await Promise.all(
        [...currentWorkspace.blockSuiteWorkspace.pages.values()].map(p =>
          p.load()
        )
      );
      // wait for a few more seconds
      await new Promise(resolve => setTimeout(resolve, 5000));
      const zipblob = await ZipTransformer.exportPages(
        currentWorkspace.blockSuiteWorkspace,
        [...currentWorkspace.blockSuiteWorkspace.pages.values()]
      );
      const url = URL.createObjectURL(zipblob);
      const a = document.createElement('a');
      a.setAttribute('href', url);
      a.setAttribute('download', `${currentWorkspace.id}.affine.zip`);
      a.click();
      a.remove();
      URL.revokeObjectURL(url);
    })();
    
  4. unzip the file, replace the json files into onboarding folder (no need to include the assets)
  5. run yarn postinstall to update the templates.gen.ts file