chore(lint): add certain unicorn eslint rules (#6352)

* chore(lint): add certain unicorn eslint rules

* chore: fix lint errors

.eslintrc.cjs

@@ -31,6 +31,7 @@ const config = {
     'prettier',
     'react',
     'tsdoc',
+    'unicorn',
   ],
   ignorePatterns: [
     '**/etc/*',
@@ -112,6 +113,10 @@ const config = {
     'no-unused-vars': 'off',
     'no-useless-catch': 'warn',
     'no-async-promise-executor': 'warn',
+    'unicorn/prefer-string-slice': 'error',
+    'unicorn/prefer-node-protocol': 'error',
+    'unicorn/prefer-keyboard-event-key': 'error',
+    'unicorn/custom-error-definition': 'error',
   },
   settings: {
     'import/extensions': extensions,

package.json

@@ -134,6 +134,7 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "eslint-plugin-simple-import-sort": "^12.0.0",
     "eslint-plugin-tsdoc": "^0.2.17",
+    "eslint-plugin-unicorn": "^52.0.0",
     "eslint-plugin-unused-imports": "^3.1.0",
     "execa": "^2.0.0",
     "glob": "^7.2.0",

packages/@sanity/block-tools/src/HtmlDeserializer/helpers.ts

@@ -161,18 +161,18 @@ export function trimWhitespace(blocks: TypedObject[]): TypedObject[] {
         child.text = child.text.replace(/[^\S\n]+$/g, '')
       }
       if (
-        /\s/.test(child.text.substring(child.text.length - 1)) &&
+        /\s/.test(child.text.slice(Math.max(0, child.text.length - 1))) &&
         nextChild &&
         isMinimalSpan(nextChild) &&
-        /\s/.test(nextChild.text.substring(0, 1))
+        /\s/.test(nextChild.text.slice(0, 1))
       ) {
         child.text = child.text.replace(/[^\S\n]+$/g, '')
       }
       if (
-        /\s/.test(child.text.substring(0, 1)) &&
+        /\s/.test(child.text.slice(0, 1)) &&
         prevChild &&
         isMinimalSpan(prevChild) &&
-        /\s/.test(prevChild.text.substring(prevChild.text.length - 1))
+        /\s/.test(prevChild.text.slice(Math.max(0, prevChild.text.length - 1)))
       ) {
         child.text = child.text.replace(/^[^\S\n]+/g, '')
       }

packages/@sanity/block-tools/src/util/randomKey.ts

@@ -9,7 +9,7 @@ function whatwgRNG(length = 16) {
 
 const byteToHex: string[] = []
 for (let i = 0; i < 256; ++i) {
-  byteToHex[i] = (i + 0x100).toString(16).substring(1)
+  byteToHex[i] = (i + 0x100).toString(16).slice(1)
 }
 
 /**

packages/@sanity/block-tools/test/tests/HtmlDeserializer/index.test.ts

@@ -1,8 +1,8 @@
-import * as fs from 'node:fs'
-import * as path from 'node:path'
+import assert from 'node:assert'
+import fs from 'node:fs'
+import path from 'node:path'
 
 import {describe, it} from '@jest/globals'
-import * as assert from 'assert'
 import {JSDOM} from 'jsdom'
 
 import * as blockTools from '../../../src'

packages/@sanity/block-tools/test/tests/util/normalizeBlock.test.ts

@@ -1,5 +1,6 @@
+import assert from 'node:assert'
+
 import {describe, it} from '@jest/globals'
-import * as assert from 'assert'
 
 import {normalizeBlock} from '../../../src/util/normalizeBlock'
 

packages/@sanity/cli/codemods/partsTypeDirective.js

@@ -1,4 +1,4 @@
-const path = require('path')
+const path = require('node:path')
 
 partsTypeDirective.parser = 'tsx'
 module.exports = partsTypeDirective

packages/@sanity/cli/codemods/reactIconsV3.js

@@ -82,7 +82,7 @@ function replace(input, re, value) {
 
 function pascalCaseTransform(input) {
   const firstChar = input.charAt(0)
-  const lowerChars = input.substr(1).toLowerCase()
+  const lowerChars = input.slice(1).toLowerCase()
   return `${firstChar.toUpperCase()}${lowerChars}`
 }
 

packages/@sanity/cli/test/shared/environment.ts

@@ -195,6 +195,7 @@ class ExecError extends Error {
   stderr: string
   constructor(message: string, code: number, stdout: string, stderr: string) {
     super(message)
+    this.name = 'ExecError'
     this.code = code
     this.stdout = stdout
     this.stderr = stderr

packages/@sanity/migrate/src/fetch-utils/fetchStream.ts

@@ -9,6 +9,7 @@ export class HTTPError extends Error {
 
   constructor(statusCode: number, message: string) {
     super(message)
+    this.name = 'HTTPError'
     this.statusCode = statusCode
   }
 }

packages/@sanity/migrate/src/it-utils/split.ts

@@ -7,12 +7,12 @@ export async function* split(
     buf += chunk
     if (buf.includes(delimiter)) {
       const lastIndex = buf.lastIndexOf(delimiter)
-      const parts = buf.substring(0, lastIndex).split(delimiter)
+      const parts = buf.slice(0, Math.max(0, lastIndex)).split(delimiter)
 
       for (const part of parts) {
         yield part
       }
-      buf = buf.substring(lastIndex + delimiter.length)
+      buf = buf.slice(Math.max(0, lastIndex + delimiter.length))
     }
   }
   yield buf

packages/@sanity/portable-text-editor/e2e-tests/setup/collaborative.jest.env.ts

@@ -89,7 +89,7 @@ export default class CollaborationEnvironment extends NodeEnvironment {
     }
 
     // This will identify this test throughout the web environment
-    const testId = (Math.random() + 1).toString(36).substring(7)
+    const testId = (Math.random() + 1).toString(36).slice(7)
 
     // Hook up page console and npm debug in the PTE
     if (DEBUG) {
@@ -101,11 +101,11 @@ export default class CollaborationEnvironment extends NodeEnvironment {
       }, DEBUG)
       this._pageA.on('console', (message) =>
         // eslint-disable-next-line no-console
-        console.log(`A:${message.type().substring(0, 3).toUpperCase()} ${message.text()}`),
+        console.log(`A:${message.type().slice(0, 3).toUpperCase()} ${message.text()}`),
       )
       this._pageB.on('console', (message) =>
         // eslint-disable-next-line no-console
-        console.log(`B:${message.type().substring(0, 3).toUpperCase()} ${message.text()}`),
+        console.log(`B:${message.type().slice(0, 3).toUpperCase()} ${message.text()}`),
       )
     }
     this._pageA.on('pageerror', (err) => {
@@ -120,7 +120,7 @@ export default class CollaborationEnvironment extends NodeEnvironment {
     this.global.setDocumentValue = async (
       value: PortableTextBlock[] | undefined,
     ): Promise<void> => {
-      const revId = (Math.random() + 1).toString(36).substring(7)
+      const revId = (Math.random() + 1).toString(36).slice(7)
       ipc.of.socketServer.emit('payload', JSON.stringify({type: 'value', value, testId, revId}))
       await this._pageA?.waitForSelector(`code[data-rev-id="${revId}"]`, {
         timeout: REVISION_TIMEOUT_MS,

packages/@sanity/portable-text-editor/e2e-tests/web-server/app.tsx

@@ -23,7 +23,7 @@ export function App() {
   const {editorId, testId} = useMemo(() => {
     const params = new URLSearchParams(document.location.search)
     return {
-      editorId: params.get('editorId') || (Math.random() + 1).toString(36).substring(7),
+      editorId: params.get('editorId') || (Math.random() + 1).toString(36).slice(7),
       testId: params.get('testId') || 'noTestIdGiven',
     }
   }, [])

packages/@sanity/portable-text-editor/e2e-tests/web-server/components/Editor.tsx

@@ -71,7 +71,7 @@ export const Editor = ({
   const [selectionValue, setSelectionValue] = useState<EditorSelection | null>(selection)
   const selectionString = useMemo(() => JSON.stringify(selectionValue), [selectionValue])
   const editor = useRef<PortableTextEditor>(null)
-  const keyGenFn = useMemo(() => createKeyGenerator(editorId.substring(0, 1)), [editorId])
+  const keyGenFn = useMemo(() => createKeyGenerator(editorId.slice(0, 1)), [editorId])
   const [isOffline, setIsOffline] = useState(!window.navigator.onLine)
   const [readOnly, setReadOnly] = useState(false)
 

packages/@sanity/portable-text-editor/e2e-tests/ws-server/index.ts

@@ -81,7 +81,7 @@ app.ws('/', (s, req) => {
       }
       if (mutatedValue !== null) {
         // Assign revId and store value
-        const revId = (Math.random() + 1).toString(36).substring(7)
+        const revId = (Math.random() + 1).toString(36).slice(7)
         valueMap[testId] = mutatedValue
         revisionMap[testId] = revId
         // Broadcast to all

packages/@sanity/schema/example/test.js

@@ -1,4 +1,4 @@
-import assert from 'assert'
+import assert from 'node:assert'
 
 import {Schema} from '../src/legacy/Schema'
 import schemaDef from './schema-def'

packages/@sanity/util/src/content/randomKey.ts

@@ -9,7 +9,7 @@ const getByteHexTable = (() => {
 
     table = []
     for (let i = 0; i < 256; ++i) {
-      table[i] = (i + 0x100).toString(16).substring(1)
+      table[i] = (i + 0x100).toString(16).slice(1)
     }
     return table
   }

packages/sanity/src/_internal/cli/actions/graphql/SchemaError.ts

@@ -12,6 +12,7 @@ export class SchemaError extends Error {
 
   constructor(problemGroups: SchemaValidationProblemGroup[]) {
     super('Schema errors encountered')
+    this.name = 'SchemaError'
     this.problemGroups = problemGroups
   }
 

packages/sanity/src/_internal/cli/actions/graphql/extractFromSanitySchema.ts

@@ -724,6 +724,7 @@ class HelpfulError extends Error {
 
   constructor(message: string, helpUrl?: string) {
     super(message)
+    this.name = 'HelpfulError'
     this.helpUrl = helpUrl
   }
 }

packages/sanity/src/_internal/cli/actions/schema/formatSchemaValidation.ts

@@ -25,7 +25,7 @@ function formatPath(pathSegments: SchemaValidationProblemPath) {
     return `${mode === 'array' ? `[${name}]` : `.${name}`}${format(next)}`
   }
 
-  return format(pathSegments.slice(1)).substring(1) // removes the top-level type and leading `.`
+  return format(pathSegments.slice(1)).slice(1) // removes the top-level type and leading `.`
 }
 
 export function getAggregatedSeverity(

packages/sanity/src/_internal/cli/actions/validation/reporters/prettyReporter/util.ts

@@ -23,7 +23,7 @@ export const levelValues = {error: 0, warning: 1, info: 2} as const
  */
 export const count = (amount: number, subject: string): string =>
   `${amount.toLocaleString('en-US')} ${
-    amount === 1 ? subject.substring(0, subject.length - 1) : subject
+    amount === 1 ? subject.slice(0, Math.max(0, subject.length - 1)) : subject
   }`
 
 const percentageFormatter = new Intl.NumberFormat('en-US', {

packages/sanity/src/_internal/cli/commands/dataset/alias/createAliasHandler.ts

@@ -27,7 +27,7 @@ export const createAliasHandler: CliCommandAction = async (args, context) => {
   let aliasOutputName = aliasName
 
   if (aliasName.startsWith(ALIAS_PREFIX)) {
-    aliasName = aliasName.substring(1)
+    aliasName = aliasName.slice(1)
   } else {
     aliasOutputName = `${ALIAS_PREFIX}${aliasName}`
   }

packages/sanity/src/_internal/cli/commands/dataset/alias/deleteAliasHandler.ts

@@ -28,7 +28,7 @@ export const deleteAliasHandler: CliCommandAction<DeleteAliasFlags> = async (arg
   if (dsError) {
     throw dsError
   }
-  aliasName = aliasName.startsWith(ALIAS_PREFIX) ? aliasName.substring(1) : aliasName
+  aliasName = aliasName.startsWith(ALIAS_PREFIX) ? aliasName.slice(1) : aliasName
 
   const [fetchedAliases] = await Promise.all([aliasClient.listAliases(client)])
   const linkedAlias = fetchedAliases.find((elem) => elem.name === aliasName)

packages/sanity/src/_internal/cli/commands/dataset/alias/linkAliasHandler.ts

@@ -28,7 +28,7 @@ export const linkAliasHandler: CliCommandAction = async (args, context) => {
   let aliasOutputName = aliasName
 
   if (aliasName.startsWith(ALIAS_PREFIX)) {
-    aliasName = aliasName.substring(1)
+    aliasName = aliasName.slice(1)
   } else {
     aliasOutputName = `${ALIAS_PREFIX}${aliasName}`
   }

packages/sanity/src/_internal/cli/commands/dataset/alias/unlinkAliasHandler.ts

@@ -32,7 +32,7 @@ export const unlinkAliasHandler: CliCommandAction<UnlinkFlags> = async (args, co
   let aliasOutputName = aliasName
 
   if (aliasName.startsWith(ALIAS_PREFIX)) {
-    aliasName = aliasName.substring(1)
+    aliasName = aliasName.slice(1)
   } else {
     aliasOutputName = `${ALIAS_PREFIX}${aliasName}`
   }

packages/sanity/src/_internal/cli/threads/__tests__/validateDocuments.test.ts

@@ -117,7 +117,7 @@ describe('validateDocuments', () => {
           .filter((key) => key.startsWith('$'))
           .reduce<Record<string, string | string[]>>((acc, key) => {
             const values = searchParams.getAll(key)
-            acc[key.substring(1)] = values.length === 1 ? values[0] : values
+            acc[key.slice(1)] = values.length === 1 ? values[0] : values
             return acc
           }, {})
 

packages/sanity/src/_internal/cli/util/getUrlHeaders.ts

@@ -5,6 +5,11 @@ import {promise} from 'get-it/middleware'
 const request = getIt([promise()])
 
 export class HttpError extends Error {
+  constructor(message: string) {
+    super(message)
+    this.name = 'HttpError'
+  }
+
   statusCode?: number
 }
 

packages/sanity/src/core/comments/components/pte/comment-input/CommentInputProvider.tsx

@@ -97,10 +97,11 @@ export function CommentInputProvider(props: CommentInputProviderProps) {
       const isDeleteText = event.inputType === 'deleteContentBackward'
       const isInsertingAtChar = isInsertText && event.data === '@'
 
-      const lastIndexOfAt = focusSpan?.text.substring(0, cursorOffset).lastIndexOf('@') || 0
+      const lastIndexOfAt =
+        focusSpan?.text.slice(0, Math.max(0, cursorOffset)).lastIndexOf('@') || 0
 
       const isWhitespaceCharBeforeCursorPosition =
-        focusSpan?.text.substring(cursorOffset - 1, cursorOffset) === ' '
+        focusSpan?.text.slice(cursorOffset - 1, cursorOffset) === ' '
 
       const filterStartsWithSpaceChar = isInsertText && event.data === ' ' && !mentionsSearchTerm
 
@@ -126,14 +127,14 @@ export function CommentInputProvider(props: CommentInputProviderProps) {
       // Update the search term
       if (isPortableTextSpan(focusChild)) {
         // Term starts with the @ char in the value until the cursor offset
-        let term = focusChild.text.substring(lastIndexOfAt + 1, cursorOffset)
+        let term = focusChild.text.slice(lastIndexOfAt + 1, cursorOffset)
         // Add the char to the mentions search term
         if (isInsertText) {
           term += event.data
         }
         // Exclude the char from the mentions search term
         if (isDeleteText) {
-          term = term.substring(0, term.length - 1)
+          term = term.slice(0, Math.max(0, term.length - 1))
         }
         // Set the updated mentions search term
         setMentionsSearchTerm(term)

packages/sanity/src/core/comments/utils/inline-comments/buildRangeDecorationSelectionsFromComments.ts

@@ -90,11 +90,11 @@ export function buildRangeDecorationSelectionsFromComments(
         .replaceAll(COMMENT_INDICATORS[0], '')
         .indexOf(COMMENT_INDICATORS[1])
       const textWithoutCommentTags = diffedText.replaceAll(COMMENT_INDICATORS_REGEX, '')
-      const oldCommentedText = selectionMember.text.substring(
+      const oldCommentedText = selectionMember.text.slice(
         selectionMember.text.indexOf(COMMENT_INDICATORS[0]) + 1,
         selectionMember.text.indexOf(COMMENT_INDICATORS[1]),
       )
-      const newCommentedText = textWithoutCommentTags.substring(startIndex, endIndex)
+      const newCommentedText = textWithoutCommentTags.slice(startIndex, endIndex)
       const {levenshtein} = diffText(newCommentedText, oldCommentedText)
       const threshold = Math.round(newCommentedText.length + oldCommentedText.length / 2)
 

packages/sanity/src/core/comments/utils/inline-comments/buildTextSelectionFromFragment.ts

@@ -55,7 +55,7 @@ export function buildTextSelectionFromFragment(
           if (child._key === fragmentStartSpan?._key) {
             originalTextBeforeSelection +=
               (isPortableTextSpan(child) &&
-                child.text.substring(0, normalizedSelection.anchor.offset)) ||
+                child.text.slice(0, Math.max(0, normalizedSelection.anchor.offset))) ||
               ''
             break
           }
@@ -68,7 +68,7 @@ export function buildTextSelectionFromFragment(
           if (child._key === fragmentEndSpan?._key) {
             originalTextAfterSelection =
               ((isPortableTextSpan(child) &&
-                child.text.substring(normalizedSelection.focus.offset, child.text.length)) ||
+                child.text.slice(normalizedSelection.focus.offset, child.text.length)) ||
                 '') + originalTextAfterSelection
             break
           }

packages/sanity/src/core/config/ConfigPropertyError.ts

@@ -21,6 +21,7 @@ export class ConfigPropertyError extends Error {
       `An error occurred while resolving \`${propertyName}\` from ${path.join(' > ')}${message}`,
     )
 
+    this.name = 'ConfigPropertyError'
     this.propertyName = propertyName
     this.cause = cause
     this.path = path

packages/sanity/src/core/config/ConfigResolutionError.ts

@@ -26,6 +26,7 @@ export class ConfigResolutionError extends Error {
         .join('\n')}\n\n`,
     )
 
+    // eslint-disable-next-line unicorn/custom-error-definition
     this.name = name
     this.causes = causes
     this.type = type

packages/sanity/src/core/config/SchemaError.ts

@@ -5,5 +5,6 @@ import {type Schema} from '@sanity/types'
 export class SchemaError extends Error {
   constructor(public schema: Schema) {
     super('SchemaError')
+    this.name = 'SchemaError'
   }
 }

packages/sanity/src/core/field/types/portableText/diff/components/PortableText.tsx

@@ -345,11 +345,11 @@ function renderDecorators({
     .filter((text) => !!text)
     .join('')
   const ptDiffMatchString = ptDiffChildren
-  const controlString = ptDiffMatchString.substring(
+  const controlString = ptDiffMatchString.slice(
     0,
-    ptDiffMatchString.indexOf(seg.text) + seg.text.length,
+    Math.max(0, ptDiffMatchString.indexOf(seg.text) + seg.text.length),
   )
-  const toTest = controlString.substring(0, controlString.indexOf(seg.text))
+  const toTest = controlString.slice(0, Math.max(0, controlString.indexOf(seg.text)))
   const marks: string[] = []
   const matches = [...toTest.matchAll(markRegex)]
   matches.forEach((match) => {