@gesslar/uglier 0.0.4 → 0.0.6

package/README.md

@@ -1,9 +1,8 @@
 # @gesslar/uglier
 
-Composable ESLint flat config blocks you can mix and match for stylistic
-linting, JSDoc enforcement, and environment presets.
+**Opinionated, composable ESLint flat config for people who like their code readable.**
 
-Uses [ESLint's flat config format](https://eslint.org/docs/latest/use/configure/configuration-files).
+A flexible ESLint configuration system built on [flat config](https://eslint.org/docs/latest/use/configure/configuration-files) that lets you mix and match stylistic rules, JSDoc enforcement, and environment presets.
 
 ## Monotribe
 
@@ -28,87 +27,78 @@ kthx
 
 \[cat.gif\]
 
-## Install
+## Quick Start
 
-### Quick Install (Recommended)
+```bash
+# Install and set up in one command
+npx @gesslar/uglier init node
 
-The easiest way to install `@gesslar/uglier` and all its dependencies:
+# Or for React projects
+npx @gesslar/uglier init react
 
-```sh
+# Or just install without config generation
 npx @gesslar/uglier
 ```
 
-This will automatically install:
+This automatically installs `@gesslar/uglier`, `eslint`, and all dependencies.
 
-- `@gesslar/uglier`
-- `eslint` (if not already installed)
-- `@stylistic/eslint-plugin`
-- `eslint-plugin-jsdoc`
-- `globals`
-
-### Manual Install
-
-If you prefer to install manually:
+## Usage
 
-```sh
-npm install --save-dev @gesslar/uglier eslint @stylistic/eslint-plugin eslint-plugin-jsdoc globals
-```
+### Generated Config
 
-### View Available Configs
+Running `init` creates an `eslint.config.js` with helpful comments:
 
-To see all available config blocks:
+```js
+import uglify from "@gesslar/uglier"
 
-```sh
-npx @gesslar/uglier --help
+export default [
+  ...uglify({
+    with: [
+      "lints-js",      // default files: ["**/*.{js,mjs,cjs}"]
+      "lints-jsdoc",   // default files: ["**/*.{js,mjs,cjs}"]
+      "node",          // default files: ["**/*.{js,mjs,cjs}"]
+    ]
+  })
+]
 ```
 
-## Usage
+### Common Scenarios
 
-### Basic Setup
+#### Node.js Project
 
 ```js
-// eslint.config.js
-import uglify from "@gesslar/uglier"
-
 export default [
   ...uglify({
-    with: ["lints-js", "lints-jsdoc"]
+    with: ["lints-js", "node"]
   })
 ]
 ```
 
-### Excluding Configs
-
-Use `without` to exclude specific configs:
+#### React Project
 
 ```js
 export default [
   ...uglify({
-    with: ["lints-js", "lints-jsdoc", "node"],
-    without: ["lints-jsdoc"]  // Remove JSDoc rules
+    with: ["lints-js", "react"]
   })
 ]
 ```
 
-### Customizing File Patterns
-
-Override file patterns for specific configs:
+#### Monorepo (Node + Web)
 
 ```js
 export default [
   ...uglify({
-    with: ["lints-js", "lints-jsdoc", "tauri"],
+    with: ["lints-js", "node", "web"],
     overrides: {
-      "lints-js": { files: ["src/**/*.js"] },
-      "tauri": { files: ["src/**/*.js"] }
+      "node": { files: ["server/**/*.js"] },
+      "web": { files: ["client/**/*.js"] }
     }
   })
 ]
 ```
 
-### Customizing Style Rules
-
-Override indent, maxLen, or specific rules:
+#### Custom Style Preferences
 
 ```js
 export default [
@@ -116,8 +106,8 @@ export default [
     with: ["lints-js"],
     overrides: {
       "lints-js": {
-        indent: 4,                    // Default: 2
-        maxLen: 120,                  // Default: 80
+        indent: 4,           // default: 2
+        maxLen: 120,         // default: 80
         overrides: {
           "@stylistic/semi": ["error", "always"]
         }
@@ -127,36 +117,77 @@ export default [
 ]
 ```
 
+#### Exclude JSDoc Requirements
+
+```js
+export default [
+  ...uglify({
+    with: ["lints-js", "lints-jsdoc", "node"],
+    without: ["lints-jsdoc"]
+  })
+]
+```
+
 ## Available Configs
 
-### Linting
+### Linting Rules
 
-- **`lints-js`** - Core stylistic rules (indent, spacing, quotes, etc.)
+- **`lints-js`** - Stylistic rules (indent, spacing, quotes, braces, etc.)
 - **`lints-jsdoc`** - JSDoc documentation requirements
 
-### Language
+### Environment Targets
 
-- **`languageOptions`** - Base ECMAScript language configuration
+- **`node`** - Node.js globals (process, Buffer, etc.)
+- **`web`** - Browser globals (window, document, etc.)
+- **`react`** - React environment (browser + React/ReactDOM)
+- **`tauri`** - Tauri apps (browser + `__TAURI__` APIs)
+- **`vscode-extension`** - VSCode extension API
 
-### Environments
+### Utilities
 
-- **`web`** - Browser globals (window, document, etc.)
-- **`node`** - Node.js globals (process, require, fetch, Headers)
-- **`tauri`** - Tauri app globals (browser + `__TAURI__`)
-- **`vscode-extension`** - VSCode extension API (acquireVsCodeApi)
+- **`languageOptions`** - ECMAScript language settings
+- **`cjs-override`** - CommonJS file handling (`.cjs`)
+- **`mjs-override`** - ES Module file handling (`.mjs`)
 
-### Module Overrides
+Run `npx @gesslar/uglier --help` to see all available configs with descriptions.
 
-- **`cjs-override`** - CommonJS file handling (.cjs files)
-- **`mjs-override`** - ES Module file handling (.mjs files)
+## Commands
 
-You can also access the config names programmatically:
+```bash
+# Install dependencies only
+npx @gesslar/uglier
 
-```js
-import {availableConfigs} from "@gesslar/uglier"
-console.log(availableConfigs)
+# Generate config for specific targets
+npx @gesslar/uglier init node
+npx @gesslar/uglier init web
+npx @gesslar/uglier init react
+npx @gesslar/uglier init node web  # Multiple targets
+
+# Show available configs
+npx @gesslar/uglier --help
+```
+
+## Manual Installation
+
+If you prefer manual control:
+
+```bash
+npm install --save-dev @gesslar/uglier eslint
 ```
 
+Note: `@stylistic/eslint-plugin`, `eslint-plugin-jsdoc`, and `globals` are bundled as dependencies.
+
+## Philosophy
+
+This config enforces:
+
+- **Readable spacing** - Blank lines between control structures
+- **Consistent style** - Double quotes, no semicolons, 2-space indent
+- **Flexible customization** - Override anything via the `overrides` option
+- **Composability** - Mix configs for different file patterns in the same project
+
+It's opinionated, but you can override any rule. The defaults just happen to be correct. 😉
+
 ## License
 
-[Unlicense](UNLICENSE.txt) - "Because you're worth it." (- someone. maybe? idfk)
+[Unlicense](https://unlicense.org/) - Public domain. Do whatever you want.

package/bin/install.js

@@ -1,16 +1,24 @@
 #!/usr/bin/env node
 
 /**
- * @file install.js - Auto-installer for @gesslar/uglier
+ * @file install.js - Auto-installer and config generator for @gesslar/uglier
  *
  * @description
  * This script can be run via `npx @gesslar/uglier` to automatically install
- * the package and all its dependencies to the current project.
+ * the package and its peer dependencies to the current project.
  *
- * It will:
+ * Commands:
+ * - npx @gesslar/uglier           - Install package and dependencies
+ * - npx @gesslar/uglier init      - Generate eslint.config.js with prompts
+ * - npx @gesslar/uglier init node - Generate eslint.config.js for Node.js
+ * - npx @gesslar/uglier --help    - Show help
+ *
+ * Installation does:
  * 1. Install @gesslar/uglier as a dev dependency
  * 2. Install eslint as a peer dependency (if not present)
- * 3. Install all required plugins as dev dependencies
+ *
+ * Note: All other dependencies (@stylistic/eslint-plugin, eslint-plugin-jsdoc, globals)
+ * are bundled with the package and don't need to be installed separately.
  */
 
 import {execSync} from "child_process"
@@ -24,13 +32,8 @@ const __dirname = dirname(__filename)
 
 const PACKAGE_NAME = "@gesslar/uglier"
 
-// Dependencies that need to be installed
-const REQUIRED_DEPS = [
-  "@stylistic/eslint-plugin",
-  "eslint-plugin-jsdoc",
-  "globals"
-]
-
+// Only peer dependencies need to be installed separately
+// (all other dependencies come bundled with the package)
 const PEER_DEPS = [
   "eslint"
 ]
@@ -52,7 +55,7 @@ function exec(cmd) {
 
 /**
  * Get available configs from the source file
- * @returns {Promise<Array<{name: string, description: string}>|null>} Available configs
+ * @returns {Promise<Array<{name: string, description: string, files: string}>|null>} Available configs
  */
 async function getAvailableConfigs() {
   try {
@@ -77,16 +80,17 @@ async function getAvailableConfigs() {
 
     const source = await uglierFile.read()
 
-    // Extract config names and their JSDoc descriptions
+    // Extract config names, descriptions, and default files
     const configs = []
     // Match individual config blocks within CONFIGS object
-    const configBlockRegex = /\/\*\*\s*\n\s*\*\s*([^\n@*]+?)\s*\n(?:\s*\*[^\n]*\n)*?\s*\*\/\s*\n\s*["']([^"']+)["']:\s*\([^)]*\)\s*=>/g
+    const configBlockRegex = /\/\*\*\s*\n\s*\*\s*([^\n@*]+?)\s*\n(?:\s*\*[^\n]*\n)*?\s*\*\/\s*\n\s*["']([^"']+)["']:\s*\([^)]*\)\s*=>\s*\{[^}]*?files\s*=\s*(\[[^\]]+\])/g
     let match
 
     while((match = configBlockRegex.exec(source)) !== null) {
       configs.push({
         name: match[2],
-        description: match[1].trim()
+        description: match[1].trim(),
+        files: match[3]
       })
     }
 
@@ -105,8 +109,10 @@ async function showHelp() {
   console.log()
   console.log("Usage:")
   console.log()
-  console.log(c`  {<B}npx @gesslar/uglier{B>}          Install package and dependencies`)
-  console.log(c`  {<B}npx @gesslar/uglier --help{B>}   Show this help`)
+  console.log(c`  {<B}npx @gesslar/uglier{B>}                Install package and dependencies`)
+  console.log(c`  {<B}npx @gesslar/uglier init{B>}           Generate eslint.config.js interactively`)
+  console.log(c`  {<B}npx @gesslar/uglier init <targets>{B>} Generate eslint.config.js with targets`)
+  console.log(c`  {<B}npx @gesslar/uglier --help{B>}         Show this help`)
   console.log()
 
   const configs = await getAvailableConfigs()
@@ -178,18 +184,9 @@ async function install() {
     }
   }
 
-  // Check required dependencies
-  for(const dep of REQUIRED_DEPS) {
-    if(!(await isInstalled(dep))) {
-      toInstall.push(dep)
-    } else {
-      console.log(c`{F070}✓{/} {<B}${dep}{B>} already installed`)
-    }
-  }
-
   // Install missing packages
   if(toInstall.length > 0) {
-    console.log(c`\n{F027} Installing:{/} ${toInstall.map(p => c`{F172}${p}{/}`).join(", ")}\n`)
+    console.log(c`\n{F027} Installing:{/} ${toInstall.map(p => c`{F172}${p}{/}`).join(", ")}`)
 
     const installCmd = `npm install -D ${toInstall.join(" ")}`
 
@@ -205,11 +202,104 @@ async function install() {
   console.log(c`https://github.com/gesslar/uglier#readme`)
 }
 
+/**
+ * Generate eslint.config.js file
+ * @param {string[]} targets - Target environments (node, web, react, etc.)
+ */
+async function generateConfig(targets = []) {
+  const configFile = new FileObject("eslint.config.js", process.cwd())
+
+  if(await configFile.exists) {
+    console.log(c`{F214}Warning:{/} {<B}eslint.config.js{B>} already exists`)
+    console.log(c`Delete it first or edit it manually`)
+
+    return
+  }
+
+  // Get available configs dynamically
+  const configs = await getAvailableConfigs()
+  const environmentTargets = configs
+    ? configs.filter(c => !c.name.startsWith("lints-") && c.name !== "languageOptions" && !c.name.endsWith("-override"))
+      .map(c => c.name)
+    : ["node", "web", "react", "tauri", "vscode-extension"]
+
+  // If no targets specified, make it interactive
+  if(targets.length === 0) {
+    console.log(c`{F027}Choose your target environments:{/}`)
+    console.log()
+    console.log(c`Available targets: ${environmentTargets.map(t => c`{F172}${t}{/}`).join(", ")}`)
+    console.log()
+    console.log(c`{F244}Example: npx @gesslar/uglier init ${environmentTargets[0] || "node"}{/}`)
+
+    return
+  }
+
+  // Validate targets
+  const validTargets = environmentTargets
+  const invalidTargets = targets.filter(t => !validTargets.includes(t))
+
+  if(invalidTargets.length > 0) {
+    console.log(c`{F214}Error:{/} Invalid targets: {F172}${invalidTargets.join(", ")}{/}`)
+    console.log(c`Valid targets: {F070}${validTargets.join(", ")}{/}`)
+
+    return
+  }
+
+  // Build the config with comments
+  const withArray = ["lints-js", "lints-jsdoc", ...targets]
+
+  // Get file patterns dynamically from source
+  const allConfigs = await getAvailableConfigs()
+  const filePatterns = {}
+
+  if(allConfigs) {
+    for(const config of allConfigs) {
+      filePatterns[config.name] = config.files
+    }
+  }
+
+  // Build the with array with comments
+  const withLines = withArray.map(target => {
+    const pattern = filePatterns[target] || "[]"
+
+    return `      "${target}", // default files: ${pattern}`
+  }).join("\n")
+
+  const configContent = `import uglify from "@gesslar/uglier"
+
+export default [
+  ...uglify({
+    with: [
+${withLines}
+    ]
+  })
+]
+`
+
+  await configFile.write(configContent)
+
+  console.log(c`{F070}✓{/} Created {<B}eslint.config.js{B>}`)
+  console.log()
+  console.log(c`{F039}Configuration includes:{/}`)
+
+  for(const target of withArray) {
+    console.log(c`  {F070}•{/} ${target}`)
+  }
+
+  console.log()
+  console.log(c`{F244}Run {<B}npx eslint .{B>} to lint your project{/}`)
+}
+
 // Parse command line arguments and run
 const args = process.argv.slice(2)
 
 if(args.includes("--help") || args.includes("-h")) {
   await showHelp()
+} else if(args[0] === "init") {
+  const targets = args.slice(1)
+
+  await install()
+  await generateConfig(targets)
 } else {
   await install()
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gesslar/uglier",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Composable ESLint flat config blocks for stylistic, JSDoc, and environment presets.",
   "type": "module",
   "main": "src/uglier.js",
@@ -25,7 +25,7 @@
     "cat.gif"
   ],
   "scripts": {
-    "submit": "npm publish --access public",
+    "submit": "npm login && npm publish --access public",
     "update": "npx npm-check-updates -u && npm install",
     "pr": "gt submit --publish --restack --ai"
   },
@@ -34,11 +34,13 @@
     "eslint": "^9.0.0"
   },
   "dependencies": {
-    "@stylistic/eslint-plugin": "^5.6.1",
-    "eslint-plugin-jsdoc": "^61.4.0",
-    "globals": "^16.5.0",
     "@gesslar/colours": "^0.0.1",
-    "@gesslar/toolkit": "^0.8.0"
+    "@gesslar/toolkit": "^1.10.0",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "eslint-plugin-jsdoc": "^61.5.0",
+    "globals": "^16.5.0"
   },
