Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

@dfinity/eslint-config-oisy-wallet

Package Overview
Dependencies
Maintainers
11
Versions
36
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@dfinity/eslint-config-oisy-wallet

Shared ESLint configurations from the Oisy Wallet team

latest
Source
npmnpm
Version
0.2.2
Version published
Weekly downloads
2.4K
-24.69%
Maintainers
11
Weekly downloads
 
Created
Source

🌟 @dfinity/eslint-config-oisy-wallet

A shareable ESLint configuration library for Oisy Wallet projects, supporting both TypeScript and Svelte.


Internet Computer portal GitHub CI Checks Workflow Status

[!NOTE] This configuration is currently compatible with ESLint 8.

🖥️ Installation

# with npm
npm install --save-dev @dfinity/eslint-config-oisy-wallet
# with pnpm
pnpm add --save-dev @dfinity/eslint-config-oisy-wallet
# with yarn
yarn add -D @dfinity/eslint-config-oisy-wallet

✍️ Usage

For General Projects (Non-Svelte):

  • Create an ESLint configuration file .eslintrc.js in your project root and extend the base configuration:
module.exports = {
  extends: ["@dfinity/eslint-config-oisy-wallet"],
};

For Svelte Projects:

  • Create an .eslintrc.js file in your project root and extend the Svelte-specific configuration:
module.exports = {
  extends: ["@dfinity/eslint-config-oisy-wallet/svelte"],
};

For vitest test suites:

  • Create an .eslintrc.js file in your project root and extend the vitest-specific configuration:
module.exports = {
  extends: ["@dfinity/eslint-config-oisy-wallet/vitest"],
};
  • If the rules must apply ONLY to test files, they can be configured as:
module.exports = {
  overrides: [
    {
      // Specify the test files and/or folders
      files: [
        "**/*.test.{ts,js}",
        "**/*.spec.{ts,js}",
        "**/tests/**/*.{ts,js}",
      ],

      extends: ["@dfinity/eslint-config-oisy-wallet/vitest"],
    },
  ],
};

Finally, create an eslint-local-rules.cjs file at the root of your project containing the following:

module.exports = require("@dfinity/eslint-config-oisy-wallet/eslint-local-rules");

[!NOTE] This is necessary because the eslint-plugin-local-rules plugin we use for custom rules requires a file located at the root and does not offer any customizable location option.

🔧 Overriding, Enabling, or Disabling Rules

You can override, enable, or disable any of the rules provided by this configuration — including custom local rules — just like you would with any ESLint config.

In your .eslintrc.js, simply add a rules section:

module.exports = {
  extends: ["@dfinity/eslint-config-oisy-wallet/svelte"],
  rules: {
    // Disable a built-in rule
    "no-console": "off",

    // Disable a local custom rule
    "local/use-nullish-checks": "off",

    // Enable a built-in rule
    "local-rules/prefer-object-params": "warn",

    // Customize severity or options
    "@typescript-eslint/no-unused-vars": ["warn", { argsIgnorePattern: "^_" }],
  },
};

Or in eslint.config.ts, adding an object with the rules property:

import { default as svelteConfig } from "@dfinity/eslint-config-oisy-wallet/svelte";
import { default as vitestConfig } from "@dfinity/eslint-config-oisy-wallet/vitest";

export default [
  ...vitestConfig,
  ...svelteConfig,
  {
    rules: {
      // Disable a built-in rule
      "no-console": "off",
      "vitest/expect-expect": "off",

      // Disable a local custom rule
      "local/use-nullish-checks": "off",

      // Enable a built-in rule
      "local-rules/prefer-object-params": "warn",

      // Customize severity or options
      "@typescript-eslint/no-unused-vars": [
        "warn",
        { argsIgnorePattern: "^_" },
      ],
    },
  },
];

Note: To override local rules, make sure you have the eslint-local-rules.cjs file at the root as described above.

🛠️ TypeScript Support

If your project uses TypeScript, make sure you have a tsconfig.json file in your project root.

Here's an example tsconfig.json:

{
  "compilerOptions": {
    "strict": true,
    "target": "ESNext",
    "module": "ESNext",
    "moduleResolution": "node",
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": ["src/**/*.ts", "*.svelte"],
  "exclude": ["node_modules", "dist"]
}

🔍 Linting Your Project

To lint your project, add the following script to your package.json:

{
  "scripts": {
    "lint": "eslint --max-warnings 0 \"src/**/*\""
  }
}

Then, run the linting command:

npm run lint

Keywords

eslint

FAQs

Package last updated on 31 Jul 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts