xref: /interface/sdk-js/build-tools/api_check_plugin/src/check_syscap.js

/*
 * Copyright (c) 2021-2022 Huawei Device Co., Ltd.
 * 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.
 */

const rules = require('../code_style_rule.json');
const { getAPINote, ErrorType, ErrorLevel, FileType } = require('./utils');
const { addAPICheckErrorLogs } = require('./compile_info');

function checkSyscap(node, sourcefile, fileName) {
  const syscapRuleSet = new Set(rules.syscap.SystemCapability);
  const apiNote = getAPINote(node);
  const apiNoteArr = apiNote.split('*');
  let errorInfo = '';
  apiNoteArr.forEach(note => {
    if (note.match(new RegExp('@syscap'))) {
      const syscapNote = note.replace('@syscap', '').trim();
      if (!syscapRuleSet.has(syscapNote)) {
        if (errorInfo !== '') {
          errorInfo += `,${syscapNote}`;
        } else {
          errorInfo += syscapNote;
        }
        addAPICheckErrorLogs(node, sourcefile, fileName, ErrorType.UNKNOW_SYSCAP, errorInfo, FileType.JSDOC,
          ErrorLevel.MIDDLE);
      }
    }
  });
}
exports.checkSyscap = checkSyscap;