Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Address 3180: Rule file-header should have an option to allow // comments #4560

Merged
merged 4 commits into from
Mar 21, 2019
Merged

Address 3180: Rule file-header should have an option to allow // comments #4560

merged 4 commits into from
Mar 21, 2019

Conversation

rrogowski
Copy link
Contributor

@rrogowski rrogowski commented Feb 28, 2019

PR checklist

Overview of change:

Config

{
  "rules": {
    "file-header": [true, "Good header", "", "allow-multiline"]
  }
}

Before

// **********************************
~nil [missing file header]
// Good header
// **********************************

After

// **********************************
// Good header
// **********************************

// No lint error for missing file header

CHANGELOG.md entry:

[new-rule-option] allow-single-line-comments for file-header rule

Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Implementation details LGTM, just waiting on the options object.

src/rules/fileHeaderRule.ts Show resolved Hide resolved
src/rules/fileHeaderRule.ts Show resolved Hide resolved
src/rules/fileHeaderRule.ts Outdated Show resolved Hide resolved
@rrogowski rrogowski changed the title Address 3810: Rule file-header should have an option to allow // comments Address 3180: Rule file-header should have an option to allow // comments Mar 19, 2019
@rrogowski
Copy link
Contributor Author

@adidahiya @JoshuaKGoldberg ready for second review.

Copy link
Contributor

@adidahiya adidahiya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

allow-single-line-comments

src/rules/fileHeaderRule.ts Outdated Show resolved Hide resolved
@rrogowski
Copy link
Contributor Author

@adidahiya Thanks for your comments. They have been addressed. Ready for another pass.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rule file-header should have an option to allow // comments
3 participants