@gesslar/uglier 1.6.2 → 2.0.1

package/README.md

@@ -47,7 +47,10 @@ npx @gesslar/uglier add react
 
 This automatically installs `@gesslar/uglier`, `eslint`, and all dependencies.
 
-**Package Manager Support:** Automatically detects and uses your preferred package manager (npm, pnpm, yarn, or Bun). Use `pnpx`, `yarn dlx`, or `bunx` instead of `npx` - the installer will detect your choice and install packages accordingly.
+**Package Manager Support:** Automatically detects and uses your preferred
+package manager (npm, pnpm, yarn, or Bun). Use `pnpx`, `yarn dlx`, or `bunx`
+instead of `npx` - the installer will detect your choice and install packages
+accordingly.
 
 ## Usage
 
@@ -61,9 +64,9 @@ import uglify from "@gesslar/uglier"
 export default [
   ...uglify({
     with: [
-      "lints-js",      // default files: ["**/*.{js,mjs,cjs}"]
-      "lints-jsdoc",   // default files: ["**/*.{js,mjs,cjs}"]
-      "node",          // default files: ["**/*.{js,mjs,cjs}"]
+      "lints-js",      // default files: ["src/**/*.{js,mjs,cjs}"]
+      "lints-jsdoc",   // default files: ["src/**/*.{js,mjs,cjs}"]
+      "node",          // default files: ["src/**/*.{js,mjs,cjs}"]
     ]
   })
 ]
