This package provides shared configuration for ESLint, Prettier, Vitest, Stylelint, and TypeScript used across the Solana Microsite Framework project. It aims to enforce consistent code style and quality standards throughout all microsites.

• ESLint Configuration

  • Base JavaScript/TypeScript rules
  • React-specific rules and hooks best practices
  • Testing library guidelines
  • Import sorting and organization

• Prettier Configuration

  • Consistent code formatting
  • Import sorting with @ianvs/prettier-plugin-sort-imports
  • Customizable presets

• TypeScript Configuration

  • Strict type checking
  • Path aliases support
  • Modern ECMAScript features

• Stylelint Configuration

  • SCSS support
  • Modern CSS features
  • Consistent styling rules

• Vitest Configuration

  • Unit testing setup
  • Coverage reporting
  • Testing utilities

• PostCSS Configuration

  • Modern CSS processing
  • Module support
  • Integration with Tailwind CSS v4

First, configure your project to use the GitHub registry:

# .npmrc
@solana-foundation:registry=https://npm.pkg.github.com

Then install the package:

pnpm add -D @solana-foundation/ms-tools-config

// eslint.config.js
import baseConfig from '@solana-foundation/ms-tools-config/eslint.config.base.js'

export default [
  ...baseConfig,
  {
    // Your project-specific overrides
  },
]

// prettier.config.js
import baseConfig from '@solana-foundation/ms-tools-config/prettier.config.js'

export default {
  ...baseConfig,
  // Your project-specific overrides
}

// tsconfig.json
{
  "extends": "@solana-foundation/ms-tools-config/tsconfig.json",
  "compilerOptions": {
    "baseUrl": "./src"
  },
  "include": ["src/**/*"]
}

// stylelint.config.js
import baseConfig from '@solana-foundation/ms-tools-config/stylelint.config.js'

export default {
  extends: [baseConfig],
  // Your project-specific rules
}

// vitest.config.ts
import baseConfig from '@solana-foundation/ms-tools-config/vitest.config.js'

export default {
  ...baseConfig,
  // Your project-specific test configuration
}

// postcss.config.js
import baseConfig from '@solana-foundation/ms-tools-config/postcss.config.js'

export default {
  ...baseConfig,
  // Your project-specific PostCSS configuration
}

# Install dependencies
pnpm install

# Run tests
pnpm test

# Build package
pnpm build

For detailed configuration options and best practices, refer to:

• ESLint Documentation
• Prettier Documentation
• TypeScript Documentation
• Stylelint Documentation
• Vitest Documentation

Please refer to the main repository's contributing guidelines.