chore(W-17692101): eslint 9 (#730)

bin/dev.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
-// eslint-disable-next-line node/shebang
+
 async function main() {
   const {execute} = await import('@oclif/core')
   await execute({development: true, dir: import.meta.url})

bin/run.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 
-// eslint-disable-next-line node/shebang
 async function main() {
   const {execute} = await import('@oclif/core')
   await execute({dir: import.meta.url})

eslint.config.js

@@ -0,0 +1,19 @@
+import {includeIgnoreFile} from '@eslint/compat'
+import oclif from 'eslint-config-oclif'
+import prettier from 'eslint-config-prettier'
+import path from 'node:path'
+import {fileURLToPath} from 'node:url'
+
+const gitignorePath = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '.gitignore')
+
+export default [
+  includeIgnoreFile(gitignorePath),
+  ...oclif,
+  prettier,
+  {
+    files: ['test/**/*.ts'],
+    rules: {
+      'import/no-named-as-default-member': 'off',
+    },
+  },
+]

package.json

@@ -17,6 +17,7 @@
   },
   "devDependencies": {
     "@commitlint/config-conventional": "^19",
+    "@eslint/compat": "^1.2.5",
     "@oclif/plugin-help": "^6",
     "@oclif/prettier-config": "^0.2.1",
     "@oclif/test": "^4",
@@ -30,10 +31,9 @@
     "@types/sinon": "^17.0.3",
     "chai": "^4",
     "commitlint": "^19",
-    "eslint": "^8.57.1",
-    "eslint-config-oclif": "^5.2.2",
-    "eslint-config-oclif-typescript": "^3.1.13",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint": "^9.19.0",
+    "eslint-config-oclif": "^6.0.0",
+    "eslint-config-prettier": "^10.0.1",
     "husky": "^9.1.7",
     "lint-staged": "^15.4.2",
     "mocha": "^10.8.2",
@@ -81,7 +81,7 @@
     "build": "shx rm -rf lib && tsc",
     "clean": "shx rm -f oclif.manifest.json",
     "compile": "tsc",
-    "lint": "eslint . --ext .ts",
+    "lint": "eslint",
     "postpack": "yarn run clean",
     "posttest": "yarn lint",
     "prepack": "yarn build && oclif manifest && oclif readme",

src/commands/schema/compare.ts

@@ -1,14 +1,14 @@
 import {Flags, toConfiguredId} from '@oclif/core'
 import {bold, cyan, underline} from 'ansis'
-import {Operation, diff} from 'just-diff'
+import {diff, Operation} from 'just-diff'
 import get from 'lodash.get'
 import fs from 'node:fs'
 import path from 'node:path'
 import * as semver from 'semver'
 import {Schema} from 'ts-json-schema-generator'
 
 import SnapshotCommand from '../../snapshot-command.js'
-import {GLOB_PATTERNS, getAllFiles, getKeyNameFromFilename} from '../../util.js'
+import {getAllFiles, getKeyNameFromFilename, GLOB_PATTERNS} from '../../util.js'
 import {SchemaGenerator, Schemas} from './generate.js'
 
 export type SchemaComparison = Array<{op: Operation; path: (number | string)[]; value: unknown}>
@@ -31,6 +31,7 @@ export default class SchemaCompare extends SnapshotCommand {
     }),
   }
 
