@entro314labs/markdownfix 0.0.10 → 0.0.11

package/ESLINT_INTEGRATION.md

@@ -46,12 +46,35 @@ While remark-lint handles markdown syntax and formatting, ESLint adds:
 
 ## Installation
 
-Already installed in this project:
+### Local Installation (Project-specific)
 
 ```bash
 pnpm add -D eslint eslint-plugin-mdx eslint-plugin-react
 ```
 
+### Global Installation (Recommended)
+
+Install `markdownfix` globally to use across all projects:
+
+```bash
+npm install -g @entro314labs/markdownfix
+# or
+pnpm add -g @entro314labs/markdownfix
+```
+
+Then use anywhere:
+
+```bash
+cd your-project
+mdfix nuclear
+```
+
+The tool will:
+
+- ✅ Use your local `eslint.config.js` if it exists
+- ✅ Fall back to bundled ESLint config if not found
+- ✅ Always respect your local `.remarkrc.js` if present
+
 ## Configuration Files
 
 ### [eslint.config.js](./eslint.config.js)
@@ -63,6 +86,12 @@ ESLint 9 flat config that:
 - Enables code block linting
 - Defines globals for documentation examples
 
+**Note:** When `markdownfix` is installed globally and run in a project:
+
+- ✅ Uses local `eslint.config.js` if it exists
+- ✅ Falls back to bundled config if not found
+- ℹ️ Shows a message when using bundled config
+
 ### [.remarkrc.js](./.remarkrc.js)
 
 Existing remark configuration with 40+ lint rules. This is **automatically used** by ESLint via the `mdx/remark` rule.
