@entro314labs/markdownfix 0.0.11 → 0.0.13

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,15 +47,9 @@ While remark-lint handles markdown syntax and formatting, ESLint adds:
 
 ## Installation
 
-### 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:
+Install `markdownfix` globally - **ESLint support is built-in**:
 
 ```bash
 npm install -g @entro314labs/markdownfix
@@ -69,11 +64,22 @@ cd your-project
 mdfix nuclear
 ```
 
-The tool will:
+**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
+npm install -D @entro314labs/markdownfix
+# or
+pnpm add -D @entro314labs/markdownfix
+```
 
-- ✅ 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
+ESLint dependencies are included automatically.
 
 ## Configuration Files
 
@@ -86,8 +92,9 @@ 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:
+**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

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
@@ -341,13 +342,14 @@ Central configuration defining:
 
 ### `eslint.config.js` (Optional)
 
-When using ESLint integration for MDX/code blocks:
+ESLint is **built-in** with opinionated defaults. Customize by creating `eslint.config.js` in your project:
 
-**Global Installation Behavior:**
+**Default Behavior:**
 
-- ✅ Uses your local `eslint.config.js` if it exists
-- ✅ Falls back to bundled config if not found
-- ℹ️ Shows message: "Using bundled ESLint config"
+- ✅ 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:**
 

package/cli.js

@@ -238,20 +238,21 @@ 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 eslintConfig = await getEslintConfigPath();
-    const configSource = eslintConfig.includes(process.cwd()) ? 'local' : 'bundled';
+    const eslintConfigInfo = await getEslintConfigPath();
+    const { configPath, source } = eslintConfigInfo;
 
-    if (!quiet && configSource === 'bundled') {
+    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 --config "${eslintConfig}" --fix ${fileList}`;
+      // Quote each file path to handle spaces and special characters
+      const fileList = files.map(f => `"${f}"`).join(' ');
+      const eslintCmd = `npx eslint --config "${configPath}" --fix ${fileList}`;
 
       try {
         execSync(eslintCmd, {
@@ -273,8 +274,9 @@ async function runNuclearMode(files, options = {}) {
     // Step 4: ESLint linting
     if (!quiet) console.log('Step 4/4: Running ESLint linting...');
     try {
-      const fileList = files.join(' ');
-      const eslintCmd = `npx eslint --config "${eslintConfig}" ${fileList}`;
+      // Quote each file path to handle spaces and special characters
+      const fileList = files.map(f => `"${f}"`).join(' ');
+      const eslintCmd = `npx eslint --config "${configPath}" ${fileList}`;
 
       execSync(eslintCmd, {
         stdio: quiet ? 'pipe' : 'inherit',
@@ -288,6 +290,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');
@@ -332,22 +335,22 @@ async function checkEslintAvailable() {
 
 /**
  * Get ESLint config path
- * Returns the config from current directory if it exists, otherwise uses the bundled one
+ * 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);
-    return localConfig;
+    // Local config exists - use it
+    return { configPath: localConfig, source: 'local' };
   } catch {
-    // Use bundled config from markdownfix package
+    // Use bundled config - dependencies are always available
     const bundledConfig = new URL('./eslint.config.js', import.meta.url).pathname;
-    return bundledConfig;
+    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.11",
+  "version": "0.0.13",
   "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",