-  "devDependencies": {}
+  "devDependencies": {
+    "@gesslar/uglier": "^0.0.5"
+  }
 }

package/src/uglier.js

@@ -66,6 +66,7 @@
  * - languageOptions: Base ECMAScript language configuration
  * - web: Browser globals (window, document, etc.)
  * - node: Node.js globals (process, require, fetch, Headers)
+ * - react: React globals (browser + React, ReactDOM)
  * - tauri: Tauri app globals (browser + __TAURI__)
  * - vscode-extension: VSCode extension API (acquireVsCodeApi)
  * - cjs-override: CommonJS file handling (.cjs files)
@@ -171,7 +172,7 @@ const CONFIGS = {
         }],
         "@stylistic/quotes": ["error", "double", {
           avoidEscape: true,
-          allowTemplateLiterals: true,
+          allowTemplateLiterals: "always",
         }],
         "@stylistic/semi": ["error", "never"],
         "@stylistic/space-before-function-paren": ["error", "never"],
@@ -317,6 +318,31 @@ const CONFIGS = {
     }
   },
 
+  /**
+   * React application globals
+   * @param {object} options - Configuration options
+   * @returns {object} Config object
+   */
+  "react": (options = {}) => {
+    const {
+      files = ["src/**/*.{js,jsx,mjs,cjs}"],
+      additionalGlobals = {},
+    } = options
+
+    return {
+      name: "gesslar/uglier/react",
+      files: Array.isArray(files) ? files : [files],
+      languageOptions: {
+        globals: {
+          ...globals.browser,
+          React: "readonly",
+          ReactDOM: "readonly",
+          ...additionalGlobals,
+        }
+      }
+    }
+  },
+
   /**
    * CommonJS file override
    * @param {object} options - Configuration options