|
| 1 | +--- |
| 2 | +title:Biome |
| 3 | +sidebar_label:Biome |
| 4 | +description:CodeRabbit's guide to Biome. |
| 5 | +sidebar_position:5 |
| 6 | +--- |
| 7 | + |
| 8 | +[Biome](https://biomejs.dev/) is linter for JavaScript, TypeScript, JSX, TSX, JSON, JSONC, CSS files. |
| 9 | + |
| 10 | +##Files |
| 11 | + |
| 12 | +Biome will run on files with the following extensions: |
| 13 | + |
| 14 | +-`.js` |
| 15 | +-`.ts` |
| 16 | +-`.cjs` |
| 17 | +-`.mjs` |
| 18 | +-`.d.cts` |
| 19 | +-`.d.mts` |
| 20 | +-`.jsx` |
| 21 | +-`.tsx` |
| 22 | +-`.json` |
| 23 | +-`.jsonc` |
| 24 | +-`.css` |
| 25 | + |
| 26 | +##Configuration |
| 27 | + |
| 28 | +Biome supports the following config files: |
| 29 | + |
| 30 | +-`biome.jsonc` |
| 31 | +-`biome.json` |
| 32 | + |
| 33 | +CodeRabbit will use the following settings based on the profile selected if no config file is found: |
| 34 | + |
| 35 | +###Chill |
| 36 | + |
| 37 | +```json |
| 38 | +{ |
| 39 | +"$schema":"https://biomejs.dev/schemas/1.8.3/schema.json", |
| 40 | +"organizeImports": { |
| 41 | +"enabled":false |
| 42 | + }, |
| 43 | +"formatter": { |
| 44 | +"enabled":false |
| 45 | + }, |
| 46 | +"linter": { |
| 47 | +"enabled":true, |
| 48 | +"rules": { |
| 49 | +"all":false, |
| 50 | +"recommended":true, |
| 51 | +"a11y": { |
| 52 | +"recommended":false |
| 53 | + }, |
| 54 | +"correctness": { |
| 55 | +"useExhaustiveDependencies":"off", |
| 56 | +"noInnerDeclarations":"off" |
| 57 | + }, |
| 58 | +"style": { |
| 59 | +"recommended":false, |
| 60 | +"noArguments":"warn", |
| 61 | +"noCommaOperator":"warn", |
| 62 | +"noUselessElse":"warn", |
| 63 | +"useAsConstAssertion":"off", |
| 64 | +"useBlockStatements":"off", |
| 65 | +"useConsistentArrayType":"off", |
| 66 | +"useDefaultParameterLast":"warn", |
| 67 | +"useEnumInitializers":"off", |
| 68 | +"useExponentiationOperator":"warn", |
| 69 | +"useExportType":"off", |
| 70 | +"useFragmentSyntax":"off", |
| 71 | +"useImportType":"off", |
| 72 | +"useLiteralEnumMembers":"warn", |
| 73 | +"useShorthandArrayType":"off", |
| 74 | +"noUnusedTemplateLiteral":"off" |
| 75 | + }, |
| 76 | +"complexity": { |
| 77 | +"noForEach":"off", |
| 78 | +"noExcessiveCognitiveComplexity": { |
| 79 | +"level":"off", |
| 80 | +"options": { |
| 81 | +"maxAllowedComplexity":25 |
| 82 | + } |
| 83 | + }, |
| 84 | +"useLiteralKeys":"off", |
| 85 | +"useArrowFunction":"off", |
| 86 | +"useFlatMap":"off" |
| 87 | + }, |
| 88 | +"suspicious": { |
| 89 | +"noArrayIndexKey":"off", |
| 90 | +"noExplicitAny":"off", |
| 91 | +"noImplicitAnyLet":"off", |
| 92 | +"noDoubleEquals":"off" |
| 93 | + }, |
| 94 | +"nursery": { |
| 95 | +"all":false |
| 96 | + } |
| 97 | + } |
| 98 | + }, |
| 99 | +"css": { |
| 100 | +"linter": { |
| 101 | +"enabled":true |
| 102 | + }, |
| 103 | +"parser": { |
| 104 | +"cssModules":true |
| 105 | + } |
| 106 | + }, |
| 107 | +"javascript": { |
| 108 | +"parser": { |
| 109 | +"unsafeParameterDecoratorsEnabled":true |
| 110 | + } |
| 111 | + } |
| 112 | +} |
| 113 | +``` |
| 114 | + |
| 115 | +###Assertive |
| 116 | + |
| 117 | +```json |
| 118 | +{ |
| 119 | +"$schema":"https://biomejs.dev/schemas/1.8.3/schema.json", |
| 120 | +"organizeImports": { |
| 121 | +"enabled":false |
| 122 | + }, |
| 123 | +"formatter": { |
| 124 | +"enabled":false |
| 125 | + }, |
| 126 | +"linter": { |
| 127 | +"enabled":true, |
| 128 | +"rules": { |
| 129 | +"all":false, |
| 130 | +"recommended":true, |
| 131 | +"a11y": { |
| 132 | +"recommended":"" |
| 133 | + }, |
| 134 | +"correctness": { |
| 135 | +"useExhaustiveDependencies":"off", |
| 136 | +"noInnerDeclarations":"warn" |
| 137 | + }, |
| 138 | +"style": { |
| 139 | +"recommended":true, |
| 140 | +"noArguments":"warn", |
| 141 | +"noCommaOperator":"warn", |
| 142 | +"noUselessElse":"warn", |
| 143 | +"useAsConstAssertion":"off", |
| 144 | +"useBlockStatements":"off", |
| 145 | +"useConsistentArrayType":"off", |
| 146 | +"useDefaultParameterLast":"warn", |
| 147 | +"useEnumInitializers":"off", |
| 148 | +"useExponentiationOperator":"warn", |
| 149 | +"useExportType":"off", |
| 150 | +"useFragmentSyntax":"off", |
| 151 | +"useImportType":"off", |
| 152 | +"useLiteralEnumMembers":"warn", |
| 153 | +"useShorthandArrayType":"off", |
| 154 | +"noUnusedTemplateLiteral":"off" |
| 155 | + }, |
| 156 | +"complexity": { |
| 157 | +"noForEach":"off", |
| 158 | +"noExcessiveCognitiveComplexity": { |
| 159 | +"level": , |
| 160 | +"options": { |
| 161 | +"maxAllowedComplexity":25 |
| 162 | + } |
| 163 | + }, |
| 164 | +"useLiteralKeys":"off", |
| 165 | +"useArrowFunction":"", |
| 166 | +"useFlatMap":"" |
| 167 | + }, |
| 168 | +"suspicious": { |
| 169 | +"noArrayIndexKey":"", |
| 170 | +"noExplicitAny":"", |
| 171 | +"noImplicitAnyLet":"", |
| 172 | +"noDoubleEquals":"" |
| 173 | + }, |
| 174 | +"nursery": { |
| 175 | +"all":false |
| 176 | + } |
| 177 | + } |
| 178 | + }, |
| 179 | +"css": { |
| 180 | +"linter": { |
| 181 | +"enabled":true |
| 182 | + }, |
| 183 | +"parser": { |
| 184 | +"cssModules":true |
| 185 | + } |
| 186 | + }, |
| 187 | +"javascript": { |
| 188 | +"parser": { |
| 189 | +"unsafeParameterDecoratorsEnabled":true |
| 190 | + } |
| 191 | + } |
| 192 | +} |
| 193 | + |
| 194 | +``` |
| 195 | + |
| 196 | +##Links |
| 197 | + |
| 198 | +-[Biome Configuration](https://biomejs.dev/reference/configuration/) |