@unix/eslint 0.2.0 → 1.0.0

package/configs/js.js

@@ -1,8 +1,11 @@
 // @ts-check
 import eslint from '@eslint/js'
-import stylistic from '@stylistic/eslint-plugin'
+import prettierRecommended from 'eslint-plugin-prettier/recommended'
+
+import internal from './plugins/index.js'
 
 const jsFiles = ['**/*.{js,mjs,cjs,jsx}']
+const prettierPrintWidth = 85
 
 const ignores = [
   '**/node_modules/**',
@@ -40,12 +43,14 @@ export default [
     languageOptions: {
       ecmaVersion: 'latest',
     },
+    plugins: {
+      '@unix': internal,
+    },
   },
   {
     ...eslint.configs.recommended,
     files: jsFiles,
   },
-  withJsFiles(stylistic.configs['disable-legacy']),
   {
     files: jsFiles,
     rules: {
@@ -85,7 +90,6 @@ export default [
       'no-template-curly-in-string': 'error',
       'no-unassigned-vars': 'warn',
       'no-undef': 'error',
-      'no-unexpected-multiline': 'error',
       'no-unmodified-loop-condition': 'error',
       'no-unreachable': 'warn',
       'no-unsafe-finally': 'error',
@@ -97,7 +101,6 @@ export default [
       'require-atomic-updates': 'error',
       'use-isnan': 'error',
       'valid-typeof': 'error',
-      'arrow-body-style': ['error', 'as-needed'],
       'block-scoped-var': 'error',
       complexity: ['error', 3],
       'consistent-return': 'off',
@@ -120,18 +123,14 @@ export default [
       'no-regex-spaces': 'error',
       'no-useless-return': 'off',
       'no-var': 'error',
-      'prefer-arrow-callback': 'error',
       'prefer-rest-params': 'error',
       'no-else-return': ['error', { allowElseIf: false }],
-      curly: ['error', 'multi'],
-      '@stylistic/array-bracket-newline': ['error', 'consistent'],
-      '@stylistic/array-element-newline': ['error', 'consistent'],
-      '@stylistic/arrow-parens': ['error', 'as-needed'],
-      '@stylistic/implicit-arrow-linebreak': ['error', 'beside'],
-      '@stylistic/linebreak-style': ['error', 'unix'],
-      '@stylistic/multiline-comment-style': ['error', 'bare-block'],
-      '@stylistic/no-multiple-empty-lines': ['error', { max: 2, maxEOF: 1 }],
-      '@stylistic/nonblock-statement-body-position': ['error', 'beside'],
+      '@unix/compact-nonblock-statement': [
+        'error',
+        { maxLineLength: prettierPrintWidth },
+      ],
+      '@unix/compact-return-if': 'error',
     },
   },
+  withJsFiles(prettierRecommended),
 ]

package/configs/plugins/compact-nonblock-statement.js

@@ -0,0 +1,146 @@
+const DEFAULT_MAX_LINE_LENGTH = 85
+
+const isSingleLine = node => node.loc.start.line === node.loc.end.line
+
+const hasOnlyWhitespaceBetween = (sourceCode, left, right) =>
+  sourceCode.text.slice(left.range[1], right.range[0]).trim().length === 0
+
+const linePrefixUntil = (sourceCode, token) => {
+  const line = sourceCode.lines[token.loc.end.line - 1] ?? ''
+
+  return line.slice(0, token.loc.end.column)
+}
+
+const compactLineLength = (sourceCode, tokenBeforeBody, body) =>
+  `${linePrefixUntil(sourceCode, tokenBeforeBody)} ${sourceCode.getText(body)}`
+    .length
+
+const isCompactableBody = (sourceCode, body, maxLineLength, headerStartLine) => {
+  if (body.type === 'BlockStatement') return false
+  if (!isSingleLine(body)) return false
+
+  const tokenBeforeBody = sourceCode.getTokenBefore(body)
+
+  if (!tokenBeforeBody) return false
+  if (
+    headerStartLine !== undefined &&
+    headerStartLine !== tokenBeforeBody.loc.end.line
+  )
+    return false
+  if (tokenBeforeBody.loc.end.line === body.loc.start.line) return false
+  if (!hasOnlyWhitespaceBetween(sourceCode, tokenBeforeBody, body)) return false
+
+  return compactLineLength(sourceCode, tokenBeforeBody, body) <= maxLineLength
+}
+
+const reportCompactableBody = (
+  context,
+  sourceCode,
+  body,
+  maxLineLength,
+  headerStartLine,
+) => {
+  if (!isCompactableBody(sourceCode, body, maxLineLength, headerStartLine)) return
+
+  const tokenBeforeBody = sourceCode.getTokenBefore(body)
+
+  context.report({
+    fix(fixer) {
+      return fixer.replaceTextRange([tokenBeforeBody.range[1], body.range[0]], ' ')
+    },
+    messageId: 'compactNonblockStatement',
+    node: body,
+  })
+}
+
+const compactNonblockStatement = {
+  meta: {
+    type: 'layout',
+    docs: {
+      description: 'Require short non-block control bodies to stay on one line',
+    },
+    fixable: 'whitespace',
+    messages: {
+      compactNonblockStatement: 'Move this short statement onto the control line.',
+    },
+    schema: [
+      {
+        additionalProperties: false,
+        properties: {
+          maxLineLength: {
+            minimum: 1,
+            type: 'integer',
+          },
+        },
+        type: 'object',
+      },
+    ],
+  },
+  create(context) {
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
+    const [{ maxLineLength = DEFAULT_MAX_LINE_LENGTH } = {}] = context.options
+
+    return {
+      DoWhileStatement(node) {
+        reportCompactableBody(
+          context,
+          sourceCode,
+          node.body,
+          maxLineLength,
+          node.loc.start.line,
+        )
+      },
+      ForInStatement(node) {
+        reportCompactableBody(
+          context,
+          sourceCode,
+          node.body,
+          maxLineLength,
+          node.loc.start.line,
+        )
+      },
+      ForOfStatement(node) {
+        reportCompactableBody(
+          context,
+          sourceCode,
+          node.body,
+          maxLineLength,
+          node.loc.start.line,
+        )
+      },
+      ForStatement(node) {
+        reportCompactableBody(
+          context,
+          sourceCode,
+          node.body,
+          maxLineLength,
+          node.loc.start.line,
+        )
+      },
+      IfStatement(node) {
+        reportCompactableBody(
+          context,
+          sourceCode,
+          node.consequent,
+          maxLineLength,
+          node.loc.start.line,
+        )
+
+        if (!node.alternate || node.alternate.type === 'IfStatement') return
+
+        reportCompactableBody(context, sourceCode, node.alternate, maxLineLength)
+      },
+      WhileStatement(node) {
+        reportCompactableBody(
+          context,
+          sourceCode,
+          node.body,
+          maxLineLength,
+          node.loc.start.line,
+        )
+      },
+    }
+  },
+}
+
+export default compactNonblockStatement

package/configs/plugins/compact-return-if.js

@@ -0,0 +1,78 @@
+const getIfPrefix = (sourceCode, node) =>
+  sourceCode.text.slice(node.range[0], node.consequent.range[0]).trimEnd()
+
+const hasBlockComment = (sourceCode, block) =>
+  sourceCode.getCommentsInside(block).length > 0
+
+const isBlockWithOneStatement = node => {
+  if (node.type !== 'BlockStatement') return false
+
+  return node.body.length === 1
+}
+
+const isSingleLineReturn = statement => {
+  if (statement.type !== 'ReturnStatement') return false
+
+  return statement.loc.start.line === statement.loc.end.line
+}
+
+const getReturnStatement = node => {
+  if (node.alternate) return undefined
+  if (!isBlockWithOneStatement(node.consequent)) return undefined
+
+  return node.consequent.body[0]
+}
+
+const isCompactableReturn = (sourceCode, node, statement) => {
+  if (!isSingleLineReturn(statement)) return false
+  if (hasBlockComment(sourceCode, node.consequent)) return false
+
+  return node.loc.start.line === node.consequent.loc.start.line
+}
+
+const getCompactReturnStatement = (sourceCode, node) => {
+  const statement = getReturnStatement(node)
+
+  if (!statement) return undefined
+  if (!isCompactableReturn(sourceCode, node, statement)) return undefined
+
+  return statement
+}
+
+const compactReturnIf = {
+  meta: {
+    type: 'layout',
+    docs: {
+      description: 'Require single-return if statements to use a compact body',
+    },
+    fixable: 'code',
+    messages: {
+      compactReturnIf: 'Unnecessary braces around single-line return.',
+    },
+    schema: [],
+  },
+  create(context) {
+    const sourceCode = context.sourceCode ?? context.getSourceCode()
+
+    return {
+      IfStatement(node) {
+        const statement = getCompactReturnStatement(sourceCode, node)
+
+        if (!statement) return
+
+        context.report({
+          fix(fixer) {
+            return fixer.replaceTextRange(
+              [node.range[0], node.consequent.range[1]],
+              `${getIfPrefix(sourceCode, node)} ${sourceCode.getText(statement)}`,
+            )
+          },
+          messageId: 'compactReturnIf',
+          node: node.consequent,
+        })
+      },
+    }
+  },
+}
+
+export default compactReturnIf

package/configs/plugins/index.js

@@ -0,0 +1,9 @@
+import compactNonblockStatement from './compact-nonblock-statement.js'
+import compactReturnIf from './compact-return-if.js'
+
+export default {
+  rules: {
+    'compact-nonblock-statement': compactNonblockStatement,
+    'compact-return-if': compactReturnIf,
+  },
+}

package/configs/ts.js

@@ -1,11 +1,13 @@
 // @ts-check
 import eslint from '@eslint/js'
-import stylistic from '@stylistic/eslint-plugin'
+import prettierRecommended from 'eslint-plugin-prettier/recommended'
 import tseslint from 'typescript-eslint'
 
 import js from './js.js'
+import internal from './plugins/index.js'
 
 const tsFiles = ['**/*.{ts,mts,cts,tsx}']
+const prettierPrintWidth = 85
 
 const classMemberOrder = [
   [
@@ -98,9 +100,10 @@ export default tseslint.config(
         projectService: true,
       },
     },
+    plugins: {
+      '@unix': internal,
+    },
   },
-  withTsFiles(stylistic.configs['disable-legacy']),
-  withTsFiles(stylistic.configs.recommended),
   {
     files: tsFiles,
     rules: {
@@ -120,6 +123,11 @@ export default tseslint.config(
       '@typescript-eslint/no-floating-promises': 'warn',
       'func-style': ['error', 'expression', { allowArrowFunctions: true }],
       'no-else-return': ['error', { allowElseIf: false }],
+      '@unix/compact-nonblock-statement': [
+        'error',
+        { maxLineLength: prettierPrintWidth },
+      ],
+      '@unix/compact-return-if': 'error',
       '@typescript-eslint/await-thenable': 'error',
       '@typescript-eslint/consistent-generic-constructors': ['error', 'constructor'],
       '@typescript-eslint/consistent-type-exports': 'error',
@@ -188,4 +196,5 @@ export default tseslint.config(
       '@typescript-eslint/unified-signatures': 'error',
     },
   },
+  withTsFiles(prettierRecommended),
 )

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unix/eslint",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "ESLint config for all @unix projects.",
   "type": "module",
   "main": "index.js",
@@ -36,12 +36,13 @@
   },
   "dependencies": {
     "@eslint/js": "^10.0.1",
-    "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.6",
+    "prettier": "^3.8.4",
     "typescript-eslint": "^8.59.2"
   },
   "devDependencies": {
-    "@unix/prettier": "^0.1.0",
-    "prettier": "^3.8.4"
+    "@unix/prettier": "^0.1.0"
   },
   "license": "MIT",
   "scripts": {