Sandbox::https://github.com/nokia/spark/blob/master/scalastyle-config.xml

Repository navigation

History

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

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

<!--

~ Licensed to the Apache Software Foundation (ASF) under one or more

~ contributor license agreements. See the NOTICE file distributed with

~ this work for additional information regarding copyright ownership.

~ The ASF licenses this file to You under the Apache License, Version 2.0

~ (the "License"); you may not use this file except in compliance with

~ the License. You may obtain a copy of the License at

~ http://www.apache.org/licenses/LICENSE-2.0

~ Unless required by applicable law or agreed to in writing, software

~ distributed under the License is distributed on an "AS IS" BASIS,

~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

~ See the License for the specific language governing permissions and

~ limitations under the License.

-->

<!--

If you wish to turn off checking for a section of code, you can put a comment in the source

before and after the section, with the following syntax:

// scalastyle:off

... // stuff that breaks the styles

// scalastyle:on

You can also disable only one rule, by specifying its rule id, as specified in:

http://www.scalastyle.org/rules-0.7.0.html

// scalastyle:off no.finalize

override def finalize(): Unit = ...

// scalastyle:on no.finalize

This file is divided into 3 sections:

(1) rules that we enforce.

(2) rules that we would like to enforce, but haven't cleaned up the codebase to turn on yet

(or we need to make the scalastyle rule more configurable).

(3) rules that we don't want to enforce.

-->

<name>Scalastyle standard configuration</name>