+  // eslint-disable-next-line complexity
   public async run(): Promise<SchemaComparison> {
     const strategy =
       typeof this.config.pjson.oclif?.commands === 'string' ? 'pattern' : this.config.pjson.oclif?.commands?.strategy
@@ -86,13 +87,6 @@ export default class SchemaCompare extends SnapshotCommand {
       const basePath = lastElementIsNum ? readablePath.replace(`.${lastPathElement}`, '') : readablePath
 
       switch (change.op) {
-        case 'replace': {
-          humanReadableChanges[commandId].push(
-            `${underline(readablePath)} was changed from ${cyan(existing)} to ${cyan(latest)}`,
-          )
-          break
-        }
-
         case 'add': {
           humanReadableChanges[commandId].push(
             lastElementIsNum
@@ -111,6 +105,13 @@ export default class SchemaCompare extends SnapshotCommand {
           break
         }
 
+        case 'replace': {
+          humanReadableChanges[commandId].push(
+            `${underline(readablePath)} was changed from ${cyan(existing)} to ${cyan(latest)}`,
+          )
+          break
+        }
+
         default: {
           break
         }
@@ -133,7 +134,7 @@ export default class SchemaCompare extends SnapshotCommand {
     }
 
     this.log()
-    const bin = process.platform === 'win32' ? 'bin\\dev.cmd' : 'bin/dev.js'
+    const bin = process.platform === 'win32' ? String.raw`bin\dev.cmd` : 'bin/dev.js'
     this.log(
       'If intended, please update the schema file(s) and run again:',
       bold(`${bin} ${toConfiguredId('schema:generate', this.config)}`),

src/commands/schema/generate.ts

@@ -3,10 +3,10 @@ import {red} from 'ansis'
 import {globbySync} from 'globby'
 import fs from 'node:fs'
 import path from 'node:path'
-import {Schema, createGenerator} from 'ts-json-schema-generator'
+import {createGenerator, Schema} from 'ts-json-schema-generator'
 
 import SnapshotCommand from '../../snapshot-command.js'
-import {GLOB_PATTERNS, getAllFiles, getSchemaFileName} from '../../util.js'
+import {getAllFiles, getSchemaFileName, GLOB_PATTERNS} from '../../util.js'
 
 export type SchemasMap = {
   [key: string]: Schema

src/commands/snapshot/compare.ts

@@ -12,12 +12,12 @@ interface Change {
   removed?: boolean
 }
 
-type CommandChange = {
+type CommandChange = Change & {
   alias: Change[]
   chars: Change[]
   flags: Change[]
   plugin: string
-} & Change
+}
 
 export type CompareResponse = {
   addedCommands?: string[]
@@ -153,7 +153,7 @@ export default class Compare extends SnapshotCommand {
 
   /**
    * compares two command's properties to each other
-   * @return a list of added, removed, updated, and changed properties
+   * @returns a list of added, removed, updated, and changed properties
    * @param initial initial command property to compare against
    * @param updated generated command property to compare with
    */

src/commands/snapshot/generate.ts

@@ -33,7 +33,7 @@ export default class Generate extends SnapshotCommand {
     const charConflictCommand = resultCommands.find(
       (command) =>
         command.flags.length > 1 &&
-        new Set([...command.flags, ...command.flagChars, ...command.flagAliases]).size !==
+        new Set([...command.flagAliases, ...command.flagChars, ...command.flags]).size !==
           [...command.flags, ...command.flagChars, ...command.flagAliases].length,
     )
 

test/util.test.ts

@@ -7,32 +7,41 @@ describe('util test', () => {
     it('should return correct command id when only hyphens in file name a-b-c.json', () => {
       expect(getKeyNameFromFilename('a-b-c.json')).to.equal('a:b:c')
     })
+
     it('should return correct command id when escaped hyphens in file name a-b-c__d.json', () => {
       expect(getKeyNameFromFilename('a-b-c__d.json')).to.equal('a:b:c-d')
     })
+
     it('should return correct command id when escaped hyphens in file name a__b-c__d.json', () => {
       expect(getKeyNameFromFilename('a__b-c__d.json')).to.equal('a-b:c-d')
     })
+
     it('should return correct command id when escaped hyphens in file name a-b__c__d.json', () => {
       expect(getKeyNameFromFilename('a-b__c__d.json')).to.equal('a:b-c-d')
     })
+
     it('should return correct command id when underscore in file name a-b-c_d.json', () => {
       expect(getKeyNameFromFilename('a-b-c_d.json')).to.equal('a:b:c_d')
     })
   })
+
   describe('getSchemaFileName', () => {
     it('should return correct file name when only ":" in command id a:b:c', () => {
       expect(getSchemaFileName('a:b:c')).to.equal('a-b-c.json')
     })
+
     it('should return correct file name when hyphens in command id a:b:c-d', () => {
       expect(getSchemaFileName('a:b:c-d')).to.equal('a-b-c__d.json')
     })
+
     it('should return correct file name when hyphens in command id a-b:c-d', () => {
       expect(getSchemaFileName('a-b:c-d')).to.equal('a__b-c__d.json')
     })
+
     it('should return correct file name when hyphens in command id a:b-c-d', () => {
       expect(getSchemaFileName('a:b-c-d')).to.equal('a-b__c__d.json')
     })
+
     it('should return correct file name when underscore in command id a:b:c_d', () => {
       expect(getSchemaFileName('a:b:c_d')).to.equal('a-b-c_d.json')
     })