@accordproject/concerto-util/lib/warning.js

Utilities for Concerto Modeling Language

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

'use strict';

let isWarningEmitted = false;

/**
 * Emits DeprecationWaring to stderr only once and can be caught using an warning event listener as well, please define the code
 * and document the deprecation code on https://concerto.accordproject.org/deprecation
 * @param {string} message - message of the deprecation warning
 * @param {string} type - type of the deprecation warning
 * @param {string} code - code of the deprecation warning
 * @param {string} detail - detail of the deprecation warning
 */
function printDeprecationWarning(message, type, code, detail) {
    // This will get pollyfilled in the webpack.config.js as process.emitWarning is not available in the browser
    const customEmitWarning = process.emitWarning;
    if (!isWarningEmitted) {
        isWarningEmitted = true;
        customEmitWarning(`DEPRECATED: ${message}`, {
            type,
            code,
            detail
        });
    }
}

module.exports = {
    printDeprecationWarning
};