@storm-software/eslint 0.107.2 → 0.108.0

package/dist/chunk-RTM5LCEB.js

@@ -0,0 +1,149 @@
+// src/utils/constants.ts
+var RESTRICTED_SYNTAX = [
+  {
+    // ❌ readFile(…, { encoding: … })
+    selector: "CallExpression[callee.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=1] Property[key.name=encoding]",
+    message: "Specify encoding as last argument instead of object with encoding key"
+  },
+  {
+    // ❌ readFile(…, {})
+    selector: "CallExpression[callee.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=0]",
+    message: "Specify encoding as last argument"
+  },
+  {
+    // ❌ readFileSync(…).toString(…)
+    selector: "CallExpression[callee.name=readFileSync][parent.property.name=toString]",
+    message: "toString is redundant, specify encoding as last argument"
+  },
+  {
+    // ❌ ….readFile(…, { encoding: … })
+    selector: "CallExpression[callee.type=MemberExpression][callee.property.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=1] Property[key.name=encoding]",
+    message: "Specify encoding as last argument instead of object with encoding key"
+  },
+  {
+    // ❌ ….readFile(…, {})
+    selector: "CallExpression[callee.type=MemberExpression][callee.property.name=/readFileSync|readFile|writeFileSync|writeFile/] > .arguments:last-child[type=ObjectExpression][properties.length=0]",
+    message: "Specify encoding as last argument"
+  },
+  {
+    // ❌ Boolean(…)
+    selector: "CallExpression[callee.name=Boolean][arguments.1.elements.length!=0]",
+    message: "Prefer `!!\u2026` over `Boolean(\u2026)` because TypeScript infers a narrow literal boolean `type: true` instead of `type: boolean`."
+  },
+  {
+    // ❌ process.browser
+    selector: "ExpressionStatement[expression.object.name=process][expression.property.name=browser]",
+    message: "`process.browser` is deprecated, use `!!globalThis.window`"
+  }
+];
+var REACT_RESTRICTED_SYNTAX = [
+  ...RESTRICTED_SYNTAX,
+  {
+    // ❌ useMemo(…, [])
+    selector: "CallExpression[callee.name=useMemo][arguments.1.type=ArrayExpression][arguments.1.elements.length=0]",
+    message: "`useMemo` with an empty dependency array can't provide a stable reference, use `useRef` instead."
+  }
+];
+var RESTRICTED_GLOBALS = [
+  "stop",
+  {
+    name: "isNaN",
+    message: "Use Number.isNaN instead"
+  }
+];
+var RESTRICTED_MODULES = [
+  {
+    name: "axios",
+    message: "Use `fetch/node-fetch` instead."
+  },
+  {
+    name: "moment",
+    message: "Use `dayjs/date-fns` instead."
+  },
+  {
+    name: "classnames",
+    message: "Use `clsx` instead because it is faster."
+  },
+  {
+    name: "lodash/isString.js",
+    message: "Use `typeof yourVar === 'string'` instead."
+  },
+  {
+    name: "lodash/isArray.js",
+    message: "Use `Array.isArray` instead."
+  },
+  {
+    name: "lodash/flatten.js",
+    message: "Use `Array#flat()` instead."
+  },
+  {
+    name: "lodash/compact.js",
+    message: "Use `Array#filter(Boolean)` instead."
+  },
+  {
+    name: "lodash/identity.js",
+    message: "Use `(value) => value` instead."
+  }
+];
+var JS_FILES = [
+  "*.js?(x)",
+  "*.mjs"
+];
+var CODE_BLOCK = "**/*.md{,x}/*";
+var CODE_FILE = "**/*.{,c,m}{j,t}s{,x}";
+var TS_FILE = "**/*.{,c,m}ts{,x}";
+var JS_FILE = "**/*.{,c}js{,x}";
+var ACRONYMS_LIST = [
+  "API",
+  "ASCII",
+  "CPU",
+  "CSS",
+  "DNS",
+  "EOF",
+  "GUID",
+  "HTML",
+  "HTTP",
+  "HTTPS",
+  "ID",
+  "IP",
+  "JSON",
+  "LHS",
+  "OEM",
+  "PP",
+  "QA",
+  "RAM",
+  "RHS",
+  "RPC",
+  "RSS",
+  "SLA",
+  "SMTP",
+  "SQL",
+  "SSH",
+  "SSL",
+  "TCP",
+  "TLS",
+  "TTL",
+  "UDP",
+  "UI",
+  "UID",
+  "UUID",
+  "URI",
+  "URL",
+  "UTF",
+  "VM",
+  "XML",
+  "XSS"
+];
+
+export {
+  RESTRICTED_SYNTAX,
+  REACT_RESTRICTED_SYNTAX,
+  RESTRICTED_GLOBALS,
+  RESTRICTED_MODULES,
+  JS_FILES,
+  CODE_BLOCK,
+  CODE_FILE,
+  TS_FILE,
+  JS_FILE,
+  ACRONYMS_LIST
+};

package/dist/chunk-SHUYVCID.js

@@ -0,0 +1,6 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+
+export {
+  __name
+};

package/dist/chunk-TXTXUVRZ.cjs

@@ -0,0 +1,313 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+
+var _chunkKND2ZTLTcjs = require('./chunk-KND2ZTLT.cjs');
+
+
+var _chunkESFBJFNUcjs = require('./chunk-ESFBJFNU.cjs');
+
+
+var _chunkQDLKHXPXcjs = require('./chunk-QDLKHXPX.cjs');
+
+// src/utils/banner-plugin.ts
+var _utils = require('@typescript-eslint/utils');
+var _os = require('os'); var _os2 = _interopRequireDefault(_os);
+function match(actual, expected) {
+  if (expected.test) {
+    return expected.test(actual);
+  } else {
+    return expected === actual;
+  }
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, match, "match");
+function excludeShebangs(comments) {
+  return comments.filter(function(comment) {
+    return comment.type !== "Shebang";
+  });
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, excludeShebangs, "excludeShebangs");
+function getLeadingComments(context, node) {
+  const all = excludeShebangs(context.getSourceCode().getAllComments(node.body.length ? node.body[0] : node));
+  if (all[0].type.toLowerCase() === "block") {
+    return [
+      all[0]
+    ];
+  }
+  let i = 1;
+  for (i = 1; i < all.length; ++i) {
+    const txt = context.getSourceCode().getText().slice(all[i - 1].range[1], all[i].range[0]);
+    if (!txt.match(/^(\r\n|\r|\n)$/)) {
+      break;
+    }
+  }
+  return all.slice(0, i);
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, getLeadingComments, "getLeadingComments");
+function genCommentBody(commentType, textArray, eol, numNewlines) {
+  const eols = eol.repeat(numNewlines);
+  if (commentType === "block") {
+    return "/*" + textArray.join(eol) + "*/" + eols;
+  } else {
+    return "//" + textArray.join(eol + "//") + eols;
+  }
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, genCommentBody, "genCommentBody");
+function genCommentsRange(context, comments, eol) {
+  const start = comments[0].range[0];
+  let end = comments.slice(-1)[0].range[1];
+  if (context.getSourceCode().text[end] === eol) {
+    end += eol.length;
+  }
+  return [
+    start,
+    end
+  ];
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, genCommentsRange, "genCommentsRange");
+function genPrependFixer(commentType, node, bannerLines, eol, numNewlines) {
+  return function(fixer) {
+    return fixer.insertTextBefore(node, genCommentBody(commentType, bannerLines, eol, numNewlines));
+  };
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, genPrependFixer, "genPrependFixer");
+function genReplaceFixer(commentType, context, leadingComments, bannerLines, eol, numNewlines) {
+  return function(fixer) {
+    return fixer.replaceTextRange(genCommentsRange(context, leadingComments, eol), genCommentBody(commentType, bannerLines, eol, numNewlines));
+  };
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, genReplaceFixer, "genReplaceFixer");
+function getEOL(options) {
+  if (options.lineEndings === "unix") {
+    return "\n";
+  }
+  if (options.lineEndings === "windows") {
+    return "\r\n";
+  }
+  return _os2.default.EOL;
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, getEOL, "getEOL");
+function hasBanner(commentType, src) {
+  if (src.startsWith("#!")) {
+    const bannerLines = src.split(/\r?\n/);
+    if (bannerLines && bannerLines.length > 1) {
+      bannerLines.shift();
+      while (bannerLines.length && bannerLines[0] && !bannerLines[0].replace(/\s+/, "")) {
+        bannerLines.shift();
+      }
+      if (bannerLines.length) {
+        src = bannerLines.join("\n");
+      } else {
+        return false;
+      }
+    }
+  }
+  return commentType === "block" && src.startsWith("/*") || commentType === "lint" && src.startsWith("//") || commentType !== "block" && commentType !== "lint" && commentType && src.startsWith(commentType);
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, hasBanner, "hasBanner");
+function matchesLineEndings(src, num) {
+  for (let j = 0; j < num; ++j) {
+    const m = src.match(/^(\r\n|\r|\n)/);
+    if (m) {
+      src = src.slice(m.index + m[0].length);
+    } else {
+      return false;
+    }
+  }
+  return true;
+}
+_chunkQDLKHXPXcjs.__name.call(void 0, matchesLineEndings, "matchesLineEndings");
+var bannerRule = _utils.ESLintUtils.RuleCreator(() => `https://docs.stormsoftware.com/eslint/rules/banner`)({
+  name: "banner",
+  meta: {
+    docs: {
+      description: "Ensures the file has a Storm Software banner"
+    },
+    schema: [
+      {
+        type: "object",
+        properties: {
+          banner: {
+            type: "string",
+            description: "The banner to enforce at the top of the file. If not provided, the banner will be read from the file specified in the commentStart option"
+          },
+          repositoryName: {
+            type: "string",
+            description: "The name of the repository to use when reading the banner from a file."
+          },
+          commentType: {
+            type: "string",
+            description: "The comment token to use for the banner. Defaults to block ('/* <banner> */')"
+          },
+          numNewlines: {
+            type: "number",
+            description: "The number of newlines to use after the banner. Defaults to 2"
+          }
+        },
+        additionalProperties: false
+      }
+    ],
+    type: "layout",
+    messages: {
+      missingBanner: "Missing banner",
+      incorrectComment: "Banner should use the {{commentType}} comment type",
+      incorrectBanner: "Incorrect banner",
+      noNewlineAfterBanner: "No newline after banner"
+    },
+    fixable: "whitespace"
+  },
+  defaultOptions: [
+    {
+      repositoryName: "",
+      commentType: "block",
+      numNewlines: 2
+    }
+  ],
+  create(context, [{ banner, repositoryName = "", commentType = "block", numNewlines = 2 }]) {
+    if (!banner) {
+      banner = _chunkKND2ZTLTcjs.getFileBanner.call(void 0, repositoryName);
+    }
+    const options = context.options;
+    const eol = getEOL(options);
+    const canFix = true;
+    const bannerLines = banner.split(/\r?\n/);
+    let fixLines = bannerLines;
+    return {
+      Program: /* @__PURE__ */ _chunkQDLKHXPXcjs.__name.call(void 0, function(node) {
+        if (!hasBanner(commentType, context.sourceCode.getText())) {
+          context.report({
+            loc: node.loc,
+            messageId: "missingBanner",
+            fix: genPrependFixer(commentType, node, fixLines, eol, numNewlines)
+          });
+        } else {
+          const leadingComments = getLeadingComments(context, node);
+          if (!leadingComments.length) {
+            context.report({
+              loc: node.loc,
+              messageId: "missingBanner",
+              fix: canFix ? genPrependFixer(commentType, node, fixLines, eol, numNewlines) : null
+            });
+          } else if (leadingComments[0].type.toLowerCase() !== commentType) {
+            context.report({
+              loc: node.loc,
+              messageId: "incorrectComment",
+              data: {
+                commentType
+              },
+              fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+            });
+          } else {
+            if (commentType === "line") {
+              if (leadingComments.length < bannerLines.length) {
+                context.report({
+                  loc: node.loc,
+                  messageId: "missingBanner",
+                  fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                });
+                return;
+              }
+              for (let i = 0; i < bannerLines.length; i++) {
+                if (!match(leadingComments[i].value, bannerLines[i])) {
+                  context.report({
+                    loc: node.loc,
+                    messageId: "incorrectBanner",
+                    fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                  });
+                  return;
+                }
+              }
+              const postLineBanner = context.getSourceCode().text.substr(leadingComments[bannerLines.length - 1].range[1], (_nullishCoalesce(numNewlines, () => ( 1))) * 2);
+              if (!matchesLineEndings(postLineBanner, numNewlines)) {
+                context.report({
+                  loc: node.loc,
+                  messageId: "noNewlineAfterBanner",
+                  fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                });
+              }
+            } else {
+              let leadingLines = [
+                leadingComments[0].value
+              ];
+              if (bannerLines.length > 1) {
+                leadingLines = leadingComments[0].value.split(/\r?\n/);
+              }
+              let hasError = false;
+              if (leadingLines.length > bannerLines.length) {
+                hasError = true;
+              }
+              for (let i = 0; !hasError && i < bannerLines.length; i++) {
+                if (!match(leadingLines[i], bannerLines[i])) {
+                  hasError = true;
+                }
+              }
+              if (hasError) {
+                if (canFix && bannerLines.length > 1) {
+                  fixLines = [
+                    fixLines.join(eol)
+                  ];
+                }
+                context.report({
+                  loc: node.loc,
+                  messageId: "incorrectBanner",
+                  fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                });
+              } else {
+                const postBlockBanner = context.getSourceCode().text.substr(leadingComments[0].range[1], (_nullishCoalesce(numNewlines, () => ( 1))) * 2);
+                if (!matchesLineEndings(postBlockBanner, numNewlines)) {
+                  context.report({
+                    loc: node.loc,
+                    messageId: "noNewlineAfterBanner",
+                    fix: canFix ? genReplaceFixer(commentType, context, leadingComments, fixLines, eol, numNewlines) : null
+                  });
+                }
+              }
+            }
+          }
+        }
+      }, "Program")
+    };
+  }
+});
+var plugin = {
+  meta: {
+    name: "eslint-plugin-banner",
+    version: "0.0.1"
+  },
+  configs: {},
+  rules: {
+    banner: bannerRule
+  },
+  processors: {}
+};
+plugin.configs && (plugin.configs.recommended = {
+  name: "banner/recommended",
+  plugins: {
+    banner: plugin
+  },
+  files: [
+    _chunkESFBJFNUcjs.CODE_FILE
+  ],
+  ignores: [
+    "!**/docs/**/*",
+    "!**/crates/**/*",
+    "!**/tmp/**/*",
+    "!**/dist/**/*",
+    "!**/coverage/**/*",
+    "!**/node_modules/**/*",
+    "!**/.cache/**/*",
+    "!**/.nx/**/*"
+  ],
+  rules: {
+    "banner/banner": [
+      "error",
+      {
+        commentType: "block",
+        numNewlines: 2
+      }
+    ]
+  }
+});
+var banner_plugin_default = plugin;
+
+
+
+exports.banner_plugin_default = banner_plugin_default;

package/dist/chunk-VJ6CKC4P.js

@@ -0,0 +1,37 @@
+// src/utils/ignores.ts
+var ignores = [
+  "**/.git/**",
+  "**/node_modules/**",
+  "**/src/generators/**/files/**/*",
+  "**/dist/**",
+  "**/tmp/**",
+  "**/coverage/**",
+  "**/bench/**",
+  "**/.wrangler/**",
+  "**/.docusaurus/**",
+  "**/.tamagui/**",
+  "**/tamagui.css",
+  "**/.nx/**",
+  "**/.next/**",
+  "**/workbox*.js",
+  "**/sw*.js",
+  "**/service-worker.js",
+  "**/fallback*.js",
+  "**/ios/**",
+  "**/.android/**",
+  "**/.DS_Store/**",
+  "**/Thumbs.db/**",
+  "**/.cspellcache",
+  "**/package-lock.*",
+  "**/npm-lock.*",
+  "**/pnpm-lock.*",
+  "**/pnpm-lock.*",
+  "**/bun.lockb",
+  "**/cargo.lock",
+  "**/next-env.d.ts",
+  "**/CODEOWNERS"
+];
+
+export {
+  ignores
+};

package/dist/chunk-Y67QTC5U.js

@@ -0,0 +1,49 @@
+import {
+  ACRONYMS_LIST
+} from "./chunk-RTM5LCEB.js";
+import {
+  __name
+} from "./chunk-SHUYVCID.js";
+
+// src/utils/get-file-banner.ts
+var getFileBanner = /* @__PURE__ */ __name((name = "") => {
+  if (!name) {
+    name = process.env.STORM_NAMESPACE || "";
+  }
+  let padding = "                               ";
+  for (let i = 0; i < name.length + 2 && padding.length > 4; i++) {
+    padding = padding.slice(0, -1);
+  }
+  let titleName = name;
+  if (titleName) {
+    if (titleName?.startsWith("@")) {
+      titleName = titleName.slice(1);
+    }
+    titleName = (titleName.charAt(0).toUpperCase() + titleName.slice(1)).split("-").filter((word) => word && word.length > 0).map((word) => {
+      if (ACRONYMS_LIST.includes(word.toUpperCase())) {
+        return word.toUpperCase();
+      }
+      return word.charAt(0).toUpperCase() + word.slice(1);
+    }).join(" ");
+  }
+  return `-------------------------------------------------------------------
+
+${padding}\u26A1 Storm Software ${titleName ? `- ${titleName}` : ""}
+
+ This code was released as part of ${titleName ? `the ${titleName}` : "a Storm Software"} project. ${titleName ? titleName : "The project"}
+ is maintained by Storm Software under the ${(process.env.STORM_LICENSE ?? "Apache-2.0")?.toLowerCase()?.includes("license") ? process.env.STORM_LICENSE ?? "Apache-2.0" : `${process.env.STORM_LICENSE ?? "Apache-2.0"} License`}, and is
+ free for commercial and private use. For more information, please visit
+ our licensing page.
+
+ Website:         ${process.env.STORM_HOMEPAGE ?? "https://stormsoftware.com"}
+ Repository:      ${process.env.STORM_REPOSITORY ?? `https://github.com/storm-software${name ? `/${name}` : ""}`}
+ Documentation:   ${process.env.STORM_DOCS ? process.env.STORM_DOCS : `https://stormsoftware.com/${name ? `projects/${name}/` : ""}docs`}
+ Contact:         ${process.env.STORM_HOMEPAGE ? process.env.STORM_HOMEPAGE.endsWith("/") ? process.env.STORM_HOMEPAGE.slice(-1) : process.env.STORM_HOMEPAGE : "https://stormsoftware.com"}/contact
+ License:         ${process.env.STORM_LICENSING ? process.env.STORM_LICENSING : `https://stormsoftware.com/${name ? `projects/${name}/` : ""}license`}
+
+ -------------------------------------------------------------------`;
+}, "getFileBanner");
+
+export {
+  getFileBanner
+};

package/dist/chunk-YQQ366F7.cjs

@@ -0,0 +1,37 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});// src/utils/ignores.ts
+var ignores = [
+  "**/.git/**",
+  "**/node_modules/**",
+  "**/src/generators/**/files/**/*",
+  "**/dist/**",
+  "**/tmp/**",
+  "**/coverage/**",
+  "**/bench/**",
+  "**/.wrangler/**",
+  "**/.docusaurus/**",
+  "**/.tamagui/**",
+  "**/tamagui.css",
+  "**/.nx/**",
+  "**/.next/**",
+  "**/workbox*.js",
+  "**/sw*.js",
+  "**/service-worker.js",
+  "**/fallback*.js",
+  "**/ios/**",
+  "**/.android/**",
+  "**/.DS_Store/**",
+  "**/Thumbs.db/**",
+  "**/.cspellcache",
+  "**/package-lock.*",
+  "**/npm-lock.*",
+  "**/pnpm-lock.*",
+  "**/pnpm-lock.*",
+  "**/bun.lockb",
+  "**/cargo.lock",
+  "**/next-env.d.ts",
+  "**/CODEOWNERS"
+];
+
+
+
+exports.ignores = ignores;