<parameter name="header"><![CDATA[/*

* Licensed to the Apache Software Foundation (ASF) under one or more

* contributor license agreements. See the NOTICE file distributed with

* this work for additional information regarding copyright ownership.

* The ASF licenses this file to You under the Apache License, Version 2.0

* (the "License"); you may not use this file except in compliance with

* the License. You may obtain a copy of the License at

* http://www.apache.org/licenses/LICENSE-2.0

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/]]></parameter>

</parameters>

</check>

</parameters>

</check>

</check>

</check>

</check>

</check>

</parameters>

</check>

<parameter name="tokens">ARROW, EQUALS, ELSE, TRY, CATCH, FINALLY, LARROW, RARROW</parameter>

</parameters>

</check>

<parameter name="tokens">ARROW, EQUALS, COMMA, COLON, IF, ELSE, DO, WHILE, FOR, MATCH, TRY, CATCH, FINALLY, LARROW, RARROW</parameter>

</parameters>

</check>

<parameters><parameter name="regex">^FunSuite[A-Za-z]*$</parameter></parameters>

<customMessage>Tests must extend org.apache.spark.SparkFunSuite instead.</customMessage>

</check>

<parameters><parameter name="regex">^println$</parameter></parameters>

<customMessage><![CDATA[Are you sure you want to println? If yes, wrap the code block with

// scalastyle:off println

println(...)

// scalastyle:on println]]></customMessage>

</check>

<parameters><parameter name="regex">spark(.sqlContext)?.sparkContext.hadoopConfiguration</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to use sparkContext.hadoopConfiguration? In most cases, you should use

spark.sessionState.newHadoopConf() instead, so that the hadoop configurations specified in Spark session

configuration will come into effect.

If you must use sparkContext.hadoopConfiguration, wrap the code block with

// scalastyle:off hadoopconfiguration

spark.sparkContext.hadoopConfiguration...

// scalastyle:on hadoopconfiguration

]]></customMessage>

</check>

<parameters><parameter name="regex">@VisibleForTesting</parameter></parameters>

<customMessage><![CDATA[

@VisibleForTesting causes classpath issues. Please note this in the java doc instead (SPARK-11615).

]]></customMessage>

</check>

<parameters><parameter name="regex">Runtime\.getRuntime\.addShutdownHook</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to use Runtime.getRuntime.addShutdownHook? In most cases, you should use

ShutdownHookManager.addShutdownHook instead.

If you must use Runtime.getRuntime.addShutdownHook, wrap the code block with

// scalastyle:off runtimeaddshutdownhook

Runtime.getRuntime.addShutdownHook(...)

// scalastyle:on runtimeaddshutdownhook

]]></customMessage>

</check>

<parameters><parameter name="regex">mutable\.SynchronizedBuffer</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to use mutable.SynchronizedBuffer? In most cases, you should use

java.util.concurrent.ConcurrentLinkedQueue instead.

If you must use mutable.SynchronizedBuffer, wrap the code block with

// scalastyle:off mutablesynchronizedbuffer

mutable.SynchronizedBuffer[...]

// scalastyle:on mutablesynchronizedbuffer

]]></customMessage>

</check>

<parameters><parameter name="regex">Class\.forName</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to use Class.forName? In most cases, you should use Utils.classForName instead.

If you must use Class.forName, wrap the code block with

// scalastyle:off classforname

Class.forName(...)

// scalastyle:on classforname

]]></customMessage>

</check>

<parameters><parameter name="regex">Await\.result</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to use Await.result? In most cases, you should use ThreadUtils.awaitResult instead.

If you must use Await.result, wrap the code block with

// scalastyle:off awaitresult

Await.result(...)

// scalastyle:on awaitresult

]]></customMessage>

</check>

<parameters><parameter name="regex">Await\.ready</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to use Await.ready? In most cases, you should use ThreadUtils.awaitReady instead.

If you must use Await.ready, wrap the code block with

// scalastyle:off awaitready

Await.ready(...)

// scalastyle:on awaitready

]]></customMessage>

</check>

<parameters><parameter name="regex">(\.toUpperCase|\.toLowerCase)(?!($|\(Locale.ROOT$))</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to use toUpperCase or toLowerCase without the root locale? In most cases, you

should use toUpperCase(Locale.ROOT) or toLowerCase(Locale.ROOT) instead.

If you must use toUpperCase or toLowerCase without the root locale, wrap the code block with

// scalastyle:off caselocale

.toUpperCase

.toLowerCase

// scalastyle:on caselocale

]]></customMessage>

</check>

<parameters><parameter name="regex">throw new \w+Error\(</parameter></parameters>

<customMessage><![CDATA[

Are you sure that you want to throw Error? In most cases, you should use appropriate Exception instead.

If you must throw Error, wrap the code block with

// scalastyle:off throwerror

throw new XXXError(...)

// scalastyle:on throwerror

]]></customMessage>

</check>

<parameters><parameter name="regex">JavaConversions</parameter></parameters>

<customMessage>Instead of importing implicits in scala.collection.JavaConversions._, import

scala.collection.JavaConverters._ and use .asScala / .asJava methods</customMessage>

</check>

<parameters><parameter name="regex">org\.apache\.commons\.lang\.</parameter></parameters>

<customMessage>Use Commons Lang 3 classes (package org.apache.commons.lang3.*) instead

of Commons Lang 2 (package org.apache.commons.lang.*)</customMessage>

</check>

<parameters><parameter name="regex">extractOpt</parameter></parameters>

<customMessage>Use jsonOption(x).map(.extract[T]) instead of .extractOpt[T], as the latter

is slower. </customMessage>

</check>

<parameter name="groups">java,scala,3rdParty,spark</parameter>

<parameter name="group.java">javax?\..*</parameter>

<parameter name="group.scala">scala\..*</parameter>

<parameter name="group.3rdParty">(?!org\.apache\.spark\.).*</parameter>

<parameter name="group.spark">org\.apache\.spark\..*</parameter>

</parameters>

</check>

<parameter name="tokens">COMMA</parameter>

</parameters>

</check>

<customMessage><![CDATA[

Single Space between ')' and `{`.

]]></customMessage>

</check>

<customMessage>Use Javadoc style indentation for multiline comments</customMessage>

</check>

<customMessage>Omit braces in case clauses.</customMessage>

</check>

</parameters>

</check>

</check>