@servicenow/eslint-plugin-sdk-app-plugin 4.4.1 → 4.5.0

package/README.md

@@ -1,5 +1,7 @@
 # @servicenow/eslint-plugin-sdk-app-plugin
 
+> **Deprecated**: This package is no longer maintained and is published only as a stub to prevent install failures. It exports nothing and has no functionality.
+
 Plugin to disallow Browser and Node.js APIs not supported in rhino engine
 
 ## Installation

package/index.js

@@ -0,0 +1,2 @@
+// Stub — this package has been deprecated and is published only to prevent install failures.
+module.exports = {}

package/package.json

@@ -1,35 +1,12 @@
 {
   "name": "@servicenow/eslint-plugin-sdk-app-plugin",
-  "version": "4.4.1",
-  "description": "Plugin to disallow Browser and Node.js APIs not supported in rhino engine",
-  "keywords": [
-    "eslint",
-    "eslintplugin",
-    "eslint-plugin"
-  ],
-  "main": "./lib/index.js",
-  "exports": "./lib/index.js",
-  "dependencies": {
-    "@eslint-community/eslint-utils": "4.4.0",
-    "eslint": "8.50.0",
-    "eslint-plugin-n": "16.3.1",
-    "eslint-plugin-es-x": "7.2.0",
-    "eslint-plugin-eslint-plugin": "5.0.0",
-    "globals": "13.23.0"
-  },
-  "devDependencies": {
-    "mocha": "10.0.0",
-    "npm-run-all": "4.1.5"
-  },
-  "peerDependencies": {
-    "eslint": ">=8"
-  },
+  "version": "4.5.0",
+  "description": "Deprecated — this package is no longer maintained. Kept as a stub to prevent install failures.",
+  "main": "./index.js",
+  "exports": "./index.js",
   "license": "MIT",
   "engines": {
     "node": ">=20.18.0",
     "pnpm": ">=10.8.0"
-  },
-  "scripts": {
-    "test": "mocha tests --recursive"
   }
 }

package/.eslintrc.js

@@ -1,10 +0,0 @@
-module.exports = {
-    parserOptions: {
-        ecmaVersion: 'latest',
-    },
-    root: true,
-    extends: ['eslint:recommended', 'plugin:eslint-plugin/recommended', 'plugin:n/recommended'],
-    env: {
-        node: true,
-    },
-}

package/lib/configs/recommended.js

@@ -1,14 +0,0 @@
-const { getRestrictedGlobals } = require('../util/utility')
-const restrictedGlobals = getRestrictedGlobals()
-
-module.exports = {
-    plugins: ['@servicenow/sdk-app-plugin'],
-    rules: {
-        '@servicenow/sdk-app-plugin/file-extension-in-import': ['error', 'always'],
-        'no-restricted-globals': ['error', ...restrictedGlobals],
-        '@servicenow/sdk-app-plugin/no-dynamic-import': 'error',
-        '@servicenow/sdk-app-plugin/no-regexp-lookbehind-assertions': 'error',
-        '@servicenow/sdk-app-plugin/no-regexp-unicode-property-escapes': 'error',
-        '@servicenow/sdk-app-plugin/no-unsupported-node-builtins': 'error',
-    },
-}

package/lib/index.js

@@ -1,14 +0,0 @@
-module.exports = {
-    configs: {
-        recommended: require('./configs/recommended'),
-    },
-    rules: {
-        'file-extension-in-import': require('eslint-plugin-n/lib/rules/file-extension-in-import'),
-        'no-async-functions': require('eslint-plugin-es-x/lib/rules/no-async-functions'),
-        'no-promise': require('./rules/no-promise'),
-        'no-dynamic-import': require('eslint-plugin-es-x/lib/rules/no-dynamic-import'),
-        'no-regexp-lookbehind-assertions': require('eslint-plugin-es-x/lib/rules/no-regexp-lookbehind-assertions'),
-        'no-regexp-unicode-property-escapes': require('eslint-plugin-es-x/lib/rules/no-regexp-unicode-property-escapes'),
-        'no-unsupported-node-builtins': require('./rules/no-unsupported-node-builtins'),
-    },
-}

