Skip to content

What is the file_header rule about? #1492

Closed
@Coeur

Description

I do not understand what is the issue reported by the rule file_header.

//
//  ActivityModel.swift
//  English 24/7
//
//  Created by Antoine Cœur on 8/24/16.
//  Copyright © 2016 EF Education. All rights reserved.
//

/MyApp/ActivityModel.swift:6:5: warning: File Header Violation: Files should have consistent header comments. (file_header)

What does it mean?
Does it mean I need to change the Copyright year for all my files on every January 1st?

Activity

added
questionQuestion or doubts that needs discussion and clarification. Can become a bug or proposal.
on May 4, 2017
marcelofabri

marcelofabri commented on May 4, 2017

@marcelofabri
Collaborator

It validates that a certain string or regex should be present (or avoided) on the file header. By the default, this rule warns against occurrences of "Copyright".

You can see an example of how it can be configured on SwiftLint configuration file.

Coeur

Coeur commented on May 5, 2017

@Coeur
Author

OK, so the error message wasn't very informative. I would suggest to change it to something more like:

warning: File Header Violation: Header comments should match the project pattern. (file_header)

marcelofabri

marcelofabri commented on May 5, 2017

@marcelofabri
Collaborator

It's just that the rule can enforce that a certain string/pattern must be avoided as well, so "should match the project pattern" doesn't feel right to me.

But I agree we can have a better message here.

jpsim

jpsim commented on May 30, 2017

@jpsim
Collaborator

Suggestions?

Coeur

Coeur commented on May 30, 2017

@Coeur
Author
  • "Header comments should match or exclude defined project patterns."
  • "Header comments should be consistent with project patterns."
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionQuestion or doubts that needs discussion and clarification. Can become a bug or proposal.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

      Participants

      @jpsim@marcelofabri@Coeur

      Issue actions

        What is the file_header rule about? · Issue #1492 · realm/SwiftLint