Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CODEOWNERS lexer #1969

Merged
merged 1 commit into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/Languages.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,24 +23,25 @@
- BrightScript (`brightscript`)
- 1C (BSL) (`bsl`)
- C (`c`)
- Ceylon (`ceylon`)
- C# (`csharp`)
- C++ (`cpp`)
- CFScript (`cfscript`)
- CMHG (`cmhg`)
- CMake (`cmake`)
- CODEOWNERS (`codeowners`)
- CSS (`css`)
- CSV Schema (`csvs`)
- CUDA (`cuda`)
- Ceylon (`ceylon`)
- Cisco IOS (`cisco_ios`)
- Clean (`clean`)
- Clojure (`clojure`)
- CMake (`cmake`)
- CMHG (`cmhg`)
- CoffeeScript (`coffeescript`)
- Common Lisp (`common_lisp`)
- Config File (`conf`)
- Console (`console`)
- Coq (`coq`)
- C++ (`cpp`)
- Crystal (`crystal`)
- C# (`csharp`)
- CSS (`css`)
- csvs (`csvs`)
- CUDA (`cuda`)
- Cypher (`cypher`)
- Cython (`cython`)
- D (`d`)
Expand Down
6 changes: 6 additions & 0 deletions lib/rouge/demos/codeowners
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Specify a default Code Owner by using a wildcard:
* @default-codeowner

/docs/ @all-docs

[Development] @dev-team
30 changes: 30 additions & 0 deletions lib/rouge/lexers/codeowners.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# -*- coding: utf-8 -*- #
# frozen_string_literal: true

module Rouge
module Lexers
class Codeowners < RegexLexer
title 'CODEOWNERS'
desc 'Code Owners syntax (https://docs.gitlab.com/ee/user/project/codeowners/reference.html)'
tag 'codeowners'
filenames 'CODEOWNERS'

state :root do
rule %r/[ \t\r\n]+/, Text::Whitespace
rule %r/^\s*#.*$/, Comment::Single

rule %r(
(\^?\[(?!\d+\])[^\]]+\])
(\[\d+\])?
)x do
groups Name::Namespace, Literal::Number
end

rule %r/\S*@\S+/, Name::Function

rule %r/[\p{Word}\.\/\-\*]+/, Name
rule %r/.*\\[\#\s]/, Name
end
end
end
end
87 changes: 87 additions & 0 deletions spec/visual/samples/codeowners
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
# This is an example of a CODEOWNERS file.
# Lines that start with `#` are ignored.

# app/ @commented-rule

# Specify a default Code Owner by using a wildcard:
* @default-codeowner

# Specify multiple Code Owners by using a tab or space:
* @multiple @code @owners

# Rules defined later in the file take precedence over the rules
# defined before.
# For example, for all files with a filename ending in `.rb`:
*.rb @ruby-owner

# Files with a `#` can still be accessed by escaping the pound sign:
\#file_with_pound.rb @owner-file-with-pound

# Specify multiple Code Owners separated by spaces or tabs.
# In the following case the CODEOWNERS file from the root of the repo
# has 3 Code Owners (@multiple @code @owners):
CODEOWNERS @multiple @code @owners

# You can use both usernames or email addresses to match
# users. Everything else is ignored. For example, this code
# specifies the `@legal` and a user with email `janedoe@gitlab.com` as the
# owner for the LICENSE file:
LICENSE @legal this_does_not_match janedoe@gitlab.com

# Use group names to match groups, and nested groups to specify
# them as owners for a file:
README @group @group/with-nested/subgroup

# End a path in a `/` to specify the Code Owners for every file
# nested in that directory, on any level:
/docs/ @all-docs

# End a path in `/*` to specify Code Owners for every file in
# a directory, but not nested deeper. This code matches
# `docs/index.md` but not `docs/projects/index.md`:
/docs/* @root-docs

# Include `/**` to specify Code Owners for all subdirectories
# in a directory. This rule matches `docs/projects/index.md` or
# `docs/development/index.md`
/docs/**/*.md @root-docs

# This code makes matches a `lib` directory nested anywhere in the repository:
lib/ @lib-owner

# This code match only a `config` directory in the root of the repository:
/config/ @config-owner

# If the path contains spaces, escape them like this:
path\ with\ spaces/ @space-owner

# Code Owners section:
[Documentation]
ee/docs @docs
docs @docs

# Use of default owners for a section. In this case, all files (*) are owned by
# the dev team except the README.md and data-models which are owned by other teams.
[Development] @dev-team
*
README.md @docs-team
data-models/ @data-science-team

# This section is combined with the previously defined [Documentation] section:
[DOCUMENTATION]
README.md @docs

# Required section
[Section name]

# Optional section
^[Section name]

# Section requiring 5 approvals
[Section name][5]

# Section with @username as default owner
[Section name] @username

# Section with @group and @subgroup as default owners and requiring 2 approvals
[Section name][2] @group @subgroup