tools: also lint for console.log in oxlint

Author: david-crespo

.oxlintrc.json

@@ -3,6 +3,8 @@
   "plugins": ["react", "react-hooks", "unicorn", "typescript", "oxc"],
   "rules": {
     "react-hooks/exhaustive-deps": "error",
+    // only worry about console.log
+    "no-console": ["error", { "allow": ["warn", "error", "info", "table"] }],
     // turning this off because it's more sensitive than eslint currently
     // "react-hooks/rules-of-hooks": "error",
     "no-unused-vars": [
@@ -13,5 +15,6 @@
         "caughtErrorsIgnorePattern": "^_"
       }
     ]
-  }
+  },
+  "ignorePatterns": ["dist/", "node_modules/"]
 }

tools/deno/api-diff.ts

@@ -34,7 +34,7 @@ Parameters:
 `.trim()
 
 function printHelpAndExit(): never {
-  console.log(HELP)
+  console.info(HELP)
   Deno.exit()
 }
 
@@ -98,7 +98,7 @@ async function genForCommit(commit: string, force: boolean) {
   if (force || !alreadyExists) {
     await $`rm -rf ${tmpDir}`
     await $`mkdir -p ${tmpDir}`
-    console.log(`Generating for ${commit}...`)
+    console.info(`Generating for ${commit}...`)
     await $`npx @oxide/openapi-gen-ts@0.4.0 ${specUrl(commit)} ${tmpDir}`
     await $`npx prettier --write --log-level error ${tmpDir}`
   }

tools/deno/bump-omicron.ts

@@ -65,7 +65,7 @@ const args = flags.parse(Deno.args, {
 })
 
 if (args.help) {
-  console.log(HELP)
+  console.info(HELP)
   Deno.exit()
 }
 
@@ -103,7 +103,7 @@ const oldCommit = /COMMIT="?([a-f0-9]+)"?/.exec(oldVersionFile)?.[1]
 if (!oldCommit) throw Error('Could not parse existing version file')
 
 if (oldCommit === newCommit) {
-  console.log('Nothing to update: Omicron already has the current commit pinned')
+  console.info('Nothing to update: Omicron already has the current commit pinned')
   Deno.exit()
 }
 
@@ -118,7 +118,7 @@ const changesLine = `https://github.com/oxidecomputer/console/compare/${commitRa
 const branchName = 'bump-console-' + newCommit.slice(0, 8)
 const prBody = `${changesLine}\n\n${commitsMarkdown}`
 
-console.log(`\n${changesLine}\n\n${commits}\n`)
+console.info(`\n${changesLine}\n\n${commits}\n`)
 
 if (args.dryRun) Deno.exit()
 
@@ -131,15 +131,15 @@ const message =
 
 const prTitle = 'Bump web console' + (message ? ` (${message})` : '')
 
-console.log(`\nPR title: ${prTitle}\n`)
+console.info(`\nPR title: ${prTitle}\n`)
 
 const go = await $.confirm({ message: 'Make Omicron PR?', noClear: true })
 if (!go) Deno.exit()
 
 if (!$.commandExistsSync('gh')) throw Error(GH_MISSING)
 
 await Deno.writeTextFile(VERSION_FILE, newVersionFile)
-console.log('Updated ', VERSION_FILE)
+console.info('Updated ', VERSION_FILE)
 
 const consoleDir = Deno.cwd()
 
@@ -149,28 +149,28 @@ Deno.chdir(OMICRON_DIR)
 await $`git checkout main`
 await $`git pull`
 await $`git checkout -b ${branchName}`
-console.log('Created branch', branchName)
+console.info('Created branch', branchName)
 
 await $`git add tools/console_version`
 await $`git commit -m ${prTitle} -m ${prBody}`
 await $`git push --set-upstream origin ${branchName}`
-console.log('Committed changes and pushed')
+console.info('Committed changes and pushed')
 
 // create PR
 const prUrl = await $`gh pr create --title ${prTitle} --body ${prBody}`.text()
