Editing Rules

Code modifications must follow these rules. Violations will cause build or translation failures.

---

1. Never edit types/ directly

All .d.ts files under types/ are auto-generated by npm run ts-build.

• Edit the source .js files (JSDoc @typedef, @property, etc.)
• Run npm run ts-build to regenerate types/
• Any manual edits to types/ will be overwritten on the next build

2. Never edit dist/ directly

All files under dist/ are auto-generated by webpack build.

• Edit source files under src/
• CSS: edit src/assets/suneditor.css or src/assets/suneditor-contents.css
• Run npm run build:prod to regenerate dist/

CSS conventions (suneditor.css)

• RTL rules go in the RTL section. Every .se-rtl selector belongs in the dedicated block at the bottom of suneditor.css (/** --- RTL start */ … /** --- RTL end */), never next to the base (LTR) rules. Group new rules after the existing rules of the same feature area (e.g. table rules after the other table rules).
• Colors come from theme tokens, never hardcoded. Use var(--se-*); define new tokens in src/assets/design/color.css (light defaults) and override them in every theme file under src/themes/*.css (dark, midnight, cobalt, cream) — prefer aliasing an existing theme token (e.g. var(--se-main-color-lighter)) over inventing per-theme literal values.

3. Language files: edit en.js only

All language files under src/langs/ (except en.js) are auto-generated by the translation script.

• Edit only src/langs/en.js for string changes
• Run npm run check:langs to sync/translate other language files
• Never directly edit ko.js, ja.js, zh_cn.js, or any other language file

4. Never edit auto-generated marker sections

Some source files contain auto-generated sections between markers. Do not edit content between these markers:

• src/typedef.js: /* === [ Button Types - Auto-generated ] === */ — generated by npm run check:inject
• src/core/schema/options.js: /* === [ Plugin-Specific Options ] === */ — generated by npm run check:inject

5. Three-file sync rule

These three files export the same modules and must be kept in sync:

• src/suneditor.js (source of truth)
• webpack/cdn-builder.js (intentionally excludes langs)
• scripts/ts-build/format-index.cjs

Run npm run check:exports to validate.

6. After-change commands

7. Verification scope and generated side effects

Use .agents/skills/post-edit/SKILL.md for source edits. ts-build generates types but masks the compiler exit status with tsc || true; always run npm run lint:type separately before claiming type safety. check:inject writes generated source sections; check:langs translates files using Google credentials and is not a read-only check. Do not run the translation command for unrelated changes or without its configured service. Report an unavailable translation step explicitly.

For documentation/harness-only changes, check links, command names, examples and git diff --check; do not regenerate source/types or run the source autofixer.