@cspell/eslint-plugin 5.18.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jason Dent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# `@cspell/eslint-plugin-cspell`
+
+**[WIP]** A CSpell Plugin for ESLint.

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import { Rule } from 'eslint';
+
+interface PluginRules {
+    ['cspell']: Rule.RuleModule;
+}
+declare const rules: PluginRules;
+
+export { rules };

package/dist/index.js

@@ -0,0 +1,159 @@
+/*!
+ * @cspell/eslint-plugin v5.18.5
+ * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
+ * Released under the MIT License
+ * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
+ */
+
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var assert = require('assert');
+var util = require('util');
+var cspellLib = require('cspell-lib');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var assert__default = /*#__PURE__*/_interopDefaultLegacy(assert);
+
+const meta = {
+    docs: {
+        description: 'CSpell',
+    },
+};
+const defaultSettings = {
+    patterns: [
+    // @todo: be able to use cooked / transformed strings.
+    // {
+    //     // Do not block unicode escape sequences.
+    //     name: 'js-unicode-escape',
+    //     pattern: /$^/g,
+    // },
+    ],
+};
+const log = () => undefined;
+function create(context) {
+    const doc = cspellLib.createTextDocument({ uri: context.getFilename(), content: context.getSourceCode().getText() });
+    const validator = new cspellLib.DocumentValidator(doc, {}, defaultSettings);
+    validator.prepareSync();
+    log(`
+
+id: ${context.id}
+cwd: ${context.getCwd()}
+filename: ${context.getFilename()}
+physicalFilename: ${context.getPhysicalFilename()}
+scope: ${context.getScope().type}
+`);
+    function checkLiteral(node) {
+        if (typeof node.value === 'string') {
+            checkNodeText(node, node.value);
+        }
+    }
+    function checkTemplateElement(node) {
+        // console.log('Template: %o', node.value);
+        checkNodeText(node, node.value.cooked || node.value.raw);
+    }
+    function checkIdentifier(node) {
+        checkNodeText(node, node.name);
+    }
+    function checkComment(node) {
+        checkNodeText(node, node.value);
+        util.format('%o', node);
+    }
+    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 = inheritance(node);
+        const result = validator.checkText(range, text, scope);
+        result.forEach((issue) => reportIssue(issue));
+    }
+    function reportIssue(issue) {
+        // const messageId = issue.isFlagged ? 'cspell-forbidden-word' : 'cspell-unknown-word';
+        const messageType = issue.isFlagged ? 'Forbidden' : 'Unknown';
+        const message = `${messageType} word: "${issue.text}"`;
+        const code = context.getSourceCode();
+        const start = code.getLocFromIndex(issue.offset);
+        const end = code.getLocFromIndex(issue.offset + (issue.length || issue.text.length));
+        const loc = { start, end };
+        const des = {
+            message,
+            loc,
+        };
+        context.report(des);
+    }
+    context
+        .getSourceCode()
+        .getAllComments()
+        .forEach(function (commentNode) {
+        checkComment(commentNode);
+    });
+    return {
+        Literal: checkLiteral,
+        TemplateElement: checkTemplateElement,
+        Identifier: checkIdentifier,
+    };
+    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 === '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 === 'Literal') {
+            return tagLiteral(node);
+        }
+        return node.type;
+    }
+    function inheritance(node) {
+        const a = [...context.getAncestors(), node];
+        return a.map(mapNode);
+    }
+}
+function tagLiteral(node) {
+    var _a;
+    assert__default["default"](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 = {
+    cspell: {
+        meta,
+        create,
+    },
+};
+
+exports.rules = rules;
+//# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -0,0 +1,151 @@
+/*!
+ * @cspell/eslint-plugin v5.18.5
+ * Copyright 2022 Jason Dent <jason@streetsidesoftware.nl>
+ * Released under the MIT License
+ * https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme
+ */
+
+import assert from 'assert';
+import { format } from 'util';
+import { createTextDocument, DocumentValidator } from 'cspell-lib';
+
+const meta = {
+    docs: {
+        description: 'CSpell',
+    },
+};
+const defaultSettings = {
+    patterns: [
+    // @todo: be able to use cooked / transformed strings.
+    // {
+    //     // Do not block unicode escape sequences.
+    //     name: 'js-unicode-escape',
+    //     pattern: /$^/g,
+    // },
+    ],
+};
+const log = () => undefined;
+function create(context) {
+    const doc = createTextDocument({ uri: context.getFilename(), content: context.getSourceCode().getText() });
+    const validator = new DocumentValidator(doc, {}, defaultSettings);
+    validator.prepareSync();
+    log(`
+
+id: ${context.id}
+cwd: ${context.getCwd()}
+filename: ${context.getFilename()}
+physicalFilename: ${context.getPhysicalFilename()}
+scope: ${context.getScope().type}
+`);
+    function checkLiteral(node) {
+        if (typeof node.value === 'string') {
+            checkNodeText(node, node.value);
+        }
+    }
+    function checkTemplateElement(node) {
+        // console.log('Template: %o', node.value);
+        checkNodeText(node, node.value.cooked || node.value.raw);
+    }
+    function checkIdentifier(node) {
+        checkNodeText(node, node.name);
+    }
+    function checkComment(node) {
+        checkNodeText(node, node.value);
+        format('%o', node);
+    }
+    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 = inheritance(node);
+        const result = validator.checkText(range, text, scope);
+        result.forEach((issue) => reportIssue(issue));
+    }
+    function reportIssue(issue) {
+        // const messageId = issue.isFlagged ? 'cspell-forbidden-word' : 'cspell-unknown-word';
+        const messageType = issue.isFlagged ? 'Forbidden' : 'Unknown';
+        const message = `${messageType} word: "${issue.text}"`;
+        const code = context.getSourceCode();
+        const start = code.getLocFromIndex(issue.offset);
+        const end = code.getLocFromIndex(issue.offset + (issue.length || issue.text.length));
+        const loc = { start, end };
+        const des = {
+            message,
+            loc,
+        };
+        context.report(des);
+    }
+    context
+        .getSourceCode()
+        .getAllComments()
+        .forEach(function (commentNode) {
+        checkComment(commentNode);
+    });
+    return {
+        Literal: checkLiteral,
+        TemplateElement: checkTemplateElement,
+        Identifier: checkIdentifier,
+    };
+    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 === '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 === 'Literal') {
+            return tagLiteral(node);
+        }
+        return node.type;
+    }
+    function inheritance(node) {
+        const a = [...context.getAncestors(), node];
+        return a.map(mapNode);
+    }
+}
+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 = {
+    cspell: {
+        meta,
+        create,
+    },
+};
+
+export { rules };
+//# sourceMappingURL=index.mjs.map

