eslint-plugin-cvsdk-rules 0.23.0-test-publish-2

package/config/file.ts

@@ -0,0 +1 @@
+// See: https://typescript-eslint.io/packages/rule-tester/#type-aware-testing

package/config/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // https://typescript-eslint.io/packages/rule-tester/#type-aware-testing
+  "compilerOptions": {
+    // Otherwise TS will complain it'll override the base project's output
+    "outDir": "./",
+    "strict": true
+  },
+  "exclude": [],
+  // See: https://typescript-eslint.io/packages/rule-tester/#type-aware-testing
+  "include": ["file.ts"]
+}

package/index.js

@@ -0,0 +1,5 @@
+module.exports = {
+    rules: {
+        'prefer-self-over-window': require('./rules/prefer-self-over-window'),
+    },
+};

package/jest.config.js

@@ -0,0 +1,2 @@
+{
+}

package/package.json

@@ -0,0 +1,17 @@
+{
+    "name": "eslint-plugin-cvsdk-rules",
+    "version": "0.23.0-test-publish-2",
+    "main": "index.js",
+    "scripts": {
+        "test": "jest",
+        "test:nocoverage": "jest"
+    },
+    "dependencies": {
+        "@typescript-eslint/utils": "6.21.0"
+    },
+    "devDependencies": {
+        "@typescript-eslint/rule-tester": "6.21.0",
+        "jest": "29.7.0"
+    },
+    "gitHead": "8d6ce5e078751d3c44add1c8fbaa893207adb1b7"
+}

package/rules/prefer-self-over-window.js

@@ -0,0 +1,41 @@
+const { ESLintUtils } = require('@typescript-eslint/utils');
+
+const meta = {
+    docs: {
+        description: 'Disallow window access.',
+    },
+    messages: {
+        forbiddenWindowAccess: '`window` cannot be accessed inside some containers, we prefer using `self` as it has more compatibility.',
+    },
+    schema: [], // no options
+    type: 'problem',
+    fixable: 'code',
+};
+
+function create(context) {
+    const parserServices = ESLintUtils.getParserServices(context);
+
+    function reportWindowError(node) {
+        if (node.parent.type !== 'VariableDeclarator') {
+            const nodeType = parserServices.getTypeAtLocation(node);
+            if (Object.prototype.hasOwnProperty.call(nodeType, 'aliasSymbol')) {
+                context.report({
+                    messageId: 'forbiddenWindowAccess',
+                    node,
+                    fix: function (fixer) {
+                        return fixer.replaceText(node, 'self');
+                    },
+                });
+            }
+        }
+    }
+
+    return {
+        "Identifier[name='window']": reportWindowError,
+    };
+}
+
+module.exports = {
+    create,
+    meta,
+};

package/rules/prefer-self-over-window.spec.js

@@ -0,0 +1,40 @@
+const { RuleTester } = require('@typescript-eslint/rule-tester');
+const path = require('path');
+
+const rule = require('./prefer-self-over-window');
+
+const ruleName = 'prefer-self-over-window';
+
+// https://typescript-eslint.io/packages/rule-tester/#type-aware-testing
+const ruleTester = new RuleTester({
+    parser: require.resolve('@typescript-eslint/parser'),
+    parserOptions: {
+        project: true,
+        tsconfigRootDir: path.join(__dirname, '../config'),
+    },
+});
+
+describe('Disallow window access', () => {
+    ruleTester.run(ruleName, rule, {
+        invalid: [
+            {
+                code: 'window;',
+                output: 'self;',
+                errors: [{ messageId: 'forbiddenWindowAccess' }],
+            },
+            {
+                code: 'declare let window: any; window;',
+                output: 'declare let window: any; self;',
+                errors: [{ messageId: 'forbiddenWindowAccess' }],
+            },
+        ],
+        valid: [
+            'const window = 1;',
+            'function someFunc() { const window = 1; window; }',
+            'function someFunc() { let window: number; window; };',
+            'function someFunc() { let window: unknown; window; };',
+            'function someFunc() { let window: any; window; };',
+            'function someFunc() { let window; window; };',
+        ],
+    });
+});