@cspell/eslint-plugin 6.19.2 → 6.20.1

package/dist/index.js

@@ -1,621 +1,6 @@
-/*!
- * @cspell/eslint-plugin v6.19.2
- * Copyright 2023 Jason Dent <jason@streetsidesoftware.nl>
- * Released under the MIT License
- * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
- */
-
-'use strict';
-
-var assert = require('assert');
-var cspellLib = require('cspell-lib');
-var path = require('path');
-var util = require('util');
-var fs = require('fs');
-
-function _interopNamespaceDefault(e) {
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var path__namespace = /*#__PURE__*/_interopNamespaceDefault(path);
-var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
-
-var $schema = "http://json-schema.org/draft-07/schema#";
-var additionalProperties = false;
-var definitions = {
-};
-var properties = {
-	checkComments: {
-		"default": true,
-		description: "Spell check comments",
-		type: "boolean"
-	},
-	checkIdentifiers: {
-		"default": true,
-		description: "Spell check identifiers (variables names, function names, class names, etc.)",
-		type: "boolean"
-	},
-	checkJSXText: {
-		"default": true,
-		description: "Spell check JSX Text",
-		type: "boolean"
-	},
-	checkStringTemplates: {
-		"default": true,
-		description: "Spell check template strings",
-		type: "boolean"
-	},
-	checkStrings: {
-		"default": true,
-		description: "Spell check strings",
-		type: "boolean"
-	},
-	customWordListFile: {
-		anyOf: [
-			{
-				description: "Specify a path to a custom word list file",
-				type: "string"
-			},
-			{
-				additionalProperties: false,
-				properties: {
-					addWords: {
-						description: "**Experimental**: Provide a fix option to add words to the file.\n\nNote: this does not yet work perfectly.",
-						type: "boolean"
-					},
-					path: {
-						description: "Path to word list file. File format: 1 word per line",
-						type: "string"
-					}
-				},
-				required: [
-					"path"
-				],
-				type: "object"
-			}
-		],
-		description: "Specify a path to a custom word list file.\n\nexample: ```js customWordListFile: \"./myWords.txt\" ```"
-	},
-	debugMode: {
-		"default": false,
-		description: "Output debug logs",
-		type: "boolean"
-	},
-	generateSuggestions: {
-		"default": true,
-		description: "Generate suggestions",
-		type: "boolean"
-	},
-	ignoreImportProperties: {
-		"default": true,
-		description: "Ignore the properties of imported variables, structures, and types.\n\nExample: ``` import { example } from 'third-party';\n\nconst msg = example.property; // `property` is not spell checked. ```",
-		type: "boolean"
-	},
-	ignoreImports: {
-		"default": true,
-		description: "Ignore import and require names",
-		type: "boolean"
-	},
-	numSuggestions: {
-		"default": 8,
-		description: "Number of spelling suggestions to make.",
-		type: "number"
-	}
-};
-var required = [
-	"numSuggestions",
-	"generateSuggestions"
-];
-var type = "object";
-var optionsSchema = {
-	$schema: $schema,
-	additionalProperties: additionalProperties,
-	definitions: definitions,
-	properties: properties,
-	required: required,
-	type: type
-};
-
-const sortFn = new Intl.Collator().compare;
-function addWordToCustomWordList(customWordListPath, word) {
-    const content = readFile(customWordListPath) || '\n';
-    const lineEndingMatch = content.match(/\r?\n/);
-    const lineEnding = (lineEndingMatch === null || lineEndingMatch === void 0 ? void 0 : lineEndingMatch[0]) || '\n';
-    const words = new Set(content
-        .split(/\n/g)
-        .map((a) => a.trim())
-        .filter((a) => !!a));
-    words.add(word);
-    const lines = [...words];
-    lines.sort(sortFn);
-    writeFile(customWordListPath, lines.join(lineEnding) + lineEnding);
-}
-function readFile(file) {
-    try {
-        return fs__namespace.readFileSync(file, 'utf-8');
-    }
-    catch (e) {
-        return undefined;
-    }
-}
-function writeFile(file, content) {
-    makeDir(path__namespace.dirname(file));
-    fs__namespace.writeFileSync(file, content);
-}
-function makeDir(dir) {
-    try {
-        fs__namespace.mkdirSync(dir, { recursive: true });
-    }
-    catch (e) {
-        console.log(e);
-    }
-}
-
-const defaultCheckOptions = {
-    checkComments: true,
-    checkIdentifiers: true,
-    checkJSXText: true,
-    checkStrings: true,
-    checkStringTemplates: true,
-    customWordListFile: undefined,
-    ignoreImportProperties: true,
-    ignoreImports: true,
-};
-const defaultOptions = {
-    ...defaultCheckOptions,
-    numSuggestions: 8,
-    generateSuggestions: true,
-    debugMode: false,
-};
-function normalizeOptions(opts) {
-    const options = Object.assign({}, defaultOptions, opts || {});
-    return options;
-}
-
-const schema = optionsSchema;
-const messages = {
-    wordUnknown: 'Unknown word: "{{word}}"',
-    wordForbidden: 'Forbidden word: "{{word}}"',
-    suggestWord: '{{word}}',
-    addWordToDictionary: 'Add "{{word}}" to {{dictionary}}',
-};
-const meta = {
-    docs: {
-        description: 'CSpell spellchecker',
-        category: 'Possible Errors',
-        recommended: false,
-    },
-    messages,
-    hasSuggestions: true,
-    schema: [schema],
-};
-const defaultSettings = {
-    patterns: [
-    // @todo: be able to use cooked / transformed strings.
-    // {
-    //     // Do not block unicode escape sequences.
-    //     name: 'js-unicode-escape',
-    //     pattern: /$^/g,
-    // },
-    ],
-};
-let isDebugMode = false;
-function log(...args) {
-    if (!isDebugMode)
-        return;
-    console.log(...args);
-}
-function create(context) {
-    const options = normalizeOptions(context.options[0]);
-    const toIgnore = new Set();
-    const importedIdentifiers = new Set();
-    isDebugMode = options.debugMode || false;
-    isDebugMode && logContext(context);
-    const validator = getDocValidator(context);
-    validator.prepareSync();
-    function checkLiteral(node) {
-        if (!options.checkStrings)
-            return;
-        if (typeof node.value === 'string') {
-            debugNode(node, node.value);
-            if (options.ignoreImports && isImportOrRequired(node))
-                return;
-            if (options.ignoreImportProperties && isImportedProperty(node))
-                return;
-            checkNodeText(node, node.value);
-        }
-    }
-    function checkJSXText(node) {
-        if (!options.checkJSXText)
-            return;
-        if (typeof node.value === 'string') {
-            debugNode(node, node.value);
-            checkNodeText(node, node.value);
-        }
-    }
-    function checkTemplateElement(node) {
-        if (!options.checkStringTemplates)
-            return;
-        debugNode(node, node.value);
-        checkNodeText(node, node.value.cooked || node.value.raw);
-    }
-    function checkIdentifier(node) {
-        debugNode(node, node.name);
-        if (options.ignoreImports) {
-            if (isRawImportIdentifier(node)) {
-                toIgnore.add(node.name);
-                return;
-            }
-            if (isImportIdentifier(node)) {
-                importedIdentifiers.add(node.name);
-                if (isLocalImportIdentifierUnique(node)) {
-                    checkNodeText(node, node.name);
-                }
-                return;
-            }
-            else if (options.ignoreImportProperties && isImportedProperty(node)) {
-                return;
-            }
-        }
-        if (!options.checkIdentifiers)
-            return;
-        if (toIgnore.has(node.name) && !isObjectProperty(node))
-            return;
-        if (skipCheckForRawImportIdentifiers(node))
-            return;
-        checkNodeText(node, node.name);
-    }
-    function checkComment(node) {
-        if (!options.checkComments)
-            return;
-        debugNode(node, node.value);
-        checkNodeText(node, node.value);
-    }
-    function checkNodeText(node, text) {
-        if (!node.range)
-            return;
-        const adj = node.type === 'Literal' ? 1 : 0;
-        const range = [node.range[0] + adj, node.range[1] - adj];
-        const scope = calcScope();
-        const result = validator.checkText(range, text, scope);
-        result.forEach((issue) => reportIssue(issue));
-    }
-    function calcScope(_node) {
-        // inheritance(node);
-        return [];
-    }
-    function isImportIdentifier(node) {
-        const parent = node.parent;
-        if (node.type !== 'Identifier' || !parent)
-            return false;
-        return ((parent.type === 'ImportSpecifier' ||
-            parent.type === 'ImportNamespaceSpecifier' ||
-            parent.type === 'ImportDefaultSpecifier') &&
-            parent.local === node);
-    }
-    function isRawImportIdentifier(node) {
-        const parent = node.parent;
-        if (node.type !== 'Identifier' || !parent)
-            return false;
-        return ((parent.type === 'ImportSpecifier' && parent.imported === node) ||
-            (parent.type === 'ExportSpecifier' && parent.local === node));
-    }
-    function isLocalImportIdentifierUnique(node) {
-        var _a, _b, _c, _d;
-        const parent = getImportParent(node);
-        if (!parent)
-            return true;
-        const { imported, local } = parent;
-        if (imported.name !== local.name)
-            return true;
-        return ((_a = imported.range) === null || _a === void 0 ? void 0 : _a[0]) !== ((_b = local.range) === null || _b === void 0 ? void 0 : _b[0]) && ((_c = imported.range) === null || _c === void 0 ? void 0 : _c[1]) !== ((_d = local.range) === null || _d === void 0 ? void 0 : _d[1]);
-    }
-    function getImportParent(node) {
-        const parent = node.parent;
-        return (parent === null || parent === void 0 ? void 0 : parent.type) === 'ImportSpecifier' ? parent : undefined;
-    }
-    function skipCheckForRawImportIdentifiers(node) {
-        if (options.ignoreImports)
-            return false;
-        const parent = getImportParent(node);
-        return !!parent && parent.imported === node && !isLocalImportIdentifierUnique(node);
-    }
-    function isImportedProperty(node) {
-        const obj = findOriginObject(node);
-        return !!obj && obj.type === 'Identifier' && importedIdentifiers.has(obj.name);
-    }
-    function isObjectProperty(node) {
-        var _a;
-        return ((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) === 'MemberExpression';
-    }
-    function reportIssue(issue) {
-        var _a;
-        const messageId = issue.isFlagged ? 'wordForbidden' : 'wordUnknown';
-        const data = {
-            word: issue.text,
-        };
-        const code = context.getSourceCode();
-        const start = issue.offset;
-        const end = issue.offset + (issue.length || issue.text.length);
-        const startPos = code.getLocFromIndex(start);
-        const endPos = code.getLocFromIndex(end);
-        const loc = { start: startPos, end: endPos };
-        function fixFactory(word) {
-            return (fixer) => fixer.replaceTextRange([start, end], word);
-        }
-        function createSug(word) {
-            const data = { word };
-            const messageId = 'suggestWord';
-            return {
-                messageId,
-                data,
-                fix: fixFactory(word),
-            };
-        }
-        function createAddWordToDictionaryFix(word) {
-            if (!isCustomWordListFile(options.customWordListFile) || !options.customWordListFile.addWords) {
-                return undefined;
-            }
-            const dictFile = path__namespace.resolve(context.getCwd(), options.customWordListFile.path);
-            const data = { word, dictionary: path__namespace.basename(dictFile) };
-            const messageId = 'addWordToDictionary';
-            return {
-                messageId,
-                data,
-                fix: (_fixer) => {
-                    // This wrapper is a hack to delay applying the fix until it is actually used.
-                    // But it is not reliable, since ESLint + extension will randomly read the value.
-                    return new WrapFix({ range: [start, end], text: word }, () => {
-                        cspellLib.refreshDictionaryCache(0);
-                        addWordToCustomWordList(dictFile, word);
-                        validator.updateDocumentText(context.getSourceCode().getText());
-                    });
-                },
-            };
-        }
-        log('Suggestions: %o', issue.suggestions);
-        const suggestions = (_a = issue.suggestions) === null || _a === void 0 ? void 0 : _a.map(createSug);
-        const addWordFix = createAddWordToDictionaryFix(issue.text);
-        const suggest = suggestions || addWordFix ? (suggestions || []).concat(addWordFix ? [addWordFix] : []) : undefined;
-        const des = {
-            messageId,
-            data,
-            loc,
-            suggest,
-        };
-        context.report(des);
-    }
-    context
-        .getSourceCode()
-        .getAllComments()
-        .forEach(function (commentNode) {
-        checkComment(commentNode);
-    });
-    return {
-        Literal: checkLiteral,
-        TemplateElement: checkTemplateElement,
-        Identifier: checkIdentifier,
-        JSXText: checkJSXText,
-    };
-    function mapNode(node, index, nodes) {
-        const child = nodes[index + 1];
-        if (node.type === 'ImportSpecifier') {
-            const extra = node.imported === child ? '.imported' : node.local === child ? '.local' : '';
-            return node.type + extra;
-        }
-        if (node.type === 'ImportDeclaration') {
-            const extra = node.source === child ? '.source' : '';
-            return node.type + extra;
-        }
-        if (node.type === 'ExportSpecifier') {
-            const extra = node.exported === child ? '.exported' : node.local === child ? '.local' : '';
-            return node.type + extra;
-        }
-        if (node.type === 'ExportNamedDeclaration') {
-            const extra = node.source === child ? '.source' : '';
-            return node.type + extra;
-        }
-        if (node.type === 'Property') {
-            const extra = node.key === child ? 'key' : node.value === child ? 'value' : '';
-            return [node.type, node.kind, extra].join('.');
-        }
-        if (node.type === 'MemberExpression') {
-            const extra = node.property === child ? 'property' : node.object === child ? 'object' : '';
-            return node.type + '.' + extra;
-        }
-        if (node.type === 'ArrowFunctionExpression') {
-            const extra = node.body === child ? 'body' : 'param';
-            return node.type + '.' + extra;
-        }
-        if (node.type === 'FunctionDeclaration') {
-            const extra = node.id === child ? 'id' : node.body === child ? 'body' : 'params';
-            return node.type + '.' + extra;
-        }
-        if (node.type === 'ClassDeclaration' || node.type === 'ClassExpression') {
-            const extra = node.id === child ? 'id' : node.body === child ? 'body' : 'superClass';
-            return node.type + '.' + extra;
-        }
-        if (node.type === 'CallExpression') {
-            const extra = node.callee === child ? 'callee' : 'arguments';
-            return node.type + '.' + extra;
-        }
-        if (node.type === 'Literal') {
-            return tagLiteral(node);
-        }
-        if (node.type === 'Block') {
-            return node.value[0] === '*' ? 'Comment.docBlock' : 'Comment.block';
-        }
-        if (node.type === 'Line') {
-            return 'Comment.line';
-        }
-        return node.type;
-    }
-    function inheritance(node) {
-        const a = [...context.getAncestors(), node];
-        return a.map(mapNode);
-    }
-    function inheritanceSummary(node) {
-        return inheritance(node).join(' ');
-    }
-    /**
-     * find the origin of a member expression
-     */
-    function findOriginObject(node) {
-        const parent = node.parent;
-        if ((parent === null || parent === void 0 ? void 0 : parent.type) !== 'MemberExpression' || parent.property !== node)
-            return undefined;
-        let obj = parent.object;
-        while (obj.type === 'MemberExpression') {
-            obj = obj.object;
-        }
-        return obj;
-    }
-    function isFunctionCall(node, name) {
-        return (node === null || node === void 0 ? void 0 : node.type) === 'CallExpression' && node.callee.type === 'Identifier' && node.callee.name === name;
-    }
-    function isRequireCall(node) {
-        return isFunctionCall(node, 'require');
-    }
-    function isImportOrRequired(node) {
-        var _a;
-        return isRequireCall(node.parent) || (((_a = node.parent) === null || _a === void 0 ? void 0 : _a.type) === 'ImportDeclaration' && node.parent.source === node);
-    }
-    function debugNode(node, value) {
-        if (!isDebugMode)
-            return;
-        const val = util.format('%o', value);
-        log(`${inheritanceSummary(node)}: ${val}`);
-    }
-}
-function tagLiteral(node) {
-    var _a;
-    assert(node.type === 'Literal');
-    const kind = typeof node.value;
-    const extra = kind === 'string'
-        ? ((_a = node.raw) === null || _a === void 0 ? void 0 : _a[0]) === '"'
-            ? 'string.double'
-            : 'string.single'
-        : node.value === null
-            ? 'null'
-            : kind;
-    return node.type + '.' + extra;
-}
-const rules = {
-    spellchecker: {
-        meta,
-        create,
-    },
-};
-function logContext(context) {
-    log('\n\n************************');
-    // log(context.getSourceCode().text);
-    log(`
-
-id: ${context.id}
-cwd: ${context.getCwd()}
-filename: ${context.getFilename()}
-physicalFilename: ${context.getPhysicalFilename()}
-scope: ${context.getScope().type}
-`);
-}
-const configs = {
-    recommended: {
-        plugins: ['@cspell'],
-        rules: {
-            '@cspell/spellchecker': ['warn', {}],
-        },
-    },
-    debug: {
-        plugins: ['@cspell'],
-        rules: {
-            '@cspell/spellchecker': ['warn', { debugMode: true }],
-        },
-    },
-};
-const cache = { lastDoc: undefined };
-const docValCache = new WeakMap();
-function getDocValidator(context) {
-    const text = context.getSourceCode().getText();
-    const doc = getTextDocument(context.getFilename(), text);
-    const cachedValidator = docValCache.get(doc);
-    if (cachedValidator) {
-        cspellLib.refreshDictionaryCache(0);
-        cachedValidator.updateDocumentText(text);
-        return cachedValidator;
-    }
-    const options = normalizeOptions(context.options[0]);
-    const settings = calcInitialSettings(options, context.getCwd());
-    isDebugMode = options.debugMode || false;
-    isDebugMode && logContext(context);
-    const validator = new cspellLib.DocumentValidator(doc, options, settings);
-    docValCache.set(doc, validator);
-    return validator;
-}
-function calcInitialSettings(options, cwd) {
-    const { customWordListFile } = options;
-    if (!customWordListFile)
-        return defaultSettings;
-    const filePath = isCustomWordListFile(customWordListFile) ? customWordListFile.path : customWordListFile;
-    const dictFile = path__namespace.resolve(cwd, filePath);
-    const settings = {
-        ...defaultSettings,
-        dictionaryDefinitions: [{ name: 'eslint-plugin-custom-words', path: dictFile }],
-        dictionaries: ['eslint-plugin-custom-words'],
-    };
-    return settings;
-}
-function getTextDocument(filename, content) {
-    var _a;
-    if (((_a = cache.lastDoc) === null || _a === void 0 ? void 0 : _a.filename) === filename) {
-        return cache.lastDoc.doc;
-    }
-    const doc = cspellLib.createTextDocument({ uri: filename, content });
-    cache.lastDoc = { filename, doc };
-    return doc;
-}
-/**
- * This wrapper is used to add a
- */
-class WrapFix {
-    /**
-     *
-     * @param fix - the example Fix
-     * @param onGetText - called when `fix.text` is accessed
-     * @param limit - limit the number of times onGetText is called. Set it to `-1` for infinite.
-     */
-    constructor(fix, onGetText, limit = 1) {
-        this.fix = fix;
-        this.onGetText = onGetText;
-        this.limit = limit;
-    }
-    get range() {
-        return this.fix.range;
-    }
-    get text() {
-        if (this.limit) {
-            this.limit--;
-            this.onGetText();
-        }
-        return this.fix.text;
-    }
-}
-function isCustomWordListFile(value) {
-    return !!value && typeof value === 'object';
-}
-
-exports.configs = configs;
-exports.rules = rules;
-//# sourceMappingURL=index.js.map
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rules = exports.configs = void 0;
+var cspell_eslint_plugin_1 = require("./cspell-eslint-plugin");
+Object.defineProperty(exports, "configs", { enumerable: true, get: function () { return cspell_eslint_plugin_1.configs; } });
+Object.defineProperty(exports, "rules", { enumerable: true, get: function () { return cspell_eslint_plugin_1.rules; } });

package/dist/options.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeOptions = exports.defaultOptions = exports.defaultCheckOptions = void 0;
+exports.defaultCheckOptions = {
+    checkComments: true,
+    checkIdentifiers: true,
+    checkJSXText: true,
+    checkStrings: true,
+    checkStringTemplates: true,
+    customWordListFile: undefined,
+    ignoreImportProperties: true,
+    ignoreImports: true,
+};
+exports.defaultOptions = {
+    ...exports.defaultCheckOptions,
+    numSuggestions: 8,
+    generateSuggestions: true,
+    debugMode: false,
+};
+function normalizeOptions(opts, cwd) {
+    const options = Object.assign({}, exports.defaultOptions, opts || {}, { cwd });
+    return options;
+}
+exports.normalizeOptions = normalizeOptions;