package/package.json

@@ -0,0 +1,73 @@
+{
+  "name": "@cspell/eslint-plugin",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "5.18.5",
+  "description": "[WIP] CSpell ESLint plugin",
+  "keywords": [
+    "cspell",
+    "eslint",
+    "plugin",
+    "spell",
+    "spell checker",
+    "spelling"
+  ],
+  "author": "Jason Dent <jason@streetsidesoftware.nl>",
+  "homepage": "https://github.com/streetsidesoftware/cspell/tree/main/packages/cspell-eslint-plugin#readme",
+  "license": "MIT",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.js",
+    "default": "./dist/index.js"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "!**/__mocks__",
+    "!**/*.test.*",
+    "!**/*.spec.*",
+    "!**/*.map"
+  ],
+  "scripts": {
+    "build": "rollup --config rollup.config.ts --configPlugin typescript",
+    "watch": "npm run build -- --watch",
+    "clean": "rimraf dist coverage .tsbuildinfo",
+    "clean-build": "npm run clean && npm run build",
+    "coverage": "echo coverage",
+    "test-watch": "npm run test -- --watch",
+    "test": "npx mocha --timeout 10000 \"dist/**/*.test.js\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/streetsidesoftware/cspell.git"
+  },
+  "bugs": {
+    "url": "https://github.com/streetsidesoftware/cspell/labels/cspell-gitignore"
+  },
+  "engines": {
+    "node": ">=12.13.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^21.0.2",
+    "@rollup/plugin-node-resolve": "^13.1.3",
+    "@rollup/plugin-typescript": "^8.3.1",
+    "@types/eslint": "^8.4.1",
+    "@types/estree": "^0.0.51",
+    "@types/node": "^17.0.21",
+    "@typescript-eslint/parser": "^5.14.0",
+    "@typescript-eslint/types": "^5.14.0",
+    "@typescript-eslint/typescript-estree": "^5.14.0",
+    "eslint": "^8.10.0",
+    "mocha": "^9.2.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.70.0",
+    "rollup-plugin-dts": "^4.2.0"
+  },
+  "dependencies": {
+    "cspell-lib": "^5.18.5"
+  }
+}