flaglint 0.0.1 → 0.1.1

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-05-18
+
+### Added
+
+- `flaglint scan` command — scans codebase for LaunchDarkly SDK usage and reports flag inventory
+- `flaglint migrate` command — analyzes migration readiness and generates an OpenFeature migration plan
+- Detects `variation()`, `variationDetail()`, `allFlags()`, React hooks (`useFlags`, `useLDClient`), HOC (`withLDConsumer`), and Provider (`LDProvider`) patterns
+- Markdown, JSON, and HTML report formats
+- HTML reports include filterable flag table and light/dark mode support
+- Stale flag detection heuristics based on key names (`old`, `deprecated`, `legacy`, `temp`, `tmp`, `test`, `demo`) and file paths
+- Dynamic flag key identification — flags whose keys are determined at runtime
+- Migration readiness score (0–100) with per-pattern deductions
+- Automatic OpenFeature equivalent mapping for all detected call types
+- `.flaglintrc` config file support with Zod validation and clear error messages
+- `--dry-run` flag for `migrate` command
+- Exit code `1` when stale flags found (enables CI blocking)
+- GitHub Actions CI integration across Node.js 18, 20, and 22
+- Test suite with 57 tests and ≥75% coverage across scanner, reporter, and config modules

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 FlagLint Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,15 +1,149 @@
 # FlagLint
 
-Feature flag debt scanner and OpenFeature migration assistant.
+**Find stale feature flags. Detect flag debt. Plan your OpenFeature migration.**
 
-FlagLint helps engineering teams find stale feature flags, detect flag debt, and prepare OpenFeature migrations.
+[![CI](https://https://github.com/flaglint/flagkit-cli/actions/workflows/ci.yml/badge.svg)](https://https://github.com/flaglint/flagkit-cli/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/flaglint.svg)](https://www.npmjs.com/package/flaglint)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-## Usage
+---
+
+## The problem
+
+LaunchDarkly flags accumulate. Teams add them, forget to clean them up, and gradually build flag debt — dead code paths controlled by flags nobody manages. When you finally want to migrate to OpenFeature, you don't even know what you have.
+
+**FlagLint fixes this.** It scans your codebase, maps every flag usage, identifies stale candidates, and generates a step-by-step OpenFeature migration plan.
+
+---
+
+## Quick start
 
 ```bash
 npx flaglint scan
 ```
 
-## Status
+---
+
+## Installation
+
+```bash
+npm install -g flaglint
+# or use without installing
+npx flaglint
+```
+
+---
+
+## Commands
+
+### `flaglint scan [dir]`
+
+Scans a directory for LaunchDarkly SDK usage.
+
+```bash
+flaglint scan ./src
+flaglint scan --format json --output report.json
+flaglint scan --format html --output report.html
+```
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--format` | `markdown` | Output format: `json`, `markdown`, `html` |
+| `--output` | stdout | Write report to file |
+| `--config` | auto-detect | Path to `.flaglintrc` |
+
+Exit code `0` when no stale flags found, `1` when stale flags exist — enabling CI blocking.
+
+---
+
+### `flaglint migrate [dir]`
+
+Analyzes migration readiness and generates an OpenFeature migration plan.
+
+```bash
+flaglint migrate ./src
+flaglint migrate --dry-run
+flaglint migrate --output MIGRATION.md
+```
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `--output` | `MIGRATION.md` | Write migration plan to file |
+| `--dry-run` | — | Print plan to stdout, do not write file |
+| `--config` | auto-detect | Path to `.flaglintrc` |
+
+---
+
+## Configuration
+
+Create `.flaglintrc` in your project root:
+
+```json
+{
+  "include": ["**/*.{ts,tsx,js,jsx}"],
+  "exclude": ["**/node_modules/**", "**/dist/**"],
+  "provider": "launchdarkly",
+  "staleThreshold": 1,
+  "reportTitle": "My Project Flag Report"
+}
+```
+
+| Field | Type | Default | Description |
+|-------|------|---------|-------------|
+| `include` | `string[]` | `["**/*.{ts,tsx,js,jsx}"]` | Glob patterns to scan |
+| `exclude` | `string[]` | `["**/node_modules/**", ...]` | Glob patterns to ignore |
+| `provider` | `string` | `"launchdarkly"` | Feature flag provider |
+| `staleThreshold` | `number` | `1` | Days before a flag is considered stale |
+| `reportTitle` | `string` | — | Custom title for generated reports |
+| `outputDir` | `string` | `"."` | Default output directory |
+
+FlagLint searches for config in this order: `--config` flag → `.flaglintrc` → `.flaglintrc.json` → `flaglint.config.json`.
+
+---
+
+## CI Integration
+
+```yaml
+- name: Check for stale flags
+  run: npx flaglint scan --format json --output flaglint-report.json
+  # exits 1 if stale flags found, blocking the PR
+```
+
+---
+
+## What FlagLint detects
+
+- `ldClient.variation()` and `ldClient.variationDetail()`
+- `ldClient.allFlags()`
+- `useFlags()`, `useLDClient()` React hooks
+- `<LDProvider>` and `withLDConsumer()` patterns
+- Dynamic flag keys (runtime-determined, flagged for manual review)
+
+All detections include the **file path**, **line number**, **call type**, and a **stale heuristic** based on key names and file locations.
+
+---
+
+## OpenFeature Migration
+
+[OpenFeature](https://openfeature.dev) is the vendor-neutral standard for feature flagging (CNCF project). `flaglint migrate` maps your LaunchDarkly SDK calls to OpenFeature equivalents and generates an actionable `MIGRATION.md`:
+
+| LaunchDarkly | OpenFeature |
+|---|---|
+| `ldClient.variation(key, ctx, false)` | `client.getBooleanValue(key, false, ctx)` |
+| `ldClient.variationDetail(key, ctx, def)` | `client.getBooleanDetails(key, def, ctx)` |
+| `useFlags()` | `useFlag(key)` per flag |
+| `useLDClient()` | `useOpenFeatureClient()` |
+| `<LDProvider>` | `<OpenFeatureProvider provider={...}>` |
+| `withLDConsumer()(Component)` | `withOpenFeature()(Component)` |
+
+---
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md).
+
+---
+
+## License
 
-Early placeholder release. Full CLI coming soon.
+MIT — see [LICENSE](./LICENSE).

package/dist/bin/flaglint.d.ts

@@ -0,0 +1,2 @@
+
+export {  }