devkit/biome/base.jsonc at main · sablier-labs/devkit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
// Sablier Devkit configuration for Biome v2: https://next.biomejs.dev
//
// This is a shared base configuration meant to be extended in consuming projects.
//
// IMPORTANT: Consumers must add their own `files.includes` patterns to specify
// which files to lint and format. For example:
//
//   {
//     "extends": ["@sablier/devkit/biome/base"],
//     "files": {
//       "includes": ["**/*.{css,js,jsx,json,ts,tsx}", "!node_modules"]
//     }
//   }
//
// You may also add override blocks with custom `includes` patterns for
// granular rule customization. See ~/sablier/frontend/ui/biome.jsonc for a
// complete example.
{
  "$schema": "https://biomejs.dev/schemas/latest/schema.json",
  "assist": {
    "enabled": true,
    "actions": {
      "source": {
        "organizeImports": "on",
        "useSortedKeys": {
          "level": "on",
          "options": {
            "groupByNesting": true
          }
        }
      }
    }
  },
  "files": {
    "maxSize": 5242880 // 5MB
  },
  "formatter": {
    "enabled": true,
    "formatWithErrors": true,
    "indentStyle": "space",
    "lineWidth": 100
  },
  // Needed to override ultracite
  "json": {
    "formatter": {
      "lineWidth": 100
    }
  },
  "linter": {
    "enabled": true,
    "rules": {
      "preset": "recommended",
      "complexity": {
        "noImplicitCoercions": "error", // forbid `!!foo`, allow `Boolean(foo)`
        "noVoid": "off", // void is useful in some cases e.g. `useEffect` callbacks
        "useSimplifiedLogicExpression": "off", // the rule is cool but it gets agents stuck
        "noUselessUndefined": "off" // we want explicit undefined return values
      },
      "correctness": {
        "noUnusedImports": "off", // allow unused imports during development
        "noUnusedVariables": "error"
      },
      "nursery": {
        "noFloatingPromises": "error" // floating promises can lead to bugs
      },
      "performance": {
        "noBarrelFile": "off", // barrel exports lead to cleaner imports
        "noDelete": "off", // disabled due to https://github.com/biomejs/biome/issues/4093
        "noNamespaceImport": "off" // namespaces are cool
      },
      "style": {
        "noEnum": "off", // enums are useful in some cases e.g. UI states
        "noNamespace": "off", // namespaces are cool
        "useBlockStatements": "off", // turned off because it gets AIs stuck
        "useDefaultSwitchClause": "off", // already handled by TypeScript
        "useTemplate": "off", // allow string concatenation using `+`
        "useConsistentTypeDefinitions": {
          "level": "warn",
          "options": {
            "style": "type"
          }
        },
        "useFilenamingConvention": {
          "level": "error",
          "options": {
            "filenameCases": ["kebab-case", "camelCase", "PascalCase", "export"]
          }
        },
        // disabled due to https://github.com/biomejs/biome/issues/8450
        "useImportType": {
          "level": "warn",
          "options": {
            "style": "separatedType"
          }
        }
      }
    }
  },
  "overrides": [
    {
      // Disabling sorted keys because ordering is often important in JSON files
      "includes": ["**/*.{json,json5,jsonc}"],
      "assist": {
        "actions": {
          "source": {
            "useSortedKeys": "off"
          }
        }
      },
      // Needed to override ultracite
      "json": {
        "parser": {
          "allowComments": true,
          "allowTrailingCommas": true
        }
      }
    }
  ],
  "vcs": {
    "clientKind": "git",
    "enabled": true,
    "useIgnoreFile": true
  }
}