-console.log('PR created:', prUrl)
+console.info('PR created:', prUrl)
 
 // set it to auto merge
 const prNum = prUrl.match(/\d+$/)![0]
 await $`gh pr merge ${prNum} --auto --squash`
-console.log('PR set to auto-merge when CI passes')
+console.info('PR set to auto-merge when CI passes')
 
 await $`git checkout main`
 await $`git branch -D ${branchName}`
-console.log('Checked out omicron main, deleted branch', branchName)
+console.info('Checked out omicron main, deleted branch', branchName)
 
 // bump omicron tag in console to current commit
 Deno.chdir(consoleDir)
-console.log('Bumping omicron tag in console')
+console.info('Bumping omicron tag in console')
 await $`git tag -f -a omicron -m 'pinned commit on omicron main'`
 await $`git push -f origin tag omicron`

tools/deno/deploy-dogfood.ts

@@ -36,36 +36,36 @@ const consoleCommit = args._[0]
 
 if (!consoleCommit) {
   console.error('Error: Console commit hash is required\n')
-  console.log(USAGE)
+  console.info(USAGE)
   Deno.exit(1)
 }
 
-console.log('Finding nexus zones...')
+console.info('Finding nexus zones...')
 const zones: string = await $`./tools/dogfood/find-zone.sh nexus`.text()
 const gimletNums = zones
   .split('\n')
   .filter((line) => line.includes('nexus'))
   .map((line) => line.trim().split(' ')[0])
 
-console.log(`Found: ${JSON.stringify(gimletNums)}\n`)
+console.info(`Found: ${JSON.stringify(gimletNums)}\n`)
 
 const TARBALL_URL = `https://dl.oxide.computer/releases/console/${consoleCommit}.tar.gz`
 const TARBALL_FILE = '/tmp/console.tar.gz'
 
-console.log(`Downloading tarball to ${TARBALL_FILE}`)
+console.info(`Downloading tarball to ${TARBALL_FILE}`)
 await $`curl --show-error --fail --location --output ${TARBALL_FILE} ${TARBALL_URL}`
-console.log(`Done downloading.\n`)
+console.info(`Done downloading.\n`)
 
 const go = await $.confirm(`Deploy console to gimlets ${JSON.stringify(gimletNums)}?`)
 if (!go) {
-  console.log('Deploy aborted')
+  console.info('Deploy aborted')
   Deno.exit()
 }
 
 async function deploy(num: string) {
-  console.log(`Deploying to gimlet ${num}...`)
+  console.info(`Deploying to gimlet ${num}...`)
   await $`./tools/dogfood/scp-assets.sh gc${num} ${TARBALL_FILE}`
-  console.log(`Done with gimlet ${num}...`)
+  console.info(`Done with gimlet ${num}...`)
 }
 
 await Promise.all(gimletNums.map(deploy))

tools/deno/mock-serial-console.ts

@@ -27,7 +27,7 @@ async function serialConsole(req: Request) {
   const { socket, response } = Deno.upgradeWebSocket(req)
   socket.binaryType = 'arraybuffer'
 
-  console.log(`New client connected`)
+  console.info(`New client connected`)
 
   // send hello as a binary frame for xterm to display
   socket.onopen = () => {
@@ -39,7 +39,7 @@ async function serialConsole(req: Request) {
   // echo back binary data
   socket.onmessage = (m) => socket.send(m.data)
 
-  socket.onclose = () => console.log('Connection closed')
+  socket.onclose = () => console.info('Connection closed')
 
   return response
 }

tools/start_mock_api.ts

@@ -12,7 +12,7 @@ import { handlers } from '../mock-api/msw/handlers'
 // TODO: take port argument
 createServer(...handlers).listen(12220)
 
-console.log('Mock Nexus API running at http://localhost:12220')
+console.info('Mock Nexus API running at http://localhost:12220')
 
 // TODO: request logging. I tried adding this as a full express server with
 // logging middleware and it only logged 404s, not good requests