CONFIG_EXAMPLES.md

Examples

Glob matching

All globs are matched only against files, folder severities are computed based on the files inside them. The formula is simple: the folder severity is the highest severity of files inside it (from highest to lowest: error, warn, off).

Glob examples:

• ./src/shared/** - matches all files in the shared folder and its subfolders
• ./src/shared/* - matches all files that are direct children of the shared folder
• ./src/shared - based on the fact that globs are matched against files, this one matches only shared file (without an extension) inside the src folder
• **/__mocks__/** - matches all files in all __mocks__ folders throughout the project
• **/*.{test,spec}.{ts,tsx} - matches all test files in the project

Example 1. Default case

// ./steiger.config.ts
import fsd from '@feature-sliced/steiger-plugin'
import { defineConfig } from 'steiger'

export default defineConfig([...fsd.configs.recommended])

Example 2. FSD with all rules enabled by default, but excluding a couple of folders

import fsd from '@feature-sliced/steiger-plugin'
import { defineConfig } from 'steiger'

export default defineConfig([
  ...fsd.configs.recommended,
  {
    ignores: ['**/__mocks__/**'],
  },
])

Example 3. FSD without certain rules

import fsd from '@feature-sliced/steiger-plugin'
import { defineConfig } from 'steiger'

export default defineConfig([
  ...fsd.configs.recommended,
  {
    rules: {
      'fsd/no-processes': 'off',
      'fsd/no-public-api-sidestep': 'warn',
    },
  },
  {
    files: ['./src/shared/**'],
    rules: {
      'fsd/public-api': 'off',
    },
  },
])

Example 4. Disabling a rule for a specific folder

import fsd from '@feature-sliced/steiger-plugin'
import { defineConfig } from 'steiger'

export default defineConfig([
  ...fsd.configs.recommended,
  {
    files: ['./src/shared/**'],
    rules: {
      'fsd/no-public-api': 'off',
    },
  },
])

Example 5. Using ignores along with files

import fsd from '@feature-sliced/steiger-plugin'
import { defineConfig } from 'steiger'

export default defineConfig([
  ...fsd.configs.recommended,
  {
    files: ['./src/shared/**'],
    ignores: ['./src/shared/lib/**', './src/shared/ui/**'],
    rules: {
      'fsd/no-public-api': 'off', // Disable the rule for the shared folder, but not for the lib and ui folders
    },
  },
])

Example 6. Setting rule options

import fsd from '@feature-sliced/steiger-plugin'
import { defineConfig } from 'steiger'

export default defineConfig([
  ...fsd.configs.recommended,
  {
    rules: {
      'fsd/no-public-api': ['warn', { someOptions: true }],
    },
  },
  {
    files: ['./src/shared/**'],
    rules: {
      'fsd/no-public-api': 'error',
      // 'fsd/no-public-api': ['error', { someOptions: false }], // Would throw an error as you can't override the options
    },
  },
])