Using Source Code Integrations for Mobile Frameworks
Monitor your mobile framework source code files and get live feedback
With Stark's source code integrations for mobile frameworks, you get a CLI tool to scan your React-Native or Flutter codebase, automatic syncing to your Stark dashboard, and integration with your existing ESLint setup for IDE support.
Getting Started with React Native
Begin by installing the package:
npm install --save-dev @stark-lab-inc/stark-accessibility-react-native
Using CLI Tool (Recommended)
The easiest way to get started is with our CLI tool that scans your React Native code for accessibility issues and automatically uploads results to your Stark dashboard. A Stark token is required for all scans.
- Log in to your Stark account at app.getstark.co
- Navigate to your project settings
- Find your project's Stark Token (it looks like stark_1452216e48434f07bd0cf4f6f6502e56)
- Copy this token - you'll need it for running the tool
- Configure your token (see configuration options below)
- Run accessibility checks
Your Stark token can be configured using any of these methods:
Option 1: Environment Variable (Recommended for CI/CD)
export STARK_TOKEN="your-stark-token"
npx stark-scan-react-native src/
Option 2: .env File (Recommended for Development)
# Create .env file in your project root
echo "STARK_TOKEN=your-stark-token" > .env
npx stark-scan-react-native src/
Option 3: Command Line Argument
npx stark-scan-react-native src/ --stark-token your-stark-token
The CLI will automatically detect and use your token from any of these sources.
Once your token is configured, you can use these commands:
# Basic usage
npx stark-scan-react-native src/
# Use iOS-specific rules
npx stark-scan-react-native src/ --config ios
# Use Android-specific rules
npx stark-scan-react-native src/ --config android
# Use basic rules only
npx stark-scan-react-native src/ --config basic
# With custom scan name
npx stark-scan-react-native src/ --name "Production Build"
# Silent mode (perfect for CI/CD)
npx stark-scan-react-native src/ --silent
# Merge with local ESLint configuration
npx stark-scan-react-native src/ --merge-config
# Help
npx stark-scan-react-native --help
--stark-token <token>- Your Stark token (REQUIRED - can also be set via environment variable or .env file)--config <preset>- Configuration preset to use:basic,ios,android, orall(default:all)--name <name>- Custom scan name (defaults to current directory name)--silent- Suppress console output except errors--merge-config- Enable config merging (search for and merge with local ESLint configurations)--help- Show help message
The CLI offers four configuration presets to match your project needs:
basic- Core accessibility rules that apply to all React Native projectsios- Basic rules + iOS-specific accessibility rules (e.g.,accessibilityIgnoresInvertColors)android- Basic rules + Android-specific accessibility rules (e.g.,importantForAccessibility,accessibilityLiveRegion)all- All rules combined (iOS + Android + Basic) - Default
Configuration Merging
By default, the CLI ships with an embedded configuration that works out of the box. However, you can use the --merge-config flag to integrate your existing ESLint configuration:
- Without
--merge-config: Uses the embedded configuration - With
--merge-config: Searches for and merges local ESLint configs (eslint.config.js) with the embedded configuration
This is useful for projects that have specific requirements or custom ESLint configuration options (like specialized parser settings, environment configurations, or particular project needs).
If you prefer to integrate accessibility checking directly into your existing ESLint setup (for IDE support, custom workflows, etc.), you can use our ESLint plugin:
The plugin provides four configuration presets:
starkAccessibilityReactNative.configs.basic- Core accessibility rules for all React Native projectsstarkAccessibilityReactNative.configs.ios- Basic rules + iOS-specific rulesstarkAccessibilityReactNative.configs.android- Basic rules + Android-specific rulesstarkAccessibilityReactNative.configs.all- All rules combined (recommended for cross-platform projects)
Add Stark to your existing ESLint configuration:
// eslint.config.js
import starkAccessibilityReactNative from '@stark-lab-inc/stark-accessibility-react-native';
export default [
starkAccessibilityReactNative.configs.all, // or .basic, .ios, .android
{
files: ['**/*.{js,jsx}'],
},
];
For TypeScript projects:
// eslint.config.js
import tseslint from 'typescript-eslint';
import starkAccessibilityReactNative from '@stark-lab-inc/stark-accessibility-react-native';
export default tseslint.config([
{
files: ['**/*.{ts,tsx}'],
extends: [
starkAccessibilityReactNative.configs.all // or .basic, .ios, .android
],
},
]);
Getting Started with Flutter
Download the Stark package to get linting right in your IDE.
- Add to your
pubspec.yaml:
dev_dependencies: custom_lint: ^0.8.1 stark_accessibility_lint: ^1.0.0 - Create or update
analysis_options.yaml:
analyzer: plugins: - custom_lint - In your IDE (VS Code, Android Studio, IntelliJ), the linter will automatically run and show issues inline.
Using CLI Reporter
Upload accessibility scan results to your Stark dashboard.
Usage
# From your Flutter project directory
dart run stark_accessibility_lint:reporter --stark-token YOUR_TOKEN
# With custom scan name
dart run stark_accessibility_lint:reporter --stark-token YOUR_TOKEN --name "My Flutter App"
Options
--stark-token(required) - Your Stark API token for authentication--name(optional) - Custom name for the scan (defaults to current directory name)