@entro314labs/markdownfix 0.0.10 → 0.0.12

package/ESLINT_INTEGRATION.md

@@ -10,6 +10,7 @@ While remark-lint handles markdown syntax and formatting, ESLint adds:
 - **IDE integration** - Better VS Code support with ESLint extension
 - **Unified error reporting** - Consistent error format across tools
 - **Code quality checks** - Catch unused variables, syntax errors in examples
+- **Built-in by default** - No extra installation needed, opinionated and ready to use
 
 ## Architecture
 
@@ -46,12 +47,40 @@ While remark-lint handles markdown syntax and formatting, ESLint adds:
 
 ## Installation
 
-Already installed in this project:
+### Global Installation (Recommended)
+
+Install `markdownfix` globally - **ESLint support is built-in**:
+
+```bash
+npm install -g @entro314labs/markdownfix
+# or
+pnpm add -g @entro314labs/markdownfix
+```
+
+Then use anywhere:
+
+```bash
+cd your-project
+mdfix nuclear
+```
+
+**ESLint is included by default:**
+
+- ✅ `eslint` and `eslint-plugin-mdx` are bundled dependencies
+- ✅ Works out of the box - no additional installation needed
+- ✅ Uses bundled config automatically
+- ✅ Override by creating local `eslint.config.js`
+
+### Local Installation (Project-specific)
 
 ```bash
-pnpm add -D eslint eslint-plugin-mdx eslint-plugin-react
+npm install -D @entro314labs/markdownfix
+# or
+pnpm add -D @entro314labs/markdownfix
 ```
 
+ESLint dependencies are included automatically.
+
 ## Configuration Files
 
 ### [eslint.config.js](./eslint.config.js)
@@ -63,6 +92,13 @@ ESLint 9 flat config that:
 - Enables code block linting
 - Defines globals for documentation examples
 