package/lib/rules/no-promise.js

@@ -1,45 +0,0 @@
-const PROMISE_STATIC_METHODS = {
-    all: true,
-    allSettled: true,
-    any: true,
-    race: true,
-    reject: true,
-    resolve: true,
-    withResolvers: true,
-}
-
-module.exports = {
-    meta: {
-        docs: {
-            description: 'disallow the `Promise` class.',
-            category: 'ES2015',
-            recommended: false,
-        },
-        fixable: null,
-        messages: {
-            forbidden: 'ES2015 Promise class is not supported in now platform.',
-        },
-        schema: [],
-        type: 'problem',
-    },
-    create(context) {
-        return {
-            CallExpression(node) {
-                if (
-                    node.callee.type === 'MemberExpression' &&
-                    node.callee.object.name === 'Promise' &&
-                    node.callee.object.type === 'Identifier' &&
-                    PROMISE_STATIC_METHODS[node.callee.property.name]
-                ) {
-                    context.report({ context, node, messageId: 'forbidden' })
-                }
-            },
-
-            NewExpression(node) {
-                if (node.callee.name === 'Promise') {
-                    context.report({ context, node, messageId: 'forbidden' })
-                }
-            },
-        }
-    },
-}

package/lib/rules/no-unsupported-node-builtins.js

@@ -1,37 +0,0 @@
-const { createTrackMap } = require('../util/utility')
-const { ReferenceTracker } = require('@eslint-community/eslint-utils')
-
-/** @type {import('eslint').Rule.RuleModule} */
-module.exports = {
-    meta: {
-        docs: {
-            description: 'disallow unsupported Node.js built-in APIs',
-            recommended: true,
-        },
-        messages: {
-            forbidden: 'The {{name}} Node.js API is not supported in now platform.',
-        },
-        schema: [],
-        type: 'problem',
-    },
-    create(context) {
-        return {
-            'Program:exit'(node) {
-                const sourceCode = context.sourceCode
-                const tracker = new ReferenceTracker(sourceCode.getScope(node), { mode: 'legacy' })
-                const trackMap = createTrackMap(false)
-                const globalsTrackMap = createTrackMap(true)
-
-                const references = [
-                    ...tracker.iterateCjsReferences(trackMap),
-                    ...tracker.iterateEsmReferences(trackMap),
-                    ...tracker.iterateGlobalReferences(globalsTrackMap),
-                ]
-
-                for (const { node, info } of references) {
-                    context.report({ node, messageId: 'forbidden', data: info })
-                }
-            },
-        }
-    },
-}

package/lib/util/utility.js

@@ -1,79 +0,0 @@
-const globals = require('globals')
-const { READ } = require('@eslint-community/eslint-utils')
-
-const globalsAllowList = ['console', 'fetch']
-const BROWSER_API_WARNING = 'Web APIs are not supported by the now platform'
-const NO_GLOBAL_THIS = 'ES2020 `globalThis` variable is not supported by the now platform'
-
-const getRestrictedGlobals = () => {
-    const globalRules = [{ name: 'globalThis', message: NO_GLOBAL_THIS }]
-    const browserRules = Object.keys(globals.browser)
-        .filter((key) => !globalsAllowList.includes(key))
-        .map((key) => {
-            return {
-                name: key,
-                message: BROWSER_API_WARNING,
-            }
-        })
-    return globalRules.concat(browserRules)
-}
-
-const coreNodeModules = [
-    'assert',
-    'buffer',
-    'child_process',
-    'cluster',
-    'crypto',
-    'dgram',
-    'dns',
-    'domain',
-    'events',
-    'freelist',
-    'fs',
-    'http',
-    'https',
-    'module',
-    'net',
-    'os',
-    'path',
-    'punycode',
-    'querystring',
-    'readline',
-    'repl',
-    'smalloc',
-    'stream',
-    'string_decoder',
-    'sys',
-    'timers',
-    'tls',
-    'tracing',
-    'tty',
-    'url',
-    'util',
-    'vm',
-    'zlib',
-]
-
-const getNodeGlobals = () => Object.keys(globals.nodeBuiltin).filter((key) => !globalsAllowList.includes(key))
-
-const createTrackMap = (isNodeGlobals) => {
-    const trackMapItems = isNodeGlobals ? getNodeGlobals() : coreNodeModules
-    const trackMap = {}
-
-    for (const item of trackMapItems) {
-        trackMap[item] = {
-            [READ]: {
-                name: item,
-            },
-        }
-    }
-
-    return trackMap
-}
-
-module.exports = {
-    getRestrictedGlobals,
-    createTrackMap,
-    coreNodeModules,
-    getNodeGlobals,
-}

