chore: enforce code style and format existing sources

Author: reycn

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{py,swift}]
+indent_size = 4

.github/scripts/recent-updates.cjs

@@ -1,45 +1,71 @@
-const {execFileSync}=require('node:child_process');
-const {readFileSync,writeFileSync}=require('node:fs');
+const { execFileSync } = require('node:child_process');
+const { readFileSync, writeFileSync } = require('node:fs');
 
-const feature=/^feat(?:\([^\r\n)]+\))?!?:\s*(.+)$/;
-const git=(...args)=>execFileSync('git',args,{encoding:'utf8'}).trim();
-const escape=value=>String(value).replace(/[\\`*_[\]<>|]/g,char=>`\\${char}`).replace(/[\r\n]+/g,' ');
+const feature = /^feat(?:\([^\r\n)]+\))?!?:\s*(.+)$/;
+const git = (...args) => execFileSync('git', args, { encoding: 'utf8' }).trim();
+const escape = (value) =>
+  String(value)
+    .replace(/[\\`*_[\]<>|]/g, (char) => `\\${char}`)
+    .replace(/[\r\n]+/g, ' ');
 
-function replaceUpdates(readme,rows){
- const section=/^## Recent updates\r?\n[\s\S]*?(?=^## |$(?![\s\S]))/m;
- if(!section.test(readme))throw Error('README.md must contain a Recent updates section.');
- return readme.replace(section,()=>`## Recent updates\n\n| Date | Feature | Contributor |\n| --- | --- | --- |\n${rows.join('\n')}\n\n`);
+function replaceUpdates(readme, rows) {
+  const section = /^## Recent updates\r?\n[\s\S]*?(?=^## |$(?![\s\S]))/m;
+  if (!section.test(readme)) throw Error('README.md must contain a Recent updates section.');
+  return readme.replace(
+    section,
+    () =>
+      `## Recent updates\n\n| Date | Feature | Contributor |\n| --- | --- | --- |\n${rows.join('\n')}\n\n`,
+  );
 }
 
-module.exports=async({github,context,core})=>{
- const {before,after,created,deleted}=context.payload;
- if(deleted)return;
- const range=created||!before||/^0+$/.test(before)?[after]:[`${before}..${after}`];
- // A multi-commit push can contain feat even when its newest commit is a fix.
- const subjects=git('log','--format=%s',...range).split('\n');
- if(!subjects.some(subject=>feature.test(subject))){core.info('No feat commits in this push.');return;}
- const readme=readFileSync('README.md','utf8');
- const previous=new Map([...readme.matchAll(/\[([^\n]+?)\]\(https:\/\/[^\s)]+\/commit\/([a-f0-9]{40})\)/g)].map(match=>[match[2],match[1]]));
- const history=git('log','--format=%H%x00%aI%x00%s').split('\n').map(line=>line.split('\0'));
- const updates=[];
- for(const [sha,date,subject] of history){
-  const match=subject.match(feature);if(!match)continue;
-  // Badge/documentation-only commits do not describe an application feature.
-  const files=git('diff-tree','--root','--no-commit-id','--name-only','-r',sha).split('\n').filter(Boolean);
-  if(!files.some(file=>!file.endsWith('.md')&&!file.startsWith('doc/')))continue;
-  updates.push({sha,date,subject:match[1]});
- }
- updates.sort((a,b)=>Date.parse(b.date)-Date.parse(a.date));
- const rows=await Promise.all(updates.slice(0,7).map(async({sha,date,subject})=>{
-  const {data}=await github.rest.repos.getCommit({...context.repo,ref:sha});
-  const author=data.author;
-  const contributor=author?`[@${escape(author.login)}](${author.html_url})`:`[${escape(data.commit.author.name)}](${data.html_url})`;
-  // Use the calendar date recorded by Git; display no time or timezone.
-  return `| ${date.slice(0,10)} | [${previous.get(sha)||escape(subject)}](${data.html_url}) | ${contributor} |`;
- }));
- const updated=replaceUpdates(readme,rows);
- if(updated===readme){core.info('Recent updates already current.');return;}
- writeFileSync('README.md',updated);
- core.setOutput('changed','true');
+module.exports = async ({ github, context, core }) => {
+  const { before, after, created, deleted } = context.payload;
+  if (deleted) return;
+  const range = created || !before || /^0+$/.test(before) ? [after] : [`${before}..${after}`];
+  // A multi-commit push can contain feat even when its newest commit is a fix.
+  const subjects = git('log', '--format=%s', ...range).split('\n');
+  if (!subjects.some((subject) => feature.test(subject))) {
+    core.info('No feat commits in this push.');
+    return;
+  }
+  const readme = readFileSync('README.md', 'utf8');
+  const previous = new Map(
+    [...readme.matchAll(/\[([^\n]+?)\]\(https:\/\/[^\s)]+\/commit\/([a-f0-9]{40})\)/g)].map(
+      (match) => [match[2], match[1]],
+    ),
+  );
+  const history = git('log', '--format=%H%x00%aI%x00%s')
+    .split('\n')
+    .map((line) => line.split('\0'));
+  const updates = [];
+  for (const [sha, date, subject] of history) {
+    const match = subject.match(feature);
+    if (!match) continue;
+    // Badge/documentation-only commits do not describe an application feature.
+    const files = git('diff-tree', '--root', '--no-commit-id', '--name-only', '-r', sha)
+      .split('\n')
+      .filter(Boolean);
+    if (!files.some((file) => !file.endsWith('.md') && !file.startsWith('doc/'))) continue;
+    updates.push({ sha, date, subject: match[1] });
+  }
+  updates.sort((a, b) => Date.parse(b.date) - Date.parse(a.date));
+  const rows = await Promise.all(
+    updates.slice(0, 7).map(async ({ sha, date, subject }) => {
+      const { data } = await github.rest.repos.getCommit({ ...context.repo, ref: sha });
+      const author = data.author;
+      const contributor = author
+        ? `[@${escape(author.login)}](${author.html_url})`
+        : `[${escape(data.commit.author.name)}](${data.html_url})`;
+      // Use the calendar date recorded by Git; display no time or timezone.
+      return `| ${date.slice(0, 10)} | [${previous.get(sha) || escape(subject)}](${data.html_url}) | ${contributor} |`;
+    }),
+  );
+  const updated = replaceUpdates(readme, rows);
+  if (updated === readme) {
+    core.info('Recent updates already current.');
+    return;
+  }
+  writeFileSync('README.md', updated);
+  core.setOutput('changed', 'true');
 };