+**Note:** When `markdownfix` is installed (globally or locally):
+
+- ✅ ESLint dependencies are **always included** (opinionated approach)
+- ✅ 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 +171,7 @@ pnpm test
 ```
 
 This runs `process:safe` which:
+
 1. Checks formatting (no writes)
 2. Runs remark-lint
 3. Runs ESLint
@@ -194,6 +231,7 @@ See [.remarkrc.js](./.remarkrc.js) for full configuration.
 ### Catching Code Block Issues
 
 **Before:**
+
 ```javascript
 function example() {
   var unused = "bad";
@@ -202,10 +240,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 +257,7 @@ console.log(greet("World"));
 ### Markdown Issues (remark-lint)
 
 **Before:**
+
 ```markdown
 #No Space After Hash
 - item 1
@@ -225,10 +266,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 +289,7 @@ Files are ignored via:
 2. **Remark** - [.remarkignore](./.remarkignore)
 
 Common ignored files:
+
 - `README.md`
 - `CHANGELOG.md`
 - `LICENSE`

package/README.md

@@ -11,9 +11,10 @@ Built on the Remark ecosystem with strict, consistent formatting rules for devel
 - ✅ **MDX support** - JSX components in markdown with ESLint integration
 - ✅ **MDC syntax support** - Markdown Components for Nuxt Content
 - ✅ **Comprehensive linting** - 40+ remark-lint rules for quality and consistency
-- ✅ **Code block linting** - ESLint integration for JavaScript/JSX in code blocks
+- ✅ **Code block linting** - ESLint integration built-in for JavaScript/JSX in code blocks
 - ✅ **Link validation** - Check for broken links
 - ✅ **Auto-fixing** - Automatically fix formatting issues
+- ✅ **Zero config** - Works out of the box, customize if needed
 - ✅ **IDE integration** - Works with VS Code ESLint extension
 
 ## Installation
@@ -138,12 +139,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 +340,35 @@ Central configuration defining:
 4. Lint presets + rules
 5. `remark-stringify` - Must be last
 
+### `eslint.config.js` (Optional)
+
+ESLint is **built-in** with opinionated defaults. Customize by creating `eslint.config.js` in your project:
+
+**Default Behavior:**
+
+- ✅ ESLint and eslint-plugin-mdx are included in the package
+- ✅ Automatically uses bundled config if no local config found
+- ✅ Lints JavaScript/JSX in code blocks
+- ✅ Works out of the box globally or locally
+
+**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 +500,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

@@ -238,13 +238,20 @@ async function runNuclearMode(files, options = {}) {
     if (!quiet) console.log(`  ✗ Remark linting failed: ${error.message}\n`);
   }
 
-  // Step 3 & 4: ESLint (only if available)
+  // Step 3 & 4: ESLint (only if ESLint is available)
   if (hasEslint) {
+    const eslintConfigInfo = await getEslintConfigPath();
+    const { configPath, source } = eslintConfigInfo;
+
+    if (!quiet && source === '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 "${configPath}" --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 "${configPath}" ${fileList}`;
 
       execSync(eslintCmd, {
         stdio: quiet ? 'pipe' : 'inherit',
@@ -281,6 +288,7 @@ async function runNuclearMode(files, options = {}) {
       if (!quiet) console.log(`  ⚠️  ESLint linting found issues\n`);
     }
   } else {
+    // ESLint not installed
     if (!quiet) {
       console.log('Step 3/4: Skipping ESLint (not installed)');
       console.log('  ℹ️  Install ESLint with: npm install -D eslint eslint-plugin-mdx\n');
@@ -324,6 +332,23 @@ async function checkEslintAvailable() {
 }
 
 /**
+ * Get ESLint config path
+ * Returns local config if it exists, otherwise uses bundled config
+ * Since ESLint dependencies are included in the package, bundled config always works
+ */
+async function getEslintConfigPath() {
+  const localConfig = path.join(process.cwd(), 'eslint.config.js');
+
+  try {
+    await fs.access(localConfig);
+    // Local config exists - use it
+    return { configPath: localConfig, source: 'local' };
+  } catch {
+    // Use bundled config - dependencies are always available
+    const bundledConfig = new URL('./eslint.config.js', import.meta.url).pathname;
+    return { configPath: bundledConfig, source: 'bundled' };
+  }
+}/**
  * Initialize .remarkrc.js configuration
  */
 async function initConfig() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@entro314labs/markdownfix",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "description": "Opinionated markdown formatter and linter for MD, MDX, MDC, and MDD files using Remark/Unified ecosystem",
   "type": "module",
   "repository": {
@@ -45,9 +45,6 @@
   "author": "Dominikos Pritis",
   "license": "MIT",
   "devDependencies": {
-    "eslint": "^9.38.0",
-    "eslint-plugin-mdx": "^3.6.2",
-    "eslint-plugin-react": "^7.37.5",
     "markdown-link-check": "^3.14.1",
     "remark-cli": "^12.0.1"
   },
@@ -59,6 +56,9 @@
     "@code-dot-org/remark-plugins": "^2.0.0",
     "@entro314labs/remark-mdd": "^0.0.10",
     "@theguild/remark-mermaid": "^0.3.0",
+    "eslint": "^9.38.0",
+    "eslint-plugin-mdx": "^3.6.2",
+    "eslint-plugin-react": "^7.37.5",
     "fumadocs-docgen": "^3.0.2",
     "glob": "^11.0.3",
     "js-yaml": "^4.1.0",
@@ -117,7 +117,7 @@
     "remark-rehype": "^11.1.2",
     "remark-stringify": "^11.0.0",
     "remark-toc": "^9.0.0",
-    "remark-typography": "^0.6.36",
+    "remark-typography": "^0.7.0",
     "remark-validate-links": "^13.1.0",
     "to-vfile": "^8.0.0",
     "unified-lint-rule": "^3.0.1",
@@ -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",