@@ -97,7 +100,7 @@ export default [
 export default [
   ...uglify({
     with: ["lints-js", "node", "web"],
-    overrides: {
+    options: {
       "node": { files: ["server/**/*.js"] },
       "web": { files: ["client/**/*.js"] }
     }
@@ -111,7 +114,7 @@ export default [
 export default [
   ...uglify({
     with: ["lints-js"],
-    overrides: {
+    options: {
       "lints-js": {
         indent: 4,           // default: 2
         maxLen: 120,         // default: 80
@@ -156,7 +159,8 @@ export default [
 - **`cjs-override`** - CommonJS file handling (`.cjs`)
 - **`mjs-override`** - ES Module file handling (`.mjs`)
 
-Run `npx @gesslar/uglier --help` to see all available configs with descriptions.
+Run `npx @gesslar/uglier --help` to see all available configs with
+descriptions.
 
 ## Commands
 
@@ -177,7 +181,7 @@ npx @gesslar/uglier add tauri vscode-extension  # Multiple targets
 # Remove config blocks from existing eslint.config.js
 npx @gesslar/uglier remove react
 npx @gesslar/uglier remove web tauri  # Multiple targets
-# Note: Also removes any overrides for removed targets
+# Note: Also removes any options for removed targets
 
 # Show available configs
 npx @gesslar/uglier --help
@@ -206,7 +210,8 @@ yarn add -D @gesslar/uglier eslint
 bun add -d @gesslar/uglier eslint
 ```
 
-Note: `@stylistic/eslint-plugin`, `eslint-plugin-jsdoc`, and `globals` are bundled as dependencies.
+Note: `@stylistic/eslint-plugin`, `eslint-plugin-jsdoc`, and `globals` are
+bundled as dependencies.
 
 ## Development
 
@@ -227,11 +232,38 @@ 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
+- **Flexible customization** - Override anything via the `options` key
+- **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. 😉
+It's opinionated, but you can override any rule. The defaults just happen to be
+correct. 😉
+
+## Post Chips Ahoy
+
+If you love code and want to support it, you should write code or hug a coder,
+but maybe not physically, just emotionally, because they're busy, or instead of
+telling the coder to go out and touch grass, maybe go out and touch the grass
+for them and then come back and not tell them about it because first, charity
+for charity's sake is its own reward and how dare you to try to cash in on your
+good deeds when the entire point of doing the good deed is ... ok so, if you're
+_not_ a coder, this is called recursion; but the better reason is, as stated,
+they're busy. So, thanks. At the very least you can put it in Workday and claim
+it, you good-deed profiteer.
 
 ## License
 
-[Unlicense](https://unlicense.org/) - Public domain. Do whatever you want.
+uglier is released into the public domain under the
+[Unlicense](UNLICENSE.txt).
+
+This package includes or depends on third-party components under their own
+licenses:
+
+| Dependency | License |
+| --- | --- |
+| [@gesslar/colours](https://github.com/gesslar/colours) | Unlicense |
+| [@gesslar/toolkit](https://github.com/gesslar/toolkit) | Unlicense |
+| [@skarab/detect-package-manager](https://github.com/skarab42/detect-package-manager) | MIT |
+| [@stylistic/eslint-plugin](https://github.com/eslint-stylistic/eslint-stylistic) | MIT |
+| [eslint-plugin-jsdoc](https://github.com/gajus/eslint-plugin-jsdoc) | BSD-3-Clause |
+| [globals](https://github.com/sindresorhus/globals) | MIT |

package/bin/cli.js

@@ -117,15 +117,13 @@ export async function getAvailableConfigs() {
 
     let uglierFile = null
 
-    if(await localSource.exists) {
+    if(await localSource.exists)
       uglierFile = localSource
-    } else if(await installedSource.exists) {
+    else if(await installedSource.exists)
       uglierFile = installedSource
-    }
 
-    if(!uglierFile) {
+    if(!uglierFile)
       return null
-    }
 
     const source = await uglierFile.read()
 
@@ -162,6 +160,7 @@ export async function install() {
 
   console.log(c`{F244}Using package manager: ${manager}{/}`)
   console.log(c`{F244}Running: ${fullCmd}{/}`)
+
   exec(fullCmd)
 
   console.log()
@@ -395,7 +394,7 @@ export async function addToConfig(targets = []) {
  * Remove config blocks from existing eslint.config.js
  *
  * @param {Array<string>} targets - Target environments to remove (node, web, react, etc.)
- * @returns {Promise<{success: boolean, removedTargets: Array<string>, removedOverrides: Array<string>}>} Result info
+ * @returns {Promise<{success: boolean, removedTargets: Array<string>, removedOptions: Array<string>}>} Result info
  */
 export async function removeFromConfig(targets = []) {
   const cwd = DirectoryObject.fromCwd()
@@ -405,7 +404,7 @@ export async function removeFromConfig(targets = []) {
     console.log(c`{F214}Error:{/} {<B}eslint.config.js{B>} not found`)
     console.log(c`Use {<B}npx @gesslar/uglier init <targets>{B>} to create one first`)
 
-    return {success: false, removedTargets: [], removedOverrides: []}
+    return {success: false, removedTargets: [], removedOptions: []}
   }
 
   // Get available configs dynamically
@@ -423,7 +422,7 @@ export async function removeFromConfig(targets = []) {
     console.log()
     console.log(c`{F244}Example: npx @gesslar/uglier remove react{/}`)
 
-    return {success: false, removedTargets: [], removedOverrides: []}
+    return {success: false, removedTargets: [], removedOptions: []}
   }
 
   // Read existing config
@@ -436,7 +435,7 @@ export async function removeFromConfig(targets = []) {
     console.log(c`{F214}Error:{/} Could not parse existing config`)
     console.log(c`The config file may have a non-standard format`)
 
-    return {success: false, removedTargets: [], removedOverrides: []}
+    return {success: false, removedTargets: [], removedOptions: []}
   }
 
   // Find which targets exist and can be removed
@@ -452,7 +451,7 @@ export async function removeFromConfig(targets = []) {
     console.log()
     console.log(c`Current targets: ${existingTargets.map(t => c`{F070}${t}{/}`).join(", ")}`)
 
-    return {success: false, removedTargets: [], removedOverrides: []}
+    return {success: false, removedTargets: [], removedOptions: []}
   }
 
   // Build new with array content without the removed targets
@@ -489,11 +488,11 @@ export async function removeFromConfig(targets = []) {
     `with: [\n${newLines.join("\n")}\n    ]`
   )
 
-  // Check for and remove overrides for removed targets
-  const removedOverrides = []
-  const overridesMatch = newContent.match(/overrides:\s*\{/m)
+  // Check for and remove options for removed targets
+  const removedOptions = []
+  const optionsMatch = newContent.match(/options:\s*\{/m)
 
-  if(overridesMatch) {
+  if(optionsMatch) {
     for(const target of targetsToRemove) {
       // Find the start of this target's override entry
       const targetPattern = new RegExp(`[\\s,]*(?:\\/\\/[^\\n]*\\n\\s*)?["']${target}["']:\\s*\\{`)
@@ -525,7 +524,7 @@ export async function removeFromConfig(targets = []) {
         }
 
         if(blockEnd !== -1) {
-          removedOverrides.push(target)
+        removedOptions.push(target)
           newContent = newContent.slice(0, blockStart)
             + newContent.slice(blockEnd)
         }
@@ -537,9 +536,9 @@ export async function removeFromConfig(targets = []) {
       /\}(\s*["'][\w-]+["']:\s*\{)/g, "},$1"
     )
 
-    // Clean up empty overrides object or trailing commas
+    // Clean up empty options object or trailing commas
     newContent = newContent.replace(
-      /overrides:\s*\{\s*,?\s*\}/m, ""
+      /options:\s*\{\s*,?\s*\}/m, ""
     )
     newContent = newContent.replace(/,(\s*)\}/g, "$1}")
   }
@@ -554,11 +553,11 @@ export async function removeFromConfig(targets = []) {
     console.log(c`  {F070}•{/} ${target}`)
   }
 
-  if(removedOverrides.length > 0) {
+  if(removedOptions.length > 0) {
     console.log()
-    console.log(c`{F039}Also removed overrides for:{/}`)
+    console.log(c`{F039}Also removed options for:{/}`)
 
-    for(const target of removedOverrides) {
+    for(const target of removedOptions) {
       console.log(c`  {F070}•{/} ${target}`)
     }
   }
@@ -568,7 +567,7 @@ export async function removeFromConfig(targets = []) {
   console.log()
   console.log(c`{F244}Run {<B}${eslintCmd}{B>} to lint your project{/}`)
 
-  return {success: true, removedTargets: targetsToRemove, removedOverrides}
+  return {success: true, removedTargets: targetsToRemove, removedOptions}
 }
 
 /**

package/package.json

@@ -5,7 +5,7 @@
     "name": "gesslar",
     "url": "https://gesslar.dev"
   },
-  "version": "1.6.2",
+  "version": "2.0.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/gesslar/uglier.git"
@@ -49,14 +49,14 @@
   },
   "dependencies": {
     "@gesslar/colours": ">=0.8.0",
-    "@gesslar/toolkit": ">=3.37.0",
+    "@gesslar/toolkit": ">=4.1.0",
     "@skarab/detect-package-manager": ">=1.0.0",
-    "@stylistic/eslint-plugin": "^5.9.0",
-    "eslint-plugin-jsdoc": ">=62.6.1",
-    "globals": ">=17.3.0"
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint-plugin-jsdoc": ">=62.7.1",
+    "globals": ">=17.4.0"
   },
   "devDependencies": {
-    "@gesslar/uglier": ">=1.4.1",
-    "eslint": ">=10.0.0"
+    "@gesslar/uglier": ">=2.0.0",
+    "eslint": ">=10.0.3"
   }
 }

package/src/uglier.js

@@ -23,7 +23,7 @@
  * export default [
  *   ...uglify({
  *     with: ["lints-js", "lints-jsdoc", "tauri"],
- *     overrides: {
+ *     options: {
  *       "lints-js": { files: ["src/**\/*.js"] },
  *       "tauri": { files: ["src/**\/*.js"] }
  *     }
@@ -48,7 +48,7 @@
  * export default [
  *   ...uglify({
  *     with: ["lints-js"],
- *     overrides: {
+ *     options: {
  *       "lints-js": {
  *         indent: 4,
  *         maxLen: 120,
@@ -93,7 +93,8 @@ const CONFIGS = {
    */
   "lints-js": (options = {}) => {
     const {
-      files = ["**/*.{js,mjs,cjs}"],
+      files = ["src/**/*.{js,mjs,cjs}"],
+      ignores = [],
       indent = 2,
       maxLen = 80,
       overrides = {},
@@ -102,6 +103,7 @@ const CONFIGS = {
     return {
       name: "gesslar/uglier/lints-js",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       plugins: {
         "@stylistic": stylistic,
       },
@@ -206,13 +208,15 @@ const CONFIGS = {
    */
   "lints-jsdoc": (options = {}) => {
     const {
-      files = ["**/*.{js,mjs,cjs}"],
+      files = ["src/**/*.{js,mjs,cjs}"],
+      ignores = [],
       overrides = {},
     } = options
 
     return {
       name: "gesslar/uglier/lints-jsdoc",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       plugins: {
         jsdoc,
       },
@@ -269,12 +273,14 @@ const CONFIGS = {
   "web": (options = {}) => {
     const {
       files = ["src/**/*.{js,mjs,cjs}"],
+      ignores = [],
       additionalGlobals = {},
     } = options
 
     return {
       name: "gesslar/uglier/web",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       languageOptions: {
         globals: {
           ...globals.browser,
@@ -293,12 +299,14 @@ const CONFIGS = {
   "vscode-extension": (options = {}) => {
     const {
       files = ["src/**/*.{js,mjs,cjs}"],
+      ignores = [],
       additionalGlobals = {},
     } = options
 
     return {
       name: "gesslar/uglier/vscode-extension",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       languageOptions: {
         globals: {
           acquireVsCodeApi: "readonly",
@@ -316,13 +324,15 @@ const CONFIGS = {
    */
   "node": (options = {}) => {
     const {
-      files = ["**/*.{js,mjs,cjs}"],
+      files = ["src/**/*.{js,mjs,cjs}"],
+      ignores = [],
       additionalGlobals = {},
     } = options
 
     return {
       name: "gesslar/uglier/node",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       languageOptions: {
         globals: {
           ...globals.node,
@@ -343,12 +353,14 @@ const CONFIGS = {
   "react": (options = {}) => {
     const {
       files = ["src/**/*.{js,jsx,mjs,cjs}"],
+      ignores = [],
       additionalGlobals = {},
     } = options
 
     return {
       name: "gesslar/uglier/react",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       languageOptions: {
         globals: {
           ...globals.browser,
@@ -369,11 +381,13 @@ const CONFIGS = {
   "cjs-override": (options = {}) => {
     const {
       files = ["**/*.cjs"],
+      ignores = [],
     } = options
 
     return {
       name: "gesslar/uglier/cjs-override",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       languageOptions: {
         sourceType: "script",
         ecmaVersion: 2021
@@ -390,11 +404,13 @@ const CONFIGS = {
   "mjs-override": (options = {}) => {
     const {
       files = ["**/*.mjs"],
+      ignores = [],
     } = options
 
     return {
       name: "gesslar/uglier/mjs-override",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       languageOptions: {
         sourceType: "module",
         ecmaVersion: 2021
@@ -411,12 +427,14 @@ const CONFIGS = {
   "tauri": (options = {}) => {
     const {
       files = ["src/**/*.{js,mjs,cjs}"],
+      ignores = [],
       additionalGlobals = {},
     } = options
 
     return {
       name: "gesslar/uglier/tauri",
       files: Array.isArray(files) ? files : [files],
+      ignores: Array.isArray(ignores) ? ignores : [ignores],
       languageOptions: {
         globals: {
           ...globals.browser,
@@ -435,14 +453,14 @@ const CONFIGS = {
  * @param {object} options - Composition options
  * @param {string[]} [options.with] - Config names to include
  * @param {string[]} [options.without] - Config names to exclude (higher precedence)
- * @param {object} [options.overrides] - Per-config options overrides
+ * @param {object} [options.options] - Per-config options
  * @returns {Array} ESLint flat config array
  */
 export default function(options = {}) {
   const {
     with: includeConfigs = ["lints-js", "lints-jsdoc"],
     without: excludeConfigs = [],
-    overrides = {},
+    options: perConfigOptions = {},
   } = options
 
   const configs = []
@@ -458,7 +476,7 @@ export default function(options = {}) {
       )
     }
 
-    const configOptions = overrides[configName] || {}
+    const configOptions = perConfigOptions[configName] || {}
     const config = CONFIGS[configName](configOptions)
 
     configs.push(config)