-module.exports.replaceUpdates=replaceUpdates;
+module.exports.replaceUpdates = replaceUpdates;

.github/scripts/recent-updates.test.cjs

@@ -1,46 +1,91 @@
-const {test}=require('node:test');
-const assert=require('node:assert/strict');
-const {execFileSync}=require('node:child_process');
-const {mkdtempSync,writeFileSync,readFileSync,rmSync}=require('node:fs');
-const {join}=require('node:path');
-const {tmpdir}=require('node:os');
-const update=require('./recent-updates.cjs');
+const { test } = require('node:test');
+const assert = require('node:assert/strict');
+const { execFileSync } = require('node:child_process');
+const { mkdtempSync, writeFileSync, readFileSync, rmSync } = require('node:fs');
+const { join } = require('node:path');
+const { tmpdir } = require('node:os');
+const update = require('./recent-updates.cjs');
 
-test('multi-commit pushes update only English README, keep seven dated features and remain idempotent',async()=>{
- const root=mkdtempSync(join(tmpdir(),'reader-recent-updates-')),previous=process.cwd();
- const git=(...args)=>execFileSync('git',args,{cwd:root,encoding:'utf8',stdio:['ignore','pipe','pipe']}).trim();
- try{
-  git('init');git('config','user.name','Contributor');git('config','user.email','contributor@example.com');
-  const original='Intro\n\n## Features\n\nKeep features\n\n## Recent updates\n\nOld table\n\n## Quick start\n\nKeep quick start\n';
-  writeFileSync(join(root,'README.md'),original);writeFileSync(join(root,'translated.md'),'Keep translation');
-  git('add','.');git('commit','-m','initial');const before=git('rev-parse','HEAD');
-  for(let n=1;n<=9;n++){
-   writeFileSync(join(root,'app.js'),`// feature ${n}\n`);git('add','app.js');git('commit','-m',`feat(reader): feature ${n}`);
+test('multi-commit pushes update only English README, keep seven dated features and remain idempotent', async () => {
+  const root = mkdtempSync(join(tmpdir(), 'reader-recent-updates-')),
+    previous = process.cwd();
+  const git = (...args) =>
+    execFileSync('git', args, {
+      cwd: root,
+      encoding: 'utf8',
+      stdio: ['ignore', 'pipe', 'pipe'],
+    }).trim();
+  try {
+    git('init');
+    git('config', 'user.name', 'Contributor');
+    git('config', 'user.email', 'contributor@example.com');
+    const original =
+      'Intro\n\n## Features\n\nKeep features\n\n## Recent updates\n\nOld table\n\n## Quick start\n\nKeep quick start\n';
+    writeFileSync(join(root, 'README.md'), original);
+    writeFileSync(join(root, 'translated.md'), 'Keep translation');
+    git('add', '.');
+    git('commit', '-m', 'initial');
+    const before = git('rev-parse', 'HEAD');
+    for (let n = 1; n <= 9; n++) {
+      writeFileSync(join(root, 'app.js'), `// feature ${n}\n`);
+      git('add', 'app.js');
+      git('commit', '-m', `feat(reader): feature ${n}`);
+    }
+    const newest = git('rev-parse', 'HEAD');
+    writeFileSync(join(root, 'README.md'), original + '\nBadge\n');
+    git('add', 'README.md');
+    git('commit', '-m', 'feat: ci badge');
+    writeFileSync(join(root, 'app.js'), '// fix\n');
+    git('add', 'app.js');
+    git('commit', '-m', 'fix: last commit');
+    const after = git('rev-parse', 'HEAD');
+    let calls = 0;
+    const outputs = [];
+    const github = {
+      rest: {
+        repos: {
+          getCommit: async ({ ref }) => {
+            calls++;
+            return {
+              data: {
+                author: { login: 'contributor', html_url: 'https://github.com/contributor' },
+                html_url: `https://github.com/owner/repo/commit/${ref}`,
+              },
+            };
+          },
+        },
+      },
+    };
+    const core = { info: () => {}, setOutput: (...args) => outputs.push(args) };
+    const context = { repo: { owner: 'owner', repo: 'repo' }, payload: { before, after } };
+    process.chdir(root);
+    await update({ github, context, core });
+    const result = readFileSync('README.md', 'utf8');
+    assert.equal(calls, 7);
+    assert.equal((result.match(/^\| \d{4}-\d{2}-\d{2} \|/gm) || []).length, 7);
+    assert.ok(result.includes(`[feature 9](https://github.com/owner/repo/commit/${newest})`));
+    assert.ok(!result.includes('ci badge'));
+    assert.ok(!result.includes('feature 2]'));
+    assert.ok(result.includes('Keep features'));
+    assert.ok(result.includes('Keep quick start\n\nBadge'));
+    assert.ok(result.includes('[@contributor](https://github.com/contributor)'));
+    assert.equal(readFileSync('translated.md', 'utf8'), 'Keep translation');
+    assert.deepEqual(outputs, [['changed', 'true']]);
+    outputs.length = 0;
+    await update({ github, context, core });
+    assert.deepEqual(outputs, []);
+    // A fix-only push performs no API calls or file writes.
+    const callCount = calls;
+    context.payload.before = git('rev-parse', 'HEAD^');
+    await update({ github, context, core });
+    assert.equal(calls, callCount);
+    assert.equal(readFileSync('README.md', 'utf8'), result);
+    // New branches have an all-zero before SHA.
+    context.payload = { before: '0'.repeat(40), after, created: true };
+    await update({ github, context, core });
+    assert.equal(readFileSync('README.md', 'utf8'), result);
+  } finally {
+    process.chdir(previous);
+    rmSync(root, { recursive: true, force: true });
   }
-  const newest=git('rev-parse','HEAD');
-  writeFileSync(join(root,'README.md'),original+'\nBadge\n');git('add','README.md');git('commit','-m','feat: ci badge');
-  writeFileSync(join(root,'app.js'),'// fix\n');git('add','app.js');git('commit','-m','fix: last commit');const after=git('rev-parse','HEAD');
-  let calls=0;const outputs=[];
-  const github={rest:{repos:{getCommit:async({ref})=>{calls++;return {data:{author:{login:'contributor',html_url:'https://github.com/contributor'},html_url:`https://github.com/owner/repo/commit/${ref}`}};}}}};
-  const core={info:()=>{},setOutput:(...args)=>outputs.push(args)};
-  const context={repo:{owner:'owner',repo:'repo'},payload:{before,after}};
-  process.chdir(root);
-  await update({github,context,core});
-  const result=readFileSync('README.md','utf8');
-  assert.equal(calls,7);assert.equal((result.match(/^\| \d{4}-\d{2}-\d{2} \|/gm)||[]).length,7);
-  assert.ok(result.includes(`[feature 9](https://github.com/owner/repo/commit/${newest})`));
-  assert.ok(!result.includes('ci badge'));assert.ok(!result.includes('feature 2]'));
-  assert.ok(result.includes('Keep features'));assert.ok(result.includes('Keep quick start\n\nBadge'));
-  assert.ok(result.includes('[@contributor](https://github.com/contributor)'));
-  assert.equal(readFileSync('translated.md','utf8'),'Keep translation');
-  assert.deepEqual(outputs,[['changed','true']]);
-  outputs.length=0;await update({github,context,core});assert.deepEqual(outputs,[]);
-  // A fix-only push performs no API calls or file writes.
-  const callCount=calls;
-  context.payload.before=git('rev-parse','HEAD^');await update({github,context,core});
-  assert.equal(calls,callCount);assert.equal(readFileSync('README.md','utf8'),result);
-  // New branches have an all-zero before SHA.
-  context.payload={before:'0'.repeat(40),after,created:true};
-  await update({github,context,core});assert.equal(readFileSync('README.md','utf8'),result);
- }finally{process.chdir(previous);rmSync(root,{recursive:true,force:true});}
 });

.github/workflows/code-style.yml

@@ -0,0 +1,21 @@
+name: Code style
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+permissions:
+  contents: read
+jobs:
+  style:
+    runs-on: xcode-27
+    env:
+      ELECTRON_SKIP_BINARY_DOWNLOAD: '1'
+    steps:
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
+        with:
+          node-version: '22'
+          cache: npm
+      - uses: astral-sh/setup-uv@v7
+      - run: npm ci --no-audit --no-fund
+      - run: npm run style:check

.husky/pre-commit

@@ -0,0 +1 @@
+npm exec --no -- lint-staged

.prettierignore

@@ -0,0 +1,13 @@
+node_modules/
+dist/
+release/
+.cache/
+.codegraph/
+.cursor/
+public/symbols/
+src/build-info.mjs
+package-lock.json
+doc/**/*-baseline.json
+doc/**/*-optimized.json
+doc/**/*-result.json
+doc/**/*-results.json

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "all",
+  "endOfLine": "lf"
+}

.swift-format

@@ -0,0 +1,5 @@
+{
+  "version": 1,
+  "lineLength": 100,
+  "indentation": { "spaces": 4 }
+}