commitlint.config.js

const AllowedScopes = ['apollo_batcher',
    'apollo_batcher_types',
    'apollo_central_sync',
    'apollo_class_manager',
    'apollo_class_manager_types',
    'apollo_compilation_utils',
    'apollo_compile_to_casm',
    'apollo_compile_to_casm_types',
    'apollo_compile_to_native',
    'apollo_config',
    'apollo_consensus',
    'apollo_consensus_manager',
    'apollo_consensus_orchestrator',
    'apollo_dashboard',
    'apollo_deployments',
    'apollo_gateway',
    'apollo_gateway_types',
    'apollo_http_server',
    'apollo_infra',
    'apollo_infra_utils',
    'apollo_integration_tests',
    'apollo_l1_endpoint_monitor',
    'apollo_l1_gas_price',
    'apollo_l1_gas_price_types',
    'apollo_l1_provider',
    'apollo_l1_provider_types',
    'apollo_mempool',
    'apollo_mempool_p2p',
    'apollo_mempool_p2p_types',
    'apollo_mempool_types',
    'apollo_metrics',
    'apollo_monitoring_endpoint',
    'apollo_network',
    'apollo_network_types',
    'apollo_node',
    'apollo_p2p_sync',
    'apollo_proc_macros',
    'apollo_protobuf',
    'apollo_reverts',
    'apollo_rpc',
    'apollo_rpc_execution',
    'apollo_signature_manager',
    'apollo_signature_manager_types',
    'apollo_staking',
    'apollo_starknet_client',
    'apollo_starknet_os_program',
    'apollo_state_reader',
    'apollo_state_sync',
    'apollo_state_sync_metrics',
    'apollo_state_sync_types',
    'apollo_storage',
    'apollo_task_executor',
    'apollo_test_utils',
    'apollo_time',
    'batcher',
    'blake2s',
    'blockifier',
    'blockifier_reexecution',
    'blockifier_test_utils',
    'cairo_native',
    'ci',
    'committer',
    'deployment',
    'infra',
    'l1',
    'mempool_test_utils',
    'native_blockifier',
    'papyrus_base_layer',
    'papyrus_common',
    'papyrus_load_test',
    'papyrus_monitoring_gateway',
    'papyrus_node',
    'release',
    'scripts',
    'shared_execution_objects',
    'signature',
    'starknet_api',
    'starknet_committer',
    'starknet_committer_and_os_cli',
    'starknet_os',
    'starknet_os_flow_tests',
    'starknet_patricia',
    'starknet_patricia_storage',
    'time',
    'workspace_tests',
];

const Configuration = {
    /*
     * Resolve and load @commitlint/config-conventional from node_modules.
     * Referenced packages must be installed
     */
    //extends: ['@commitlint/config-conventional'],
    /*
     * Resolve and load conventional-changelog-atom from node_modules.
     * Referenced packages must be installed
     */
    // parserPreset: 'conventional-changelog-atom',
    parserPreset: {
        parserOpts: {
            // Match: "scope1[,scope2...]: subject"
            headerPattern: /^([\w,]+): (.+)$/,
            headerCorrespondence: ['scope', 'subject'],
        },
    },

    plugins: [
        {
            rules: {
                'multi-scope-enum': ({ header }) => {
                    const match = header.match(/^([\w,]+):/);
                    if (!match) return [false, 'Cannot parse header'];

                    const scopes = match[1].split(',').map((s) => s.trim());
                    const invalid = scopes.filter((s) => !AllowedScopes.includes(s));

                    if (invalid.length > 0) {
                        return [false, `Invalid scope(s): ${invalid.join(', ')}`];
                    }
                    return [true];
                },
            },
        },
    ],
    /*
     * Resolve and load @commitlint/format from node_modules.
     * Referenced package must be installed
     */
    formatter: '@commitlint/format',
    /*
     * Any rules defined here will override rules from @commitlint/config-conventional
     */
    rules: {
        'scope-empty': [2, 'never'],
        'scope-enum': [0], // Disable builtin (we validate via plugin).
        'subject-empty': [2, 'never'],
        'multi-scope-enum': [2, 'always'],
        'type-empty': [0], // No type used.
        'type-enum': [0],
        'header-max-length': [2, 'always', 100],
    },
    /*
     * Functions that return true if commitlint should ignore the given message.
     */
    ignores: [(commit) => commit === ''],
    /*
     * Whether commitlint uses the default ignore rules.
     */
    defaultIgnores: true,
    /*
     * Custom URL to show upon failure
     */
    helpUrl:
        'https://github.com/conventional-changelog/commitlint/#what-is-commitlint',
    /*
     * Custom prompt configs, not used currently.
     */
    prompt: {
        messages: {},
        questions: {
            type: {
                description: 'please input type:',
            },
        },
    },
};

module.exports = Configuration;