commitlint-custom-rule.yml

/*
 * Copyright (c) 2022  Thiago Lopes da Silva
 *
 * Licensed 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.
 */

module.exports = {
  parserPreset: {
    parserOpts: { headerPattern: /^([^\(\):]*)(?:\((.*)\))?!?: (.*)$/ }
  },
  extends: ['@commitlint/config-conventional'],
  rules: {
    "type-enum": [0, "always"],
    "type-enum/check-jira-branch-pattern": [2,"always"]
  },
  plugins: [
    {
      rules: {
        'type-enum/check-jira-branch-pattern': (parsed, when, _) => {

          const JIRA_PATTERN = /project-[0-9]+$/gm;
          const branchName = parsed.type;
          console.log(branchName, branchName.match(JIRA_PATTERN))

          if ((!branchName || !branchName.match(JIRA_PATTERN)) && when === 'always') {
            return [false, `the branch name must follow the pattern ${JIRA_PATTERN}`]
          }
          return [true];
        },
      },
    },
  ]
}