Counterscale Documentation

If you need more granular control over your ESLint setup, you can import and compose individual configuration functions instead of using the monolithic createConfig. This allows you to layer specific configurations (Base, React, or TypeScript) and add your own custom rules.

Available configuration functions:

• createBaseConfig: Provides the foundational configuration.
• createReactConfig: Adds React-specific rules and settings.
• createTypeScriptConfig: Adds TypeScript-specific rules and settings.

Note: When using these functions, you can pass specific options like baseDirectory, tsconfigRootDir, and project to each one individually.

import {
    createBaseConfig,
    createTypeScriptConfig,
    createReactConfig,
} from "@counterscale/eslint-config";
import path from "node:path";
import { fileURLToPath } from "node:url";

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

export default [
    ...createBaseConfig({
        baseDirectory: __dirname,
        ignores: ["build/*", "node_modules", "dist/*"],
        additionalGlobals: { counterscale: true },
    }),
    ...createReactConfig({ baseDirectory: __dirname }),
    ...createTypeScriptConfig({
        baseDirectory: __dirname,
        tsconfigRootDir: "./",
        project: "./tsconfig.json",
    }),
    // Add any package-specific rules
    {
        files: ["**/*.{ts,tsx}"],
        rules: {
            // Your custom rules here
        },
    },
];

To use the standard Counterscale ESLint configuration, create an eslint.config.mjs file in your package and use the createConfig function. This function accepts an options object to configure the environment, including directory paths, ignores, and support for React or TypeScript.

Key configuration options:

• baseDirectory: The directory to use as the base for configuration.
• ignores: An array of patterns to ignore (e.g., build/*, node_modules).
• includeReact: Set to true to enable React-specific configurations.
• includeTypeScript: Set to true to enable TypeScript-specific configurations.
• tsconfigRootDir: The root directory for TypeScript configuration.
• project: The path to your tsconfig.json.
• additionalGlobals: An object defining package-specific global variables.

import { createConfig } from "@counterscale/eslint-config";
import path from "node:path";
import { fileURLToPath } from "node:url";

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);

export default createConfig({
    baseDirectory: __dirname,
    ignores: [
        "build/*",
        "node_modules",
        "dist/*",
        // Add any package-specific ignores
    ],
    // Configure based on package type
    includeReact: true, // Set to true for React packages
    includeTypeScript: true, // Set to true for TypeScript packages
    tsconfigRootDir: "./",
    project: "./tsconfig.json", // Path to your tsconfig.json
    additionalGlobals: {
        // Add any package-specific globals
        counterscale: true,
    },
});

To deploy Counterscale to Cloudflare, follow these steps:

1. Requirements Check:
   • macOS or Linux environment
   • Node v20 or above
   • An active Cloudflare account
2. Cloudflare Preparation:
   • Set up a Cloudflare Workers subdomain.
   • Enable Cloudflare Analytics Engine beta in your dashboard (Storage & Databases > Analytics Engine).
   • Create a Cloudflare API token with at least Account.Account Analytics permissions.
3. Deployment:
   • Log in to Cloudflare via Wrangler:

     npx wrangler login

   • Run the installer:

     npx @counterscale/cli@latest install

   • Follow the prompts to provide your API token and choose whether to protect your dashboard with a password.

Once finished, your server will be available at https://{subdomain}.workers.dev.