@accordproject/concerto-linter/default-ruleset/src/string-length-validator.ts

Concerto Linter using Spectral rulesets

/*
 * 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.
 */

import { checkLengthValidator } from './functions/check-length-validator';

/**
 * Rule: String Length
 * ---------------------------
 * Ensures that all string within the data model have a length validator applied.
 * Which helps prevent inconsistent data length and ensure proper storage."
 */
export default {
    given: [
        '$.models[*].declarations[?(@.$class=="concerto.metamodel@1.0.0.StringScalar")]',
        '$.models[*].declarations[*].properties[?(@.$class=="concerto.metamodel@1.0.0.StringProperty")]'
    ],
    severity: 0, // 0 = error, 1 = warning, 2 = info, 3 = hint
    then: {
        function: checkLengthValidator,
    },
};