@zzzen/pyright-internal 1.1.255 → 1.2.0-dev.20220703

package/src/analyzer/commentUtils.ts

@@ -1,174 +0,0 @@
-/*
- * commentUtils.ts
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT license.
- * Author: Eric Traut
- *
- * Utility functions that parse comments and extract commands
- * or other directives from them.
- */
-
-import {
-    cloneDiagnosticRuleSet,
-    DiagnosticLevel,
-    DiagnosticRuleSet,
-    getBasicDiagnosticRuleSet,
-    getBooleanDiagnosticRules,
-    getDiagLevelDiagnosticRules,
-    getStrictDiagnosticRuleSet,
-    getStrictModeNotOverriddenRules,
-} from '../common/configOptions';
-import { DiagnosticRule } from '../common/diagnosticRules';
-import { TextRangeCollection } from '../common/textRangeCollection';
-import { Token } from '../parser/tokenizerTypes';
-
-export function getFileLevelDirectives(
-    tokens: TextRangeCollection<Token>,
-    defaultRuleSet: DiagnosticRuleSet,
-    useStrict: boolean
-): DiagnosticRuleSet {
-    let ruleSet = cloneDiagnosticRuleSet(defaultRuleSet);
-
-    if (useStrict) {
-        _applyStrictRules(ruleSet);
-    }
-
-    for (let i = 0; i < tokens.count; i++) {
-        const token = tokens.getItemAt(i);
-        if (token.comments) {
-            for (const comment of token.comments) {
-                const value = comment.value.trim();
-
-                ruleSet = _parsePyrightComment(value, ruleSet);
-            }
-        }
-    }
-
-    return ruleSet;
-}
-
-function _applyStrictRules(ruleSet: DiagnosticRuleSet) {
-    _overrideRules(ruleSet, getStrictDiagnosticRuleSet(), getStrictModeNotOverriddenRules());
-}
-
-function _applyBasicRules(ruleSet: DiagnosticRuleSet) {
-    _overrideRules(ruleSet, getBasicDiagnosticRuleSet(), []);
-}
-
-function _overrideRules(
-    ruleSet: DiagnosticRuleSet,
-    overrideRuleSet: DiagnosticRuleSet,
-    skipRuleNames: DiagnosticRule[]
-) {
-    const boolRuleNames = getBooleanDiagnosticRules();
-    const diagRuleNames = getDiagLevelDiagnosticRules();
-
-    // Enable the strict rules as appropriate.
-    for (const ruleName of boolRuleNames) {
-        if (skipRuleNames.find((r) => r === ruleName)) {
-            continue;
-        }
-
-        if ((overrideRuleSet as any)[ruleName]) {
-            (ruleSet as any)[ruleName] = true;
-        }
-    }
-
-    for (const ruleName of diagRuleNames) {
-        if (skipRuleNames.find((r) => r === ruleName)) {
-            continue;
-        }
-
-        const overrideValue: DiagnosticLevel = (overrideRuleSet as any)[ruleName];
-        const prevValue: DiagnosticLevel = (ruleSet as any)[ruleName];
-
-        // Override only if the new value is more strict than the existing value.
-        if (
-            overrideValue === 'error' ||
-            (overrideValue === 'warning' && prevValue !== 'error') ||
-            (overrideValue === 'information' && prevValue !== 'error' && prevValue !== 'warning')
-        ) {
-            (ruleSet as any)[ruleName] = overrideValue;
-        }
-    }
-}
-
-function _parsePyrightComment(commentValue: string, ruleSet: DiagnosticRuleSet) {
-    // Is this a pyright or mspython-specific comment?
-    const validPrefixes = ['pyright:', 'mspython:'];
-    const prefix = validPrefixes.find((p) => commentValue.startsWith(p));
-    if (prefix) {
-        const operands = commentValue.substr(prefix.length).trim();
-        const operandList = operands.split(',').map((s) => s.trim());
-
-        // If it contains a "strict" operand, replace the existing
-        // diagnostic rules with their strict counterparts.
-        if (operandList.some((s) => s === 'strict')) {
-            _applyStrictRules(ruleSet);
-        } else if (operandList.some((s) => s === 'basic')) {
-            _applyBasicRules(ruleSet);
-        }
-
-        for (const operand of operandList) {
-            ruleSet = _parsePyrightOperand(operand, ruleSet);
-        }
-    }
-
-    return ruleSet;
-}
-
-function _parsePyrightOperand(operand: string, ruleSet: DiagnosticRuleSet) {
-    const operandSplit = operand.split('=').map((s) => s.trim());
-    if (operandSplit.length !== 2) {
-        return ruleSet;
-    }
-
-    const ruleName = operandSplit[0];
-    const boolRules = getBooleanDiagnosticRules();
-    const diagLevelRules = getDiagLevelDiagnosticRules();
-
-    if (diagLevelRules.find((r) => r === ruleName)) {
-        const diagLevelValue = _parseDiagLevel(operandSplit[1]);
-        if (diagLevelValue !== undefined) {
-            (ruleSet as any)[ruleName] = diagLevelValue;
-        }
-    } else if (boolRules.find((r) => r === ruleName)) {
-        const boolValue = _parseBoolSetting(operandSplit[1]);
-        if (boolValue !== undefined) {
-            (ruleSet as any)[ruleName] = boolValue;
-        }
-    }
-
-    return ruleSet;
-}
-
-function _parseDiagLevel(value: string): DiagnosticLevel | undefined {
-    switch (value) {
-        case 'false':
-        case 'none':
-            return 'none';
-
-        case 'true':
-        case 'error':
-            return 'error';
-
-        case 'warning':
-            return 'warning';
-
-        case 'information':
-            return 'information';
-
-        default:
-            return undefined;
-    }
-}
-
-function _parseBoolSetting(value: string): boolean | undefined {
-    if (value === 'false') {
-        return false;
-    } else if (value === 'true') {
-        return true;
-    }
-
-    return undefined;
-}