@@ -135,6 +164,7 @@ pnpm test
 ```
 
 This runs `process:safe` which:
+
 1. Checks formatting (no writes)
 2. Runs remark-lint
 3. Runs ESLint
@@ -194,6 +224,7 @@ See [.remarkrc.js](./.remarkrc.js) for full configuration.
 ### Catching Code Block Issues
 
 **Before:**
+
 ```javascript
 function example() {
   var unused = "bad";
@@ -202,10 +233,12 @@ function example() {
 ```
 
 **ESLint warnings:**
+
 - `no-var`: Unexpected var, use let or const instead
 - `no-unused-vars`: 'unused' is assigned but never used
 
 **After:**
+
 ```javascript
 function greet(name) {
   return `Hello ${name}`;
@@ -217,6 +250,7 @@ console.log(greet("World"));
 ### Markdown Issues (remark-lint)
 
 **Before:**
+
 ```markdown
 #No Space After Hash
 - item 1
@@ -225,10 +259,12 @@ console.log(greet("World"));
 ```
 
 **Remark-lint errors:**
+
 - Headings must have space after `#`
 - List items need blank lines between them
 
 **After:**
+
 ```markdown
 # Proper Heading
 
@@ -246,6 +282,7 @@ Files are ignored via:
 2. **Remark** - [.remarkignore](./.remarkignore)
 
 Common ignored files:
+
 - `README.md`
 - `CHANGELOG.md`
 - `LICENSE`

package/README.md

@@ -138,12 +138,14 @@ This is a warning message!
 ```
 
 **Perfect for:**
+
 - Nuxt Content projects
 - Component-driven documentation
 - Interactive markdown content
 - Vue.js documentation sites
 
 **File Usage:**
+
 - `.mdc` extension - Dedicated MDC files (like `.mdx` for JSX)
 - MDC syntax also works in `.md` and `.mdx` files
 
@@ -337,6 +339,34 @@ Central configuration defining:
 4. Lint presets + rules
 5. `remark-stringify` - Must be last
 
+### `eslint.config.js` (Optional)
+
+When using ESLint integration for MDX/code blocks:
+
+**Global Installation Behavior:**
+
+- ✅ Uses your local `eslint.config.js` if it exists
+- ✅ Falls back to bundled config if not found
+- ℹ️ Shows message: "Using bundled ESLint config"
+
+**Custom Configuration:**
+
+Create `eslint.config.js` in your project to override defaults:
+
+```javascript
+import * as mdxPlugin from 'eslint-plugin-mdx';
+
+export default [
+  {
+    files: ['**/*.{md,mdx,mdc,mdd}'],
+    ...mdxPlugin.flat,
+    // Your custom rules here
+  }
+];
+```
+
+See [ESLINT\_INTEGRATION.md](ESLINT_INTEGRATION.md) for full details.
+
 ### `.remarkignore`
 
 Files excluded from processing:
@@ -468,7 +498,7 @@ Desktop knowledge management application with MDD integration:
 ## Documentation
 
 - **[content/guides/style-guide.md](content/guides/style-guide.md)** - Style specifications
-- **[ESLINT_INTEGRATION.md](ESLINT_INTEGRATION.md)** - ESLint + MDX integration guide
+- **[ESLINT\_INTEGRATION.md](ESLINT_INTEGRATION.md)** - ESLint + MDX integration guide
 
 ## Tech Stack
 

package/cli.js

@@ -240,11 +240,18 @@ async function runNuclearMode(files, options = {}) {
 
   // Step 3 & 4: ESLint (only if available)
   if (hasEslint) {
+    const eslintConfig = await getEslintConfigPath();
+    const configSource = eslintConfig.includes(process.cwd()) ? 'local' : 'bundled';
+
+    if (!quiet && configSource === 'bundled') {
+      console.log('  ℹ️  Using bundled ESLint config (no local config found)\n');
+    }
+
     // Step 3: ESLint auto-fix
     if (!quiet) console.log('Step 3/4: Running ESLint auto-fix...');
     try {
       const fileList = files.join(' ');
-      const eslintCmd = `npx eslint --ext .md,.mdx,.mdc,.mdd --fix ${fileList}`;
+      const eslintCmd = `npx eslint --config "${eslintConfig}" --fix ${fileList}`;
 
       try {
         execSync(eslintCmd, {
@@ -267,7 +274,7 @@ async function runNuclearMode(files, options = {}) {
     if (!quiet) console.log('Step 4/4: Running ESLint linting...');
     try {
       const fileList = files.join(' ');
-      const eslintCmd = `npx eslint --ext .md,.mdx,.mdc,.mdd ${fileList}`;
+      const eslintCmd = `npx eslint --config "${eslintConfig}" ${fileList}`;
 
       execSync(eslintCmd, {
         stdio: quiet ? 'pipe' : 'inherit',
@@ -323,6 +330,23 @@ async function checkEslintAvailable() {
   }
 }
 
+/**
+ * Get ESLint config path
+ * Returns the config from current directory if it exists, otherwise uses the bundled one
+ */
+async function getEslintConfigPath() {
+  const localConfig = path.join(process.cwd(), 'eslint.config.js');
+
+  try {
+    await fs.access(localConfig);
+    return localConfig;
+  } catch {
+    // Use bundled config from markdownfix package
+    const bundledConfig = new URL('./eslint.config.js', import.meta.url).pathname;
+    return bundledConfig;
+  }
+}
+
 /**
  * Initialize .remarkrc.js configuration
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@entro314labs/markdownfix",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Opinionated markdown formatter and linter for MD, MDX, MDC, and MDD files using Remark/Unified ecosystem",
   "type": "module",
   "repository": {
@@ -126,8 +126,8 @@
   },
   "scripts": {
     "lint": "remark . --quiet --frail",
-    "lint:eslint": "eslint --ext .md,.mdx,.mdc,.mdd .",
-    "lint:eslint:fix": "eslint --ext .md,.mdx,.mdc,.mdd --fix .",
+    "lint:eslint": "eslint --config eslint.config.js .",
+    "lint:eslint:fix": "eslint --config eslint.config.js --fix .",
     "lint:all": "pnpm run lint && pnpm run lint:eslint",
     "format": "remark . --output --quiet",
     "format:check": "remark . --quiet",