package/license

@@ -1,9 +0,0 @@
-MIT License
-
-Copyright (c) 2024 ServiceNow Inc.
-
-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/tests/rules/no-promise.test.js

@@ -1,26 +0,0 @@
-const { RuleTester } = require('eslint')
-const noPromise = require('../../lib/rules/no-promise')
-
-const ruleTester = new RuleTester({
-    parserOptions: { ecmaVersion: 2015 },
-})
-
-const errorMessages = [{ message: 'ES2015 Promise class is not supported in now platform.' }]
-
-ruleTester.run('no-promise', noPromise, {
-    valid: [
-        {
-            code: "const Promise = 'value';",
-        },
-    ],
-    invalid: [
-        {
-            code: 'const p = new Promise()',
-            errors: errorMessages,
-        },
-        {
-            code: 'Promise.all()',
-            errors: errorMessages,
-        },
-    ],
-})

package/tests/rules/no-unsupported-node-builtins.test.js

@@ -1,60 +0,0 @@
-const { RuleTester } = require('eslint')
-const noUnsupportedNodeBuiltins = require('../../lib/rules/no-unsupported-node-builtins')
-const { coreNodeModules, getNodeGlobals } = require('../../lib/util/utility')
-
-const ruleTester = new RuleTester({
-    parserOptions: { sourceType: 'module' },
-    env: { node: true, es6: true },
-})
-
-const getInvalidsForNoUnsupportedNodeBuiltsRule = () => {
-    const invalids = []
-    const nodeGlobals = getNodeGlobals()
-
-    for (const module of coreNodeModules) {
-        invalids.push({
-            code: `const ${module} = require('${module}')`,
-            errors: [{ message: `The ${module} Node.js API is not supported in now platform.` }],
-        })
-    }
-
-    for (const module of coreNodeModules) {
-        invalids.push({
-            code: `import ${module} from '${module}'`,
-            errors: [{ message: `The ${module} Node.js API is not supported in now platform.` }],
-        })
-    }
-
-    for (const global of nodeGlobals) {
-        invalids.push({
-            code: `const x = ${global}`,
-            errors: [{ message: `The ${global} Node.js API is not supported in now platform.` }],
-        })
-    }
-
-    return invalids
-}
-
-ruleTester.run('no-unsupported-node-builtins', noUnsupportedNodeBuiltins, {
-    valid: [
-        {
-            code: "const fs = {'Dir':'cool'}; const x = fs.Dir",
-        },
-        {
-            code: 'const fs = {readFileSync: function(){}}; fs.readFileSync()',
-        },
-        {
-            code: 'const Buffer = {from: function(){}}; Buffer.from()',
-        },
-        {
-            code: `const validFunction = () => {
-                    fetch("https://api.example.com/data")
-                        .then(response => response.json())
-                        .then(data => console.log(data))
-                        .catch(error => console.error('Error:', error));
-                }; 
-                validFunction();`,
-        },
-    ],
-    invalid: getInvalidsForNoUnsupportedNodeBuiltsRule(),
-})