toiljs 0.0.14 → 0.0.16

package/presets/eslint.js

@@ -1,88 +1,88 @@
-/** toiljs shared ESLint flat config: `import toiljs from 'toiljs/eslint'; export default toiljs;` */
-import eslintReact from '@eslint-react/eslint-plugin';
-import eslint from '@eslint/js';
-import reactHooks from 'eslint-plugin-react-hooks';
-import reactRefresh from 'eslint-plugin-react-refresh';
-import tseslint from 'typescript-eslint';
-
-import noUint8ArrayToString from './no-uint8array-tostring.js';
-
-export default tseslint.config(
-    { ignores: ['dist', 'build', '.toil', 'node_modules', 'toil-env.d.ts', 'server/**'] },
-    {
-        extends: [
-            eslint.configs.recommended,
-            ...tseslint.configs.recommended,
-            ...tseslint.configs.strictTypeChecked,
-        ],
-        files: ['**/*.{ts,tsx}'],
-        languageOptions: {
-            ecmaVersion: 2023,
-            parserOptions: {
-                projectService: true,
-            },
-        },
-        plugins: {
-            'react-hooks': reactHooks,
-            'react-refresh': reactRefresh,
-            '@eslint-react': eslintReact,
-            custom: noUint8ArrayToString,
-        },
-        rules: {
-            ...reactHooks.configs.recommended.rules,
-            // Route files conventionally export `loader` / `revalidate` / `metadata` /
-            // `generateMetadata` / `searchHints` alongside the default component; the toil compiler
-            // consumes them at runtime/build. Allow them (plus primitive constants) so Fast Refresh
-            // doesn't flag the pattern.
-            'react-refresh/only-export-components': [
-                'warn',
-                {
-                    allowConstantExport: true,
-                    allowExportNames: [
-                        'loader',
-                        'revalidate',
-                        'metadata',
-                        'generateMetadata',
-                        'searchHints',
-                    ],
-                },
-            ],
-            'no-undef': 'off',
-            '@typescript-eslint/no-unused-vars': 'off',
-            'no-empty': 'off',
-            '@typescript-eslint/restrict-template-expressions': 'off',
-            '@typescript-eslint/only-throw-error': 'off',
-            '@typescript-eslint/no-unnecessary-condition': 'off',
-            '@typescript-eslint/unbound-method': 'warn',
-            '@typescript-eslint/no-confusing-void-expression': 'off',
-            '@typescript-eslint/no-extraneous-class': 'off',
-            'no-async-promise-executor': 'off',
-            '@typescript-eslint/no-misused-promises': 'off',
-            '@typescript-eslint/no-unnecessary-type-parameters': 'off',
-            '@typescript-eslint/no-duplicate-enum-values': 'off',
-            'prefer-spread': 'off',
-            '@typescript-eslint/no-empty-object-type': 'off',
-            '@typescript-eslint/no-floating-promises': 'off',
-            '@typescript-eslint/ban-ts-comment': 'off',
-            'no-constant-binary-expression': 'off',
-            'no-useless-assignment': 'off',
-            '@typescript-eslint/no-unsafe-assignment': 'off',
-            '@typescript-eslint/no-unsafe-call': 'off',
-            '@typescript-eslint/no-unsafe-member-access': 'off',
-            '@typescript-eslint/no-unsafe-argument': 'off',
-            '@typescript-eslint/no-unnecessary-type-conversion': 'warn',
-            'react-hooks/set-state-in-effect': 'warn',
-            'custom/no-uint8array-tostring': 'error',
-            'padding-line-between-statements': [
-                'error',
-                { blankLine: 'always', prev: 'block-like', next: '*' },
-            ],
-            '@typescript-eslint/no-deprecated': 'off',
-            '@typescript-eslint/no-unnecessary-type-arguments': 'off',
-        },
-    },
-    {
-        files: ['**/*.js'],
-        ...tseslint.configs.disableTypeChecked,
-    },
-);
+/** toiljs shared ESLint flat config: `import toiljs from 'toiljs/eslint'; export default toiljs;` */
+import eslintReact from '@eslint-react/eslint-plugin';
+import eslint from '@eslint/js';
+import reactHooks from 'eslint-plugin-react-hooks';
+import reactRefresh from 'eslint-plugin-react-refresh';
+import tseslint from 'typescript-eslint';
+
+import noUint8ArrayToString from './no-uint8array-tostring.js';
+
+export default tseslint.config(
+    { ignores: ['dist', 'build', '.toil', 'node_modules', 'toil-env.d.ts', 'server/**'] },
+    {
+        extends: [
+            eslint.configs.recommended,
+            ...tseslint.configs.recommended,
+            ...tseslint.configs.strictTypeChecked,
+        ],
+        files: ['**/*.{ts,tsx}'],
+        languageOptions: {
+            ecmaVersion: 2023,
+            parserOptions: {
+                projectService: true,
+            },
+        },
+        plugins: {
+            'react-hooks': reactHooks,
+            'react-refresh': reactRefresh,
+            '@eslint-react': eslintReact,
+            custom: noUint8ArrayToString,
+        },
+        rules: {
+            ...reactHooks.configs.recommended.rules,
+            // Route files conventionally export `loader` / `revalidate` / `metadata` /
+            // `generateMetadata` / `searchHints` alongside the default component; the toil compiler
+            // consumes them at runtime/build. Allow them (plus primitive constants) so Fast Refresh
+            // doesn't flag the pattern.
+            'react-refresh/only-export-components': [
+                'warn',
+                {
+                    allowConstantExport: true,
+                    allowExportNames: [
+                        'loader',
+                        'revalidate',
+                        'metadata',
+                        'generateMetadata',
+                        'searchHints',
+                    ],
+                },
+            ],
+            'no-undef': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            'no-empty': 'off',
+            '@typescript-eslint/restrict-template-expressions': 'off',
+            '@typescript-eslint/only-throw-error': 'off',
+            '@typescript-eslint/no-unnecessary-condition': 'off',
+            '@typescript-eslint/unbound-method': 'warn',
+            '@typescript-eslint/no-confusing-void-expression': 'off',
+            '@typescript-eslint/no-extraneous-class': 'off',
+            'no-async-promise-executor': 'off',
+            '@typescript-eslint/no-misused-promises': 'off',
+            '@typescript-eslint/no-unnecessary-type-parameters': 'off',
+            '@typescript-eslint/no-duplicate-enum-values': 'off',
+            'prefer-spread': 'off',
+            '@typescript-eslint/no-empty-object-type': 'off',
+            '@typescript-eslint/no-floating-promises': 'off',
+            '@typescript-eslint/ban-ts-comment': 'off',
+            'no-constant-binary-expression': 'off',
+            'no-useless-assignment': 'off',
+            '@typescript-eslint/no-unsafe-assignment': 'off',
+            '@typescript-eslint/no-unsafe-call': 'off',
+            '@typescript-eslint/no-unsafe-member-access': 'off',
+            '@typescript-eslint/no-unsafe-argument': 'off',
+            '@typescript-eslint/no-unnecessary-type-conversion': 'warn',
+            'react-hooks/set-state-in-effect': 'warn',
+            'custom/no-uint8array-tostring': 'error',
+            'padding-line-between-statements': [
+                'error',
+                { blankLine: 'always', prev: 'block-like', next: '*' },
+            ],
+            '@typescript-eslint/no-deprecated': 'off',
+            '@typescript-eslint/no-unnecessary-type-arguments': 'off',
+        },
+    },
+    {
+        files: ['**/*.js'],
+        ...tseslint.configs.disableTypeChecked,
+    },
+);

package/presets/no-uint8array-tostring.js

@@ -1,200 +1,200 @@
-/**
- * ESLint rule: disallow `.toString()` on Uint8Array (and branded byte types), which returns
- * comma-separated decimals instead of hex.
- */
-import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils';
-import { SyntaxKind } from 'typescript';
-
-function isUint8ArrayType(type, checker) {
-    const symbol = type.getSymbol();
-    if (symbol?.getName() === 'Uint8Array') {
-        return true;
-    }
-
-    const baseTypes = type.getBaseTypes?.();
-    if (baseTypes) {
-        for (const baseType of baseTypes) {
-            if (isUint8ArrayType(baseType, checker)) {
-                return true;
-            }
-        }
-    }
-
-    if (type.isIntersection()) {
-        for (const subType of type.types) {
-            if (isUint8ArrayType(subType, checker)) {
-                return true;
-            }
-        }
-    }
-
-    if (type.isUnion()) {
-        return (
-            type.types.length > 0 &&
-            type.types.every((subType) => isUint8ArrayType(subType, checker))
-        );
-    }
-
-    const constraint = type.getConstraint?.();
-    if (constraint && isUint8ArrayType(constraint, checker)) {
-        return true;
-    }
-
-    return false;
-}
-
-/**
- * Types whose toString() is the dangerous default behavior we want to catch.
- * If toString is declared on any type NOT in this set, it has been
- * intentionally overridden and we should leave it alone.
- */
-const DEFAULT_TOSTRING_OWNERS = new Set([
-    'Object',
-    'Uint8Array',
-    'Int8Array',
-    'Uint8ClampedArray',
-    'Int16Array',
-    'Uint16Array',
-    'Int32Array',
-    'Uint32Array',
-    'Float32Array',
-    'Float64Array',
-    'BigInt64Array',
-    'BigUint64Array',
-]);
-
-/**
- * Given a declaration node, walk up the AST parents to find the enclosing
- * class or interface name. More reliable than checker.getTypeAtLocation(decl.parent),
- * which can return odd results for .d.ts files.
- */
-function getEnclosingClassName(decl) {
-    let current = decl.parent;
-    while (current) {
-        if (
-            current.kind === SyntaxKind.ClassDeclaration ||
-            current.kind === SyntaxKind.ClassExpression ||
-            current.kind === SyntaxKind.InterfaceDeclaration
-        ) {
-            if (current.name) {
-                return current.name.text;
-            }
-        }
-
-        current = current.parent;
-    }
-
-    return undefined;
-}
-
-/**
- * Checks whether the resolved toString() on this type is a custom override
- * rather than the default Uint8Array/Object prototype version.
- */
-function hasCustomToString(type, checker) {
-    const toStringSymbol = type.getProperty('toString');
-    if (!toStringSymbol) {
-        return false;
-    }
-
-    const declarations = toStringSymbol.getDeclarations();
-    if (!declarations || declarations.length === 0) {
-        return false;
-    }
-
-    for (const decl of declarations) {
-        const ownerName = getEnclosingClassName(decl);
-        if (ownerName && !DEFAULT_TOSTRING_OWNERS.has(ownerName)) {
-            return true;
-        }
-    }
-
-    const apparentType = checker.getApparentType(type);
-    if (apparentType !== type) {
-        const apparentToString = apparentType.getProperty('toString');
-        if (apparentToString && apparentToString !== toStringSymbol) {
-            const apparentDecls = apparentToString.getDeclarations();
-            if (apparentDecls) {
-                for (const decl of apparentDecls) {
-                    const ownerName = getEnclosingClassName(decl);
-                    if (ownerName && !DEFAULT_TOSTRING_OWNERS.has(ownerName)) {
-                        return true;
-                    }
-                }
-            }
-        }
-    }
-
-    return false;
-}
-
-const createRule = ESLintUtils.RuleCreator(
-    (name) => `https://github.com/dacely-cloud/toiljs/tree/main/presets#${name}`,
-);
-
-const rule = createRule({
-    name: 'no-uint8array-tostring',
-    meta: {
-        type: 'problem',
-        docs: {
-            description:
-                'Disallow .toString() on Uint8Array and branded types (Script, Bytes32, etc.) which produces comma-separated decimals instead of hex',
-        },
-        messages: {
-            noUint8ArrayToString:
-                '{{typeName}}.toString() returns comma-separated decimals (e.g. "0,32,70,107"), not a hex string. ' +
-                'Use Buffer.from(arr).toString("hex") or toHex() instead.',
-        },
-        schema: [],
-    },
-    defaultOptions: [],
-    create(context) {
-        const services = ESLintUtils.getParserServices(context);
-        const checker = services.program.getTypeChecker();
-
-        return {
-            CallExpression(node) {
-                if (
-                    node.callee.type !== AST_NODE_TYPES.MemberExpression ||
-                    node.callee.property.type !== AST_NODE_TYPES.Identifier ||
-                    node.callee.property.name !== 'toString' ||
-                    node.arguments.length > 0
-                ) {
-                    return;
-                }
-
-                const objectNode = node.callee.object;
-                const tsNode = services.esTreeNodeToTSNodeMap.get(objectNode);
-                const type = checker.getTypeAtLocation(tsNode);
-
-                if (!isUint8ArrayType(type, checker)) {
-                    return;
-                }
-
-                if (hasCustomToString(type, checker)) {
-                    return;
-                }
-
-                const typeName = checker.typeToString(type);
-                context.report({
-                    node,
-                    messageId: 'noUint8ArrayToString',
-                    data: { typeName },
-                });
-            },
-        };
-    },
-});
-
-const plugin = {
-    meta: {
-        name: 'eslint-plugin-no-uint8array-tostring',
-        version: '1.0.0',
-    },
-    rules: {
-        'no-uint8array-tostring': rule,
-    },
-};
-
-export default plugin;
-export { rule };
+/**
+ * ESLint rule: disallow `.toString()` on Uint8Array (and branded byte types), which returns
+ * comma-separated decimals instead of hex.
+ */
+import { AST_NODE_TYPES, ESLintUtils } from '@typescript-eslint/utils';
+import { SyntaxKind } from 'typescript';
+
+function isUint8ArrayType(type, checker) {
+    const symbol = type.getSymbol();
+    if (symbol?.getName() === 'Uint8Array') {
+        return true;
+    }
+
+    const baseTypes = type.getBaseTypes?.();
+    if (baseTypes) {
+        for (const baseType of baseTypes) {
+            if (isUint8ArrayType(baseType, checker)) {
+                return true;
+            }
+        }
+    }
+
+    if (type.isIntersection()) {
+        for (const subType of type.types) {
+            if (isUint8ArrayType(subType, checker)) {
+                return true;
+            }
+        }
+    }
+
+    if (type.isUnion()) {
+        return (
+            type.types.length > 0 &&
+            type.types.every((subType) => isUint8ArrayType(subType, checker))
+        );
+    }
+
+    const constraint = type.getConstraint?.();
+    if (constraint && isUint8ArrayType(constraint, checker)) {
+        return true;
+    }
+
+    return false;
+}
+
+/**
+ * Types whose toString() is the dangerous default behavior we want to catch.
+ * If toString is declared on any type NOT in this set, it has been
+ * intentionally overridden and we should leave it alone.
+ */
+const DEFAULT_TOSTRING_OWNERS = new Set([
+    'Object',
+    'Uint8Array',
+    'Int8Array',
+    'Uint8ClampedArray',
+    'Int16Array',
+    'Uint16Array',
+    'Int32Array',
+    'Uint32Array',
+    'Float32Array',
+    'Float64Array',
+    'BigInt64Array',
+    'BigUint64Array',
+]);
+
+/**
+ * Given a declaration node, walk up the AST parents to find the enclosing
+ * class or interface name. More reliable than checker.getTypeAtLocation(decl.parent),
+ * which can return odd results for .d.ts files.
+ */
+function getEnclosingClassName(decl) {
+    let current = decl.parent;
+    while (current) {
+        if (
+            current.kind === SyntaxKind.ClassDeclaration ||
+            current.kind === SyntaxKind.ClassExpression ||
+            current.kind === SyntaxKind.InterfaceDeclaration
+        ) {
+            if (current.name) {
+                return current.name.text;
+            }
+        }
+
+        current = current.parent;
+    }
+
+    return undefined;
+}
+
+/**
+ * Checks whether the resolved toString() on this type is a custom override
+ * rather than the default Uint8Array/Object prototype version.
+ */
+function hasCustomToString(type, checker) {
+    const toStringSymbol = type.getProperty('toString');
+    if (!toStringSymbol) {
+        return false;
+    }
+
+    const declarations = toStringSymbol.getDeclarations();
+    if (!declarations || declarations.length === 0) {
+        return false;
+    }
+
+    for (const decl of declarations) {
+        const ownerName = getEnclosingClassName(decl);
+        if (ownerName && !DEFAULT_TOSTRING_OWNERS.has(ownerName)) {
+            return true;
+        }
+    }
+
+    const apparentType = checker.getApparentType(type);
+    if (apparentType !== type) {
+        const apparentToString = apparentType.getProperty('toString');
+        if (apparentToString && apparentToString !== toStringSymbol) {
+            const apparentDecls = apparentToString.getDeclarations();
+            if (apparentDecls) {
+                for (const decl of apparentDecls) {
+                    const ownerName = getEnclosingClassName(decl);
+                    if (ownerName && !DEFAULT_TOSTRING_OWNERS.has(ownerName)) {
+                        return true;
+                    }
+                }
+            }
+        }
+    }
+
+    return false;
+}
+
+const createRule = ESLintUtils.RuleCreator(
+    (name) => `https://github.com/dacely-cloud/toiljs/tree/main/presets#${name}`,
+);
+
+const rule = createRule({
+    name: 'no-uint8array-tostring',
+    meta: {
+        type: 'problem',
+        docs: {
+            description:
+                'Disallow .toString() on Uint8Array and branded types (Script, Bytes32, etc.) which produces comma-separated decimals instead of hex',
+        },
+        messages: {
+            noUint8ArrayToString:
+                '{{typeName}}.toString() returns comma-separated decimals (e.g. "0,32,70,107"), not a hex string. ' +
+                'Use Buffer.from(arr).toString("hex") or toHex() instead.',
+        },
+        schema: [],
+    },
+    defaultOptions: [],
+    create(context) {
+        const services = ESLintUtils.getParserServices(context);
+        const checker = services.program.getTypeChecker();
+
+        return {
+            CallExpression(node) {
+                if (
+                    node.callee.type !== AST_NODE_TYPES.MemberExpression ||
+                    node.callee.property.type !== AST_NODE_TYPES.Identifier ||
+                    node.callee.property.name !== 'toString' ||
+                    node.arguments.length > 0
+                ) {
+                    return;
+                }
+
+                const objectNode = node.callee.object;
+                const tsNode = services.esTreeNodeToTSNodeMap.get(objectNode);
+                const type = checker.getTypeAtLocation(tsNode);
+
+                if (!isUint8ArrayType(type, checker)) {
+                    return;
+                }
+
+                if (hasCustomToString(type, checker)) {
+                    return;
+                }
+
+                const typeName = checker.typeToString(type);
+                context.report({
+                    node,
+                    messageId: 'noUint8ArrayToString',
+                    data: { typeName },
+                });
+            },
+        };
+    },
+});
+
+const plugin = {
+    meta: {
+        name: 'eslint-plugin-no-uint8array-tostring',
+        version: '1.0.0',
+    },
+    rules: {
+        'no-uint8array-tostring': rule,
+    },
+};
+
+export default plugin;
+export { rule };

package/presets/prettier.json

@@ -1,18 +1,18 @@
-{
-    "printWidth": 120,
-    "tabWidth": 4,
-    "useTabs": false,
-    "semi": true,
-    "singleQuote": true,
-    "trailingComma": "none",
-    "bracketSpacing": true,
-    "bracketSameLine": true,
-    "arrowParens": "always",
-    "htmlWhitespaceSensitivity": "css",
-    "overrides": [
-        {
-            "files": "*.html",
-            "options": { "parser": "html" }
-        }
-    ]
-}
+{
+    "printWidth": 120,
+    "tabWidth": 4,
+    "useTabs": false,
+    "semi": true,
+    "singleQuote": true,
+    "trailingComma": "none",
+    "bracketSpacing": true,
+    "bracketSameLine": true,
+    "arrowParens": "always",
+    "htmlWhitespaceSensitivity": "css",
+    "overrides": [
+        {
+            "files": "*.html",
+            "options": { "parser": "html" }
+        }
+    ]
+}