@vinsonchuong/xo_d 1.1.2 → 1.2.0

package/cli.test.mjs

@@ -12,16 +12,18 @@ async function cli(args, {cwd, stdin}) {
     child.stdin.end(stdin)
   }
 
-  const [exitCode, stdout] = await Promise.all([
+  const [exitCode, stdout, stderr] = await Promise.all([
     new Promise((resolve) => {
       child.on('exit', resolve)
     }),
     getStream(child.stdout),
+    getStream(child.stderr),
   ])
 
   return {
     exitCode,
     stdout,
+    stderr,
   }
 }
 
@@ -45,7 +47,7 @@ test.serial('fix option', async (t) => {
 
 test.serial('fix option with stdin', async (t) => {
   const directory = await useTemporaryDirectory(t)
-  const {stdout} = await cli(['--fix', '--stdin'], {
+  const {stdout} = await cli(['--fix', '--stdin', '--stdin-filename=fix.js'], {
     cwd: directory.path,
     stdin: 'console.log()',
   })

package/client.mjs

@@ -1,12 +1,18 @@
 import process from 'node:process'
+import fs from 'node:fs/promises'
 import {createRequire} from 'node:module'
+import path from 'node:path'
 import getStdin from 'get-stdin'
+import {pathExists} from 'path-exists'
+import findCacheDirectory from 'find-cache-directory'
 import meow from 'meow'
-import semver from 'semver'
+
+const cacheDirName = 'xo-linter'
+const tsExtensions = new Set(['ts', 'tsx', 'cts', 'mts'])
 
 const require = createRequire(import.meta.url)
 
-export default async function () {
+export default async function run() {
   process.env.CORE_D_TITLE = 'xo_d'
   process.env.CORE_D_DOTFILE = '.xo_d'
   process.env.CORE_D_SERVICE = require.resolve('./server.js')
@@ -21,50 +27,32 @@ export default async function () {
   ) {
     coreD[xoDCommand]()
   } else {
-    const {
-      input,
-      flags: options,
-      showVersion,
-    } = meow(
+    const cli = meow(
       `
-      Usage
-      $ xo_d [<file|glob> ...]
-      $ xo_d [start|stop|status]
-
-      Options
-      --fix             Automagically fix issues
-      --reporter        Reporter to use
-      --env             Environment preset  [Can be set multiple times]
-      --global          Global variable  [Can be set multiple times]
-      --ignore          Additional paths to ignore  [Can be set multiple times]
-      --space           Use space indent instead of tabs  [Default: 2]
-      --no-semicolon    Prevent use of semicolons
-      --prettier        Conform to Prettier code style
-      --node-version    Range of Node.js version to support
-      --plugin          Include third-party plugins  [Can be set multiple times]
-      --extend          Extend defaults with a custom config  [Can be set multiple times]
-      --open            Open files with issues in your editor
-      --quiet           Show only errors and no warnings
-      --extension       Additional extension to lint [Can be set multiple times]
-      --cwd=<dir>       Working directory for files
-      --stdin           Validate/fix code from stdin
-      --stdin-filename  Specify a filename for the --stdin option
-      --print-config    Print the effective ESLint config for the given file
-
-      Examples
-      $ xo
-      $ xo index.js
-      $ xo *.js !foo.js
-      $ xo --space
-      $ xo --env=node --env=mocha
-      $ xo --plugin=react
-      $ xo --plugin=html --extension=html
-      $ echo 'const x=true' | xo --stdin --fix
-      $ xo --print-config=index.js
-
-      Tips
-      - Add XO to your project with \`npm init xo\`.
-      - Put options in package.json instead of using flags so other tools can read it.
+        Usage
+          $ xo_d [<file|glob> ...]
+          $ xo_d [start|stop|status]
+
+        Options
+          --fix             Automagically fix issues
+          --reporter        Reporter to use
+          --space           Use space indent instead of tabs [Default: 2]
+          --config          Path to a XO configuration file
+          --semicolon       Use semicolons [Default: true]
+          --react           Include React specific parsing and xo-react linting rules [Default: false]
+          --prettier        Format with prettier or turn off prettier conflicted rules when set to 'compat' [Default: false]
+          --version         Print XO version
+          --quiet           Show only errors and no warnings
+          --stdin           Validate/fix code from stdin
+          --stdin-filename  Specify a filename for the --stdin option
+          --ignore          Ignore pattern globs, can be set multiple times
+          --cwd=<dir>       Working directory for files [Default: process.cwd()]
+
+        Examples
+          $ xo
+          $ xo index.js
+          $ xo *.js !foo.js
+          $ xo --space
       `,
       {
         importMeta: import.meta,
@@ -73,24 +61,19 @@ export default async function () {
         flags: {
           fix: {
             type: 'boolean',
+            default: false,
           },
           reporter: {
             type: 'string',
           },
-          env: {
-            type: 'string',
-            isMultiple: true,
-          },
-          global: {
+          space: {
             type: 'string',
-            isMultiple: true,
           },
-          ignore: {
+          config: {
             type: 'string',
-            isMultiple: true,
           },
-          space: {
-            type: 'string',
+          quiet: {
+            type: 'boolean',
           },
           semicolon: {
             type: 'boolean',
@@ -98,124 +81,151 @@ export default async function () {
           prettier: {
             type: 'boolean',
           },
-          nodeVersion: {
-            type: 'string',
-          },
-          plugin: {
-            type: 'string',
-            isMultiple: true,
+          react: {
+            type: 'boolean',
+            default: false,
           },
-          extend: {
+          cwd: {
             type: 'string',
-            isMultiple: true,
+            default: process.cwd(),
           },
-          open: {
+          version: {
             type: 'boolean',
           },
-          quiet: {
+          stdin: {
             type: 'boolean',
           },
-          extension: {
-            type: 'string',
-            isMultiple: true,
-          },
-          cwd: {
-            type: 'string',
-          },
-          printConfig: {
+          stdinFilename: {
             type: 'string',
+            default: 'stdin.js',
           },
-          stdin: {
+          open: {
             type: 'boolean',
           },
-          stdinFilename: {
+          ignore: {
             type: 'string',
+            isMultiple: true,
+            aliases: ['ignores'],
           },
         },
       },
     )
 
-    for (const key in options) {
-      if (Array.isArray(options[key]) && options[key].length === 0) {
-        delete options[key]
-      }
+    const {input, flags: cliOptions, showVersion} = cli
+
+    const baseXoConfigOptions = {
+      space: cliOptions.space,
+      semicolon: cliOptions.semicolon,
+      prettier: cliOptions.prettier,
+      ignores: cliOptions.ignore,
+      react: cliOptions.react,
+    }
+
+    const linterOptions = {
+      fix: cliOptions.fix,
+      cwd: (cliOptions.cwd && path.resolve(cliOptions.cwd)) ?? process.cwd(),
+      quiet: cliOptions.quiet,
+      ts: true,
     }
 
-    if (typeof options.space === 'string') {
-      if (/^\d+$/u.test(options.space)) {
-        options.space = Number.parseInt(options.space, 10)
-      } else if (options.space === 'true') {
-        options.space = true
-      } else if (options.space === 'false') {
-        options.space = false
+    // Make data types for `options.space` match those of the API
+    if (typeof cliOptions.space === 'string') {
+      cliOptions.space = cliOptions.space.trim()
+
+      if (/^\d+$/u.test(cliOptions.space)) {
+        baseXoConfigOptions.space = Number.parseInt(cliOptions.space, 10)
+      } else if (cliOptions.space === 'true') {
+        baseXoConfigOptions.space = true
+      } else if (cliOptions.space === 'false') {
+        baseXoConfigOptions.space = false
       } else {
-        if (options.space !== '') {
-          input.push(options.space)
+        if (cliOptions.space !== '') {
+          // Assume `options.space` was set to a filename when run as `xo --space file.js`
+          input.push(cliOptions.space)
         }
 
-        options.space = true
+        baseXoConfigOptions.space = true
       }
     }
 
-    if (process.env.GITHUB_ACTIONS && !options.fix && !options.reporter) {
-      options.quiet = true
-    }
-
-    if (input[0] === '-') {
-      options.stdin = true
-      input.shift()
+    if (
+      process.env.GITHUB_ACTIONS &&
+      !linterOptions.fix &&
+      !cliOptions.reporter
+    ) {
+      linterOptions.quiet = true
     }
 
-    if (options.version) {
+    if (cliOptions.version) {
       showVersion()
     }
 
-    if (options.nodeVersion) {
-      if (options.nodeVersion === 'false') {
-        options.nodeVersion = false
-      } else if (!semver.validRange(options.nodeVersion)) {
-        console.error(
-          'The `--node-engine` flag must be a valid semver range (for example `>=6`)',
-        )
-        process.exit(1)
-      }
-    }
+    if (cliOptions.stdin) {
+      const stdin = await getStdin()
 
-    if (typeof options.printConfig === 'string') {
-      if (input.length > 0 || options.printConfig === '') {
-        console.error(
-          'The `--print-config` flag must be used with exactly one filename',
+      let shouldRemoveStdInFile = false
+
+      // For TypeScript, we need a file on the filesystem to lint it or else @typescript-eslint will blow up.
+      // We create a temporary file in the node_modules/.cache/xo-linter directory to avoid conflicts with the user's files and lint that file as if it were the stdin input as a work around.
+      // We clean up the file after linting.
+      if (
+        cliOptions.stdinFilename &&
+        tsExtensions.has(path.extname(cliOptions.stdinFilename).slice(1))
+      ) {
+        const absoluteFilePath = path.resolve(
+          cliOptions.cwd,
+          cliOptions.stdinFilename,
         )
-        process.exit(1)
-      }
-
-      if (options.stdin) {
-        console.error('The `--print-config` flag is not supported on stdin')
-        process.exit(1)
+        if (!(await pathExists(absoluteFilePath))) {
+          const cacheDir =
+            findCacheDirectory({name: cacheDirName, cwd: linterOptions.cwd}) ??
+            path.join(cliOptions.cwd, 'node_modules', '.cache', cacheDirName)
+          cliOptions.stdinFilename = path.join(
+            cacheDir,
+            path.basename(absoluteFilePath),
+          )
+          shouldRemoveStdInFile = true
+          baseXoConfigOptions.ignores = [
+            '!**/node_modules/**',
+            '!node_modules/**',
+            '!node_modules/',
+            `!${path.relative(cliOptions.cwd, cliOptions.stdinFilename)}`,
+          ]
+          if (!(await pathExists(path.dirname(cliOptions.stdinFilename)))) {
+            await fs.mkdir(path.dirname(cliOptions.stdinFilename), {
+              recursive: true,
+            })
+          }
+
+          await fs.writeFile(cliOptions.stdinFilename, stdin)
+        }
       }
 
-      options.filePath = options.printConfig
-
-      coreD.invoke([input, options, null])
-    } else if (options.stdin) {
-      const stdin = await getStdin()
-
-      if (options.stdinFilename) {
-        options.filePath = options.stdinFilename
+      if (cliOptions.fix) {
+        return coreD.invoke([
+          cliOptions,
+          linterOptions,
+          baseXoConfigOptions,
+          input,
+          stdin,
+        ])
       }
 
-      if (options.fix) {
-        return coreD.invoke([input, options, stdin])
-      }
+      coreD.invoke([
+        cliOptions,
+        linterOptions,
+        baseXoConfigOptions,
+        input,
+        null,
+      ])
 
-      if (options.open) {
-        console.error('The `--open` flag is not supported on stdin')
-        process.exit(1)
+      if (shouldRemoveStdInFile) {
+        await fs.rm(cliOptions.stdinFilename)
       }
 
-      coreD.invoke([input, options, stdin])
-    } else {
-      coreD.invoke([input, options, null])
+      return
     }
+
+    coreD.invoke([cliOptions, linterOptions, baseXoConfigOptions, input, null])
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vinsonchuong/xo_d",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Speed up xo in the same way as eslint_d",
   "keywords": [],
   "homepage": "https://github.com/vinsonchuong/xo_d",
@@ -13,22 +13,22 @@
     "release": "semantic-release"
   },
   "type": "commonjs",
-  "bin": {
-    "xo_d": "cli.js"
-  },
+  "bin": "cli.js",
   "dependencies": {
-    "core_d": "^5.0.1",
-    "eslint-formatter-pretty": "^4.1.0",
+    "core_d": "^6.1.0",
+    "eslint-formatter-pretty": "^6.0.1",
+    "find-cache-directory": "^6.0.0",
     "get-stdin": "^9.0.0",
-    "meow": "^11.0.0",
-    "semver": "^7.3.8",
-    "xo": "^0.53.0"
+    "meow": "^13.2.0",
+    "path-exists": "^5.0.0",
+    "xo": "^1.1.0"
   },
   "devDependencies": {
-    "ava": "^5.0.1",
-    "ava-patterns": "^3.2.0",
-    "get-stream": "^6.0.1",
-    "semantic-release": "^20.0.0"
+    "ava": "^5.3.1",
+    "ava-patterns": "^3.2.1",
+    "get-stream": "^9.0.1",
+    "semantic-release": "^24.2.5",
+    "typescript": "^5.8.3"
   },
   "ava": {
     "verbose": true
@@ -52,5 +52,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "packageManager": "yarn@4.9.2"
 }

package/server.mjs

@@ -1,46 +1,53 @@
-import process from 'node:process'
-import xo from 'xo'
+import {Xo} from 'xo'
 import formatterPretty from 'eslint-formatter-pretty'
-import openReport from 'xo/lib/open-report.js'
 
-async function log(report, options) {
-  const reporter =
-    options.reporter || process.env.GITHUB_ACTIONS
-      ? await xo.getFormatter(options.reporter || 'compact')
-      : formatterPretty
-
-  const text = reporter(report.results, {rulesMeta: report.rulesMeta})
-  const exitCode = report.errorCount === 0 ? 0 : 1
-  return `${text}\n# exit ${exitCode}`
-}
-
-export default async function ([input, options, stdin]) {
-  if (typeof options.printConfig === 'string') {
-    options.filePath = options.printConfig
-    const config = await xo.getConfig(options)
-    return JSON.stringify(config, undefined, '\t')
+export default async function run([
+  cliOptions,
+  linterOptions,
+  baseXoConfigOptions,
+  input,
+  stdin,
+]) {
+  const xo = new Xo(linterOptions, baseXoConfigOptions)
+
+  const log = async (report) => {
+    const reporter = cliOptions.reporter
+      ? await new Xo(linterOptions, baseXoConfigOptions).getFormatter(
+          cliOptions.reporter,
+        )
+      : {format: formatterPretty}
+
+    const text = reporter.format(report.results, {
+      cwd: linterOptions.cwd,
+      ...report,
+    })
+    const exitCode = report.errorCount === 0 ? 0 : 1
+
+    return `${text}\n# exit ${exitCode}`
   }
 
-  if (options.stdin) {
-    if (options.fix) {
+  if (cliOptions.stdin) {
+    if (cliOptions.fix) {
       const {
         results: [result],
-      } = await xo.lintText(stdin, options)
-      return (result && result.output) || stdin
+      } = await xo.lintText(stdin, {
+        filePath: cliOptions.stdinFilename,
+      })
+      return result?.output ?? stdin
     }
 
-    return log(await xo.lintText(stdin, options), options)
-  }
-
-  const report = await xo.lintFiles(input, options)
-
-  if (options.fix) {
-    await xo.outputFixes(report)
+    return log(
+      await xo.lintText(stdin, {
+        filePath: cliOptions.stdinFilename,
+        warnIgnored: false,
+      }),
+    )
   }
 
-  if (options.open) {
-    openReport(report)
+  const report = await xo.lintFiles(input)
+  if (cliOptions.fix) {
+    await Xo.outputFixes(report)
   }
 
-  return log(report, options)
+  return log(report)
 }