file_header rule

[arlovip]

I don't know why file_header rule has no any effects when the project was compiled in Xcode 8.2. I tried testing it so many times, but it still right all the time. And the filename is "ViewController.swift". But the rule name "Bar.swift" should violate the rule. is it configured or understood wrongly?

//
//  Bar.swift
//  MissU2
//
//  Created by Odom_Sheng on 2017/1/19.
//  Copyright © 2017年 Xinguang. All rights reserved.
//

[ghost]

Would you please post (or link) to a copy of your .swiftlint.yml file so that we can check how it's configured?

[arlovip]

Thanks for so quick reply. I configure .swiftlint.yml on terminal. And I want to make some rules generate error messages but not warnings. Some configurations in .swiftlint.yml as follows:

disabled_rules:
  - todo
  - valid_docs
  - first_where
excluded:
  - Pods
colon:
  severity: error
variable_name:
  min_length:
    error: 3
  excluded:
    - id
vertical_whitespace:
  severity: error
file_header: error --------------no effect?
empty_count: error ------------no effect?
explicit_init: error
...and so on

I know file_header rule just generate warning on terminal. Even though I don't configure it with error message, it still does not generate any warning or error?

[ghost]

I believe that file_header requires either at least one of the following properties for it to be applied:

• required_string
• required_pattern
• forbidden_string
• forbidden_pattern

As an example, see:

SwiftLint/.swiftlint.yml

Lines 24 to 32 in ad10f81

	file_header:
	required_pattern: |
	\/\/
	\/\/ .*?\.swift
	\/\/ SwiftLint
	\/\/
	\/\/ Created by .*? on \d{1,2}\/\d{1,2}\/\d{2}\.
	\/\/ Copyright © \d{4} Realm\. All rights reserved\.
	\/\/

[arlovip]

Thank you so much. I will have a try.

[jpsim]

Correct, and error needs to be set as the severity, it can't just be implicitly the only value in the rule's YAML dictionary.

[marcelofabri]

@Jacklchen were you able to fix the issue?

[mgrebenets]

The rule doesn't seem to work for me.

We have very simple copyright header - just one line:

// Copyright (c) 2015 Company. All rights reserved.

I tried a lot of combinations, for example:

file_header:
  required_string: //  Wrong

I just wanted the rule to fail, but nothing happens.
I tried all kinds of combinations I could think of:

  required_string: //  Wrong
  required_string: "//  Wrong"
  required_pattern: //  Wrong
  required_pattern: \/\/  Wrong
  required_pattern: \/\/  Wrong.*

and so on ... - no success either

I used the --no-cache option for lint command - same

I know that the linter works - I can see other rules being reported.

The SwiftLint version that I use is 0.16.1.

[mgrebenets]

Actually, my bad.

I absolutely missed the fact that this is an opt-in rule.
So I had to add it as opt-in rule and it started working then 👍

I believe @Jacklchen hasn't added it to opt_in_rules either.

Probably it would make it helpful if SwiftLint could display some kind of warning, when a configuration for opt-in rule is present, but the rule itself is "opted-out" (not enabled).

To be honest, until today I couldn't clearly understand what did "opt-in rule" actually mean ...

[marcelofabri]

@mgrebenets I've filled #1350 to track your idea.

@Jacklchen I'm closing this since we haven't heard from you in a while. Feel free to reopen if you have more questions related to this issue.