ci: verify API surface is up to date after build (#1054)

Author: jycouet

.github/workflows/ci.yml

@@ -37,6 +37,8 @@ jobs:
           cache: pnpm
       - run: pnpm install --frozen-lockfile
       - run: pnpm build
+      - name: Verify API surface is up to date
+        run: git diff --exit-code '**/api-surface*.md' || (echo "API surface is out of date. Run 'pnpm build' and commit the changes." && exit 1)
       - run: pnpm check
   test:
     runs-on: ${{ matrix.os }}

packages/sv-utils/api-surface.md

@@ -639,6 +639,7 @@ declare function addFragment(
 	content: string,
 	options?: {
 		mode?: 'append' | 'prepend';
+		language?: 'ts' | 'js';
 	}
 ): void;
 type TransformFn = (content: string) => string;
@@ -748,11 +749,13 @@ type Package = {
 	keywords?: string[];
 	workspaces?: string[];
 };
+
 declare function fileExists(cwd: string, filePath: string): boolean;
 
 declare function loadFile(cwd: string, filePath: string): string;
 
 declare function saveFile(cwd: string, filePath: string, content: string): void;
+
 declare function loadPackageJson(cwd: string): {
 	source: string;
 	data: Package;

packages/sv/api-surface.md

@@ -21,7 +21,7 @@ type FileType = {
 	condition?: ConditionDefinition;
 	content: (editor: FileEditor) => string;
 };
-/** @deprecated use `create({ cwd, ...options })` instead */
+/** @deprecated use `create({ cwd, ...options })` instead. */
 declare function create(cwd: string, options: Omit<Options, 'cwd'>): void;
 declare function create(options: Options): void;
 export {