heading-case 0.1.0 → 0.1.2

package/README.md

@@ -38,12 +38,18 @@ Install:
 npm add heading-case -D
 ```
 
-Format all markdown and MDX files in the current directory:
+Check all markdown and MDX files in the current directory:
 
 ```bash
 npx heading-case
 ```
 
+Check and write the formatted content to the file:
+
+```bash
+npx heading-case --write
+```
+
 ## License
 
 [MIT](./LICENSE).

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export declare function globMarkdownFiles(cwd: string): Promise<string[]>;
+export declare const formatLine: (originalLine: string) => string;
 export declare function headingCase({ root, }?: {
     root?: string;
 }): Promise<void>;

package/dist/index.js

@@ -2912,14 +2912,19 @@ const dict = [
     ...Object.values(general_namespaceObject),
     ...Object.values(products_namespaceObject),
     ...Object.values(softwares_namespaceObject),
+    'Angular',
     'Create React App',
+    'Cloudflare Pages',
     'CSS Modules',
     'Docusaurus Faster',
     'EJS',
+    'Emotion',
     'Fast Refresh',
+    'GitHub Pages',
     'I',
     'Lightning CSS',
     'Module Federation',
+    'Relay',
     'Parcel',
     'Preact',
     'Preact Refresh',
@@ -2937,8 +2942,12 @@ const dict = [
     'Rspress',
     'Rstest',
     'Solid',
+    'Svelte',
     'Server Action',
+    'Service Worker',
+    'TanStack Router',
     'Vite',
+    'Vue',
     'Web Workers',
     'Xcode'
 ];
@@ -2965,6 +2974,7 @@ const isTerm = (word, line)=>dict.some((term)=>{
         if (term.includes(` ${word}`) || term.includes(`${word} `)) return line.includes(term);
         return term === word;
     });
+const shouldWrite = process.argv.includes('--write');
 const formatLine = (originalLine)=>{
     let line = originalLine;
     const words = line.trim().split(/\s+/);
@@ -2980,20 +2990,28 @@ const formatLine = (originalLine)=>{
     }
     return line;
 };
-function formatContent(content) {
+function formatContent(content, filePath) {
     const lines = content.split('\n');
     return lines.map((originalLine)=>{
-        if (isTitleLine(originalLine)) return formatLine(originalLine);
+        if (isTitleLine(originalLine)) {
+            const formattedLine = formatLine(originalLine);
+            if (!shouldWrite && formattedLine !== originalLine) {
+                logger.error(`Unexpected heading case in ${picocolors_default().dim(filePath)}`);
+                logger.log(`        Current: ${picocolors_default().cyan(originalLine)}`);
+                logger.log(`        Expected: ${picocolors_default().cyan(formattedLine)}\n`);
+            }
+            return formattedLine;
+        }
         return originalLine;
     }).join('\n');
 }
 async function formatFile(filePath) {
     const content = await __WEBPACK_EXTERNAL_MODULE_node_fs__["default"].promises.readFile(filePath, 'utf-8');
-    const formatted = formatContent(content);
+    const formatted = formatContent(content, filePath);
     const isChanged = formatted !== content;
-    if (isChanged) {
+    if (isChanged && shouldWrite) {
         await __WEBPACK_EXTERNAL_MODULE_node_fs__["default"].promises.writeFile(filePath, formatted);
-        logger.success(`formatted: ${picocolors_default().dim(filePath)}`);
+        logger.success(`[heading-case] formatted: ${picocolors_default().dim(filePath)}`);
     }
     return isChanged;
 }
@@ -3004,6 +3022,12 @@ async function headingCase({ root = process.cwd() } = {}) {
         const isFormatted = await formatFile(file);
         if (isFormatted) count++;
     }
-    if (count) logger.success(`[heading-case] formatted ${picocolors_default().yellow(count.toString())} files.`);
+    if (count) {
+        if (shouldWrite) logger.success(`[heading-case] formatted ${picocolors_default().yellow(count.toString())} files.`);
+        else {
+            logger.info(`[heading-case] found issues in ${picocolors_default().yellow(count.toString())} files.`);
+            process.exit(1);
+        }
+    }
 }
-export { globMarkdownFiles, headingCase };
+export { formatLine, globMarkdownFiles, headingCase };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "heading-case",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "repository": "https://github.com/rspack-contrib/heading-case",
   "license": "MIT",
   "type": "module",
@@ -15,9 +15,16 @@
   },
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "files": ["dist"],
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch",
+    "lint": "biome check .",
+    "lint:write": "biome check . --write",
+    "prepare": "simple-git-hooks && npm run build",
+    "test": "node test/index.js",
+    "bump": "npx bumpp"
+  },
   "simple-git-hooks": {
     "pre-commit": "npm run lint:write"
   },
@@ -32,16 +39,9 @@
     "tinyglobby": "^0.2.10",
     "typescript": "^5.7.2"
   },
+  "packageManager": "pnpm@9.14.4",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
-  },
-  "scripts": {
-    "build": "rslib build",
-    "dev": "rslib build --watch",
-    "lint": "biome check .",
-    "lint:write": "biome check . --write",
-    "test": "playwright test",
-    "bump": "npx bumpp"
   }
-}
+}