heading-case 0.0.1 → 0.1.1

package/README.md

@@ -1,6 +1,6 @@
 # heading-case
 
-Format page titles and section headings in markdown files to use sentence-style capitalization.
+Format page titles and section headings in markdown files to use [sentence-style capitalization](https://learn.microsoft.com/en-us/style-guide/text-formatting/using-type/use-sentence-style-capitalization).
 
 <p>
   <a href="https://npmjs.com/package/heading-case">
@@ -10,6 +10,26 @@ Format page titles and section headings in markdown files to use sentence-style
   <a href="https://npmcharts.com/compare/heading-case?minimal=true"><img src="https://img.shields.io/npm/dm/heading-case.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="downloads" /></a>
 </p>
 
+## Example
+
+- Input:
+
+```md
+# A New Method for Creating JavaScript Rollovers
+```
+
+- Output:
+
+```md
+# A new method for creating JavaScript rollovers
+```
+
+## Limitations
+
+This package is designed for Rspack's documentation. It follows the writing style of Rspack documentation and may not work well for other projects.
+
+There are some edge cases that can not be correctly handled, so the execution result is not completely reliable.
+
 ## Usage
 
 Install:
@@ -18,6 +38,18 @@ Install:
 npm add heading-case -D
 ```
 
+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.js

@@ -2912,21 +2912,35 @@ const dict = [
     ...Object.values(general_namespaceObject),
     ...Object.values(products_namespaceObject),
     ...Object.values(softwares_namespaceObject),
+    'Create React App',
+    'CSS Modules',
+    'Docusaurus Faster',
     'EJS',
-    'Rspack',
+    'Fast Refresh',
+    'I',
+    'Lightning CSS',
+    'Module Federation',
+    'Parcel',
+    'Preact',
+    'Preact Refresh',
+    'React',
+    'React Compiler',
+    'React Router',
+    'React Server Components',
+    'Rollup',
     'Rsbuild',
     'Rsdoctor',
     'Rslib',
+    'Rspack',
+    'Rstack',
+    'Rspack Stack',
     'Rspress',
     'Rstest',
-    'Rollup',
-    'Parcel',
+    'Solid',
+    'Server Action',
     'Vite',
-    'Module Federation',
-    'CSS Modules',
     'Web Workers',
-    'Create React App',
-    'React Router'
+    'Xcode'
 ];
 async function globMarkdownFiles(cwd) {
     return glob([
@@ -2951,6 +2965,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+/);
@@ -2966,20 +2981,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(`${picocolors_default().green('Formatted')} ${picocolors_default().dim(filePath)}`);
+        logger.success(`[heading-case] formatted: ${picocolors_default().dim(filePath)}`);
     }
     return isChanged;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "heading-case",
-  "version": "0.0.1",
+  "version": "0.1.1",
   "repository": "https://github.com/rspack-contrib/heading-case",
   "license": "MIT",